Update Session
Authentication
AuthorizationBearer
Retrieve your API Key from Dashboard.
Path parameters
id
Request
This endpoint expects an object.
name
This is the new name for the session. Maximum length is 40 characters.
status
This is the new status for the session.
Allowed values:
expirationSeconds
Session expiration time in seconds. Defaults to 24 hours (86400 seconds) if not set.
messages
This is the updated array of chat messages.
Response
id
This is the unique identifier for the session.
orgId
This is the unique identifier for the organization that owns this session.
createdAt
This is the ISO 8601 timestamp indicating when the session was created.
updatedAt
This is the ISO 8601 timestamp indicating when the session was last updated.
cost
This is the cost of the session in USD.
costs
These are the costs of individual components of the session in USD.
name
This is a user-defined name for the session. Maximum length is 40 characters.
status
This is the current status of the session. Can be either 'active' or 'completed'.
Allowed values:
expirationSeconds
Session expiration time in seconds. Defaults to 24 hours (86400 seconds) if not set.
assistantId
This is the ID of the assistant associated with this session. Use this when referencing an existing assistant.
assistant
This is the assistant configuration for this session. Use this when creating a new assistant configuration.
If assistantId is provided, this will be ignored.
assistantOverrides
These are the overrides for the assistant configuration. Use this to provide variable values and other overrides when using assistantId. Variable substitution will be applied to the assistant’s messages and other text-based fields.
squadId
This is the squad ID associated with this session. Use this when referencing an existing squad.
squad
This is the squad configuration for this session. Use this when creating a new squad configuration.
If squadId is provided, this will be ignored.
messages
This is an array of chat messages in the session.
customer
This is the customer information associated with this session.
customerId
This is the customerId of the customer associated with this session.
phoneNumberId
This is the ID of the phone number associated with this session.
phoneNumber
This is the phone number configuration for this session.
artifact
These are the artifacts that were extracted from the session messages.
They are only available after the session has completed.
The artifact plan from the assistant or active assistant of squad is used to generate the artifact.
Currently the only supported fields of assistant artifact plan are:
- structuredOutputIds
