COcooper-square-technologies
Agents

Get an agent run

Changed on

Retrieve the current status and result details for an agent run.

get/v1/agents/{agent_id}/runs/{run_id}

Request

Path parameters

agent_idstring uuid required

The ID of the agent that owns the run.

run_idstring uuid required

The ID of the run to retrieve.

Response

Successful Response

idstring uuid required

Unique ID for the run.

agent_idstring uuid required

Unique ID of the agent for this run.

status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'skipped' | 'unknown' required

Current execution status for an agent run.

started_atstring date-time nullable

When the run started, if it has started.

finished_atstring date-time nullable

When the run finished, if it has completed.

errorobject nullable

Error details, when the run fails and error information is available.

outputsobject

Output values returned by the run, keyed by variable ID. This object conforms to schema.output from the agent detail response and is empty when no outputs are available.

Changes