Delete 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.

createdAtdatetime

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

updatedAtdatetime

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

assistantIdstringOptional

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

assistantobjectOptional

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

namestringOptional<=40 characters

This is the name of the chat. This is just for your own reference.

sessionIdstringOptional

This is the ID of the session that will be used for the chat. Mutually exclusive with previousChatId.

inputstring or list of objectsOptional

This is the input text for the chat. Can be a string or an array of chat messages.

streambooleanOptionalDefaults 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.

previousChatIdstringOptional

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 objectsOptional

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

outputlist of objectsOptional

This is the output messages generated by the system in response to the input.