Skip to main content
POST
Start chat
Required scopes: or

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
chat
object

Initial chat configuration.

active
boolean
default:true

If false: creates an inactive thread.

continuous
boolean
default:false

If true: starts chat as continuous (online group not required).

Response

200 - application/json

Chat started.

chat_id
string

The ID of the created chat.

thread_id
string

The ID of the created thread.

event_ids
string[]

IDs of user-generated events. Returned only when the chat was started with initial events. Server-side generated events are excluded.