Middesk APIAgentsRuns

Retrieve an agent run

Retrieves details of a specific agent run

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
Agent run ID

Query parameters

includestringOptional

Comma-separated list of optional sub-resources to include. Pass steps to populate the steps array with this run’s execution trace; omitted by default to avoid the cost of fetching step state from the underlying execution backend.

Response

agent run found
objectstring
Object type identifier.
idstringformat: "uuid"
Unique identifier for the agent run.
created_atdatetime
Timestamp when the agent run record was created.
updated_atdatetime
Timestamp when the agent run record was last updated.
statusenum
Current lifecycle status of the agent run.
thread_idstringOptionalformat: "uuid"
Identifier of the agent thread this run belongs to.
business_idstring or nullOptionalformat: "uuid"

Middesk business the run is scoped to. Null when the run was started with an inline business payload whose business did not exist yet.

agentstringOptional

Agent type that produced this run (for example, cip_orchestrator).

requesterobject or nullOptional

Principal that initiated the run. Populated with the authenticated user’s identity when a session caller initiates the run, and with the account when an API key caller initiates the run. null for system-initiated runs.

started_atdatetime or nullOptional
Timestamp when the agent run started.
ended_atdatetime or nullOptional
Timestamp when the agent run finished.
outputobject or nullOptional

Artifact envelope produced by the agent. Non-null only when status is completed; null for running, interrupted, and error runs.

interruptslist of objectsOptional

Pending interrupt requests awaiting input. Empty when the run is not interrupted. To resume a run, POST the interrupt’s id along with the caller-supplied input to POST /v1/runs/{id}/resume.

stepslist of objectsOptional

Top-level execution steps for this run. Opt-in: pass ?include=steps on GET /v1/runs/{id} (or POST /v1/runs/{id}/resume) to populate this field. Omitted by default to avoid the cost of fetching step state from the underlying execution backend.

Errors

404
Get Agent Run Request Not Found Error