Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01979563.0 MB
Chats

Create Chat

Creates a new chat with optional SMS delivery via transport field. Requires at least one of: assistantId/assistant, sessionId, or previousChatId. Note: sessionId and previousChatId are mutually exclusive. Transport field enables SMS delivery with two modes: (1) New conversation - provide transport.phoneNumberId and transport.customer to create a new session, (2) Existing conversation - provide sessionId to use existing session data. Cannot specify both sessionId and transport fields together. The transport.useLLMGeneratedMessageForOutbound flag controls whether input is processed by LLM (true, default) or forwarded directly as SMS (false).

post/chat

Request body

assistantIdstring

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

squadIdstring

This is the squad that will be used for the chat. To use a transient squad, use squad instead.

namestring

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

sessionIdstring

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

streamboolean

This is a flag that determines whether the response should be streamed. When true, the response will be sent as chunks of text.

previousChatIdstring

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

OR