POST
Create Chat Message

Authorizations

Authorization
string
header
required

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

Path Parameters

chat_id
string<uuid>
required

Body

application/json

One message: what was typed, what was attached, or both.

client_message_id
string<uuid>
required
files
InboundFile · object[]

Any type; photos, PDFs and Word files are read by the agent.

Maximum array length: 4
message
string
default:""
Maximum string length: 100000
stream
boolean
default:false

Response

The turn. With stream: true, a text/event-stream of assistant.* and item.created frames ending in one turn.result.

What one message led to: the agent's reply, and where the chat stands.

chat_status
enum<string>
required
Available options:
open,
ended
error
string | null
required
input
ConversationItemResponse · object
required
items
ConversationItemResponse · object[]
required
status
enum<string>
required
Available options:
running,
done,
error,
canceled
superseded_by_item_id
string<uuid> | null
required