Chats

Create Chat

Beta

Creates a new chat. Requires at least one of: assistantId/assistant, sessionId, or previousChatId. Note: sessionId and previousChatId are mutually exclusive.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
inputstring or list of objectsRequired

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

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.

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.

Response

Chat response - either non-streaming chat or streaming

object
OR
object