Start Agent Run

Starts a new run for the specified agent.

By default, agent runs are asynchronous. The request returns the in-progress run, including its run id in data.id, while execution continues in the background. Use that run id with Get Agent Run to retrieve the latest status and final result.

To run the agent synchronously, set returnImmediately: false in data.attributes. The connection remains open while the agent executes, up to a maximum of 300 seconds. If the run does not complete within that window, the response returns the in-progress run and execution continues in the background. Use the returned run id from data.id with Get Agent Run to retrieve the latest status and final result.

When the run completes, the first item in artifacts contains the primary response and may include text and structured data. Additional artifacts, when present, contain supplementary output.

The request message is validated against the agent's inputSchema. Use Get Agent Details before starting a run to review the required input format.

Path Params
string
required

The unique identifier of the agent to run.

Body Params

The run request. The sync/async switch returnImmediately is a field of data.attributes, not a query parameter (A2A carries it in the message body).

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

Responses

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