Skip to main content
POST
Ask the AI Assistant, streaming its work

Authorizations

Authorization
string
header
required

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

Path Parameters

conversation_id
string<uuid>
required

Body

application/json

Send the AI Assistant a message.

prompt
string
required
Required string length: 1 - 4000
attachment_ids
string<uuid>[]

The files sent with this message, as the attachments route returned them when they were uploaded: CSV, Excel or PDF, each of them yours and not yet sent with another message. The assistant reads a spreadsheet's columns and rows and a PDF's pages. Optional.

Maximum array length: 10
page
PageContextSchema · object | null

What you have open, so the assistant can resolve 'this table' without you naming it. Optional.

pasted
string[] | null

A list you pasted rather than typed: domains, emails, names, one per entry. Sent as data instead of prose, so the assistant reads it as a list and the conversation shows it as a count rather than a wall of text. Optional.

Maximum array length: 1000
Maximum string length: 200
quote
string | null

Part of an earlier reply you selected, sent with your words so the assistant knows what they refer to. Kept with the message and shown above it in the conversation. Optional.

Required string length: 1 - 2000

Response

A stream of Server-Sent Events. The final result frame's data is a turn; an error frame's data is a stream error.

Both halves of one turn, as saved.

The user message too, not just the reply: the client drew its own copy before sending and reconciles it against this one.