Skip to main content
POST
Start or continue an Orby assistant turn (SSE stream)

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
message
string
required

The operator's message for this turn.

Required string length: 1 - 8000
thread_id
string | null

Existing thread to continue; omit to start a new thread.

page
object

Optional context for the dashboard page the operator is viewing, used to ground the turn.

Response

200 - text/event-stream

Server-Sent Events stream of the assistant turn. Each frame is an SSE event/data pair; frame types are router, status, token, tool_start, tool_pending, tool_end, refusal, clarify, response, and error. A turn that pauses on a confirmation gate emits a tool_pending frame carrying the pending tool-action id to approve or reject.

A stream of newline-delimited SSE frames until the terminal response or error frame.