Skip to main content
POST
Create a conversation thread

Authorizations

Authorization
string
header
required

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

Body

name
string
Maximum string length: 255
agent_id
integer

ID of the agent to use. If not provided, uses the default agent for the company.

chat_setting_id
integer

DEPRECATED: Use 'agent_id' instead. ID of the chat setting to use. If not provided, uses the default agent for the company.

is_ephemeral
boolean
default:false
tool_parameters
any

Global tool-specific parameters for all turns in this thread (e.g., document_search.top_k). Can be overridden at turn level.

Response

201 - application/json
id
string<uuid>
required
name
string
required
read-only
status
string
required
read-only
ml_model
string | null
required
read-only
ml_model_name
string | null
required
read-only
agent_id
integer
required
agent_name
string | null
required
read-only
creation_source
string
required
read-only
is_read
boolean
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
is_ephemeral
boolean
required
read-only
is_archived
boolean
required
tool_parameters
any | null
required
read-only

Global tool-specific parameters applied to all turns in this thread (e.g., document_search.top_k). Can be overridden at turn level.

object
string
default:thread