Skip to main content
POST
/
chat
/
threads
Error
A valid request URL is required to generate request examples
{
  "thread": {},
  "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_message": {},
  "dispatched": "<array>",
  "skipped": "<array>",
  "failed": "<array>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
message
string
required
​
agent_id
string<uuid>

Single agent UUID (creates direct thread)

​
agent_ids
string<uuid>[]

Multiple agent UUIDs (creates group thread)

Maximum array length: 8
​
title
string | null
​
lead_agent_id
string<uuid> | null

Designate a lead agent for collaborative group threads. Must be one of the agent_ids. When set, only the lead agent receives dispatch with collaborator context. Other agents serve as queryable collaborators.

​
idempotency_key
string | null

Response

Thread created and message dispatched

​
thread
object
​
message_id
string<uuid>

Placeholder ID (direct thread)

​
user_message
object

User message info (group thread)

​
dispatched
array

Agents dispatched (group thread)

​
skipped
array

Agents skipped (group thread)

​
failed
array

Agents failed (group thread)