Skip to main content
POST
Add Message

Authorizations

X-API-Key
string
header
required

Path Parameters

conversation_id
string<uuid>
required

Query Parameters

assistant_id
string<uuid> | null
message_id
string | null

Body

application/json
content
string | null
required
tool
Available options:
web_research,
kb_qa
kb_id
string | null
files
ConversationFile · object[] | null
model_selection
string[] | null

Response

Successful Response

ConversationWithMessages for the public SDK — strips TipTap from settings.

id
string<uuid>
required
user_id
string<uuid> | null
required
api_key_id
string<uuid> | null
required
name
string | null
required
created_at
string<date-time>
required
last_updated_at
string<date-time>
required
etag
string | null
required
settings
CoWorkerSettings · object
required
status
enum<string>
required
Available options:
queued,
running,
failed,
completed,
stopped,
awaiting_human_feedback
messages
Message · object[]
required
assistant_id
string<uuid> | null
manual
boolean
default:false
preview
boolean
default:false
assistant_version_id
string<uuid> | null
chat_transport
string | null
channel_ref
Channel Ref · object | null
deployment_id
string<uuid> | null
public_access_token
string | null
todos
Todos · object[]
is_locked
boolean
default:false
lock_message
string | null
vercel_messages
UIMessage · object[]