Skip to main content
POST
Stream Chat

Authorizations

Authorization
string
header
required

API key or JWT token

Body

question
string
required

The question to ask

chat_id
string<uuid>

Existing chat ID to continue a conversation

model
string

Optional model to run this chat on, as an id from GET /v2/models (e.g. gemini_3_5_flash). Omit to use the organization's default model. Only valid on new chats β€” supplying it together with chat_id returns 400, and a model the caller's org/role does not permit returns 403.

Example:

"gemini_3_5_flash"

tools
object

Tool configuration. Enable specific tools for this chat session.

connector_ids
integer<int32>[]

Connector IDs to query (shorthand for tools.connector_ids)

Response

Server-Sent Events stream

SSE stream with JSON data payloads. Event types:

  • {"type":"metadata","id":"...","created_at":"...","model":"...","chat_id":"...","is_continuation":bool}
  • {"type":"text","text":"..."}
  • {"type":"cell","cell":{...}} β€” an execution step (same shape as ChatCell), emitted once when the step starts running (carrying the generated SQL or code) and again when it finishes (carrying outputs, result previews, and timing)
  • {"type":"asset","asset":{...}}
  • {"type":"done","status":"completed|failed","error":"..."}