Skip to main content

Send Message (Assist Mode)

Sends a user message into the session and streams the agent’s reply back as Server-Sent Events.
string
required
The user message.
string
Override the model configured on the agent for this turn only.

Response

The stream carries a sequence of JSON events covering turn-run state changes, incremental text/token chunks, and tool calls made by the agent as it works.
Returns 400 with "message is required" if message is missing. Returns 429 if the workspace has hit its managed-agent rate limit.

Get Session Timeline

Returns the full ordered history of a session — messages and turn runs interleaved, sorted ascending by created_at.
(MessageEvent | TurnRunEvent)[]

Submit Tool Results

When an agent needs to call a tool your integration owns, it pauses and emits a pending tool call in the event stream. Execute the tool on your side, then report the result back here so the agent can continue.
string
required
The ID of the pending tool call, taken from the event stream.
any
The tool’s return value. Provide this on success.
string
Error message if the tool failed. Provide either result or error, not both.
Returns 403 with "toolCallId does not belong to session" if the tool call belongs to a different session, and 404 with "Unknown toolCallId" if it doesn’t exist.

Cancel Run

string
required
The turn run (or autonomous run) to cancel.
Returns 400 with "Run is {current_status}" if the run isn’t currently running (e.g. already completed).