Skip to main content
POST
Start a streaming run

Authorizations

Authorization
string
header
required

Server-side API Key; do not expose it in browser code.

Path Parameters

thread_id
string
required

Body

application/json
assistant_id
string
required

Published agent ID. HTTP uses assistant_id; the SDK accepts assistantId as a method argument.

input
object
required

Chat action payload. Examples show send; retry, resume and follow_up require the appropriate execution state and access.

context
object

Optional runtime context. Use only fields supported by your deployed agent.

Response

Schematic SSE frames; real events contain additional fields. Preserve each id cursor, ignore colon-prefixed heartbeat comments and inspect lifecycle, interruption and error events. HTTP success or connection close alone is not task success.

The response is of type string.