List Agent Runs

Lists the run history for a specific agent, with the most recent runs returned first. Use this endpoint to review previous and active runs for the agent. To retrieve the current status and results of a specific run, use Get Agent Run instead. This endpoint does not start or modify a run.

Path Params
string
required

The unique identifier of the agent.

Query Params
filter[status]
array of objects

Filter runs by one or more task states (comma-delimited).

filter[status]
string

Filter runs by creation time: an ISO 8601 timestamp, or the range form [timestamp,*) for on-or-after.

string

Filter runs by the initiating user, workflow, or API client identifier.

string

Sort order. Only the default -createdAt (newest first) is supported; other values are rejected.

int32
1 to 100

The number of runs to return per page. Allowable values are between 1 and 100. Defaults to 25.

string

Opaque cursor from the previous page's links.next. Omit to fetch the first page.

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