Start Agent Run (Stream)

Starts a new agent run and streams progress and output over Server Sent Events (text/event-stream).

The first event includes the runId as task.id. Store this value so you can retrieve the run later with Get Agent Run or reconnect using Resume Agent Run Stream.

The stream includes status updates and artifact content as the agent runs. The first artifact represents the primary response and may contain text and structured data. A final status update indicates that the run has reached a terminal state.

This endpoint is available only for agents that support STREAMING in capabilities.executionModes. The request uses the same message format and inputSchema validation as Start Agent Run. Customer-defined Agent Teams on the platform do not currently support streaming. Agents that do not support streaming return 400 STREAMING_NOT_SUPPORTED.

Path Params
string
required

The unique identifier of the agent to run.

Body Params

The run request.

Request body for starting an agent run: a JSON:API document, { "data": { "type": "StartAgentRunRequest", "attributes": { ... } } }, per the ZI public-API standard for request bodies. The run input lives in data.attributes; the same body is used by Start Agent Run and Start Agent Run (Stream).

data
object
required

The primary data of the document

Headers
string
enum
Defaults to application/vnd.api+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/event-stream
application/vnd.api+json