Chats

Get Chat

Beta

Path parameters

idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

idstring
This is the unique identifier for the chat.
orgIdstring
This is the unique identifier for the org that this chat belongs to.
createdAtstringformat: "date-time"

This is the ISO 8601 date-time string of when the chat was created.

updatedAtstringformat: "date-time"

This is the ISO 8601 date-time string of when the chat was last updated.

assistantIdstring or null

This is the assistant that will be used for the chat. To use an existing assistant, use assistantId instead.

assistantobject or null

This is the assistant that will be used for the chat. To use an existing assistant, use assistantId instead.

assistantOverridesobject or null

These are the variable values that will be used to replace template variables in the assistant messages. Only variable substitution is supported in chat contexts - other assistant properties cannot be overridden.

namestring or null<=40 characters
This is the name of the chat. This is just for your own reference.
sessionIdstring or null
This is the ID of the session that will be used for the chat. Mutually exclusive with previousChatId.
inputstring or list of objects or null
This is the input text for the chat. Can be a string or an array of chat messages.
streamboolean or nullDefaults to false
This is a flag that determines whether the response should be streamed. When true, the response will be sent as chunks of text.
previousChatIdstring or null
This is the ID of the chat that will be used as context for the new chat. The messages from the previous chat will be used as context. Mutually exclusive with sessionId.
messageslist of objects or null

This is an array of messages used as context for the chat. Used to provide message history for multi-turn conversations.

outputlist of objects or null
This is the output messages generated by the system in response to the input.
costslist of objects or null
These are the costs of individual components of the chat in USD.
costdouble or null
This is the cost of the chat in USD.