API reference · Agents
A run's events from the dashboard
GET/api/account/agents/{id}/runs/{run}/eventsSigned in session
As GET /v1/agents/{id}/runs/{run}/events. A 404 while hosted runs are off on the deployment.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The agent's id; self on an agent's own key. |
| run (path)required | string | The run's id, run_ and 24 hex digits. |
Answer 200
The events.
| Field | Type | What it is |
|---|---|---|
| object | string | One of "list". |
| data | array of object | |
| data[] | string | One of "agent.run.event". |
| data[] | integer | Numbered from 1 per run; the SSE id. |
| data[] | string | run.created, run.in_progress, run.message, run.tool_call, run.tool_output, run.image, run.step.failed, run.requires_action, and one of run.completed, run.incomplete, run.failed, run.cancelled, run.expired last. |
| data[] | integer | |
| data[] | object | |
| has_more | boolean |
Errors
- 401OpenAI shaped error.
- 404OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.