Documentation menu
Agent Runs

Get a run

GET /api/v1/agent-runs/{agentRunId}

Retrieve one canonical Agent Run by its opaque run_ ID.

Ownership

  • The run is resolved by its canonical ID and must be authorized in the caller's Organization and Agent scope.
  • A run retains the Agent and immutable Agent Revision identity selected at admission; it is not rebound to a newer revision.

Response

  • Returns the public Agent Run record, including Agent and Agent Revision identity, actor references, lifecycle state, digests, timestamps, runtime version, and content size.
  • The response does not expose internal execution tables, provider details, token statistics, or a separate step collection.

AgentRun Lifecycle States

  • queued: Accepted; no live attempt
  • acquiring: Attempt opened; machine lease in progress
  • starting: Machine leased; runner handoff and runtime boot
  • running: Runtime executing
  • awaitingToolResult: Paused for an interactive tool result
  • awaitingDelegateResult: Paused for an external delegate result
  • canceling: Cancel requested; runtime winding down
  • completed / failed / canceled / expired: Terminal

Authentication

  • Requires a valid session or API key in the Authorization header.
  • The credential must be authorized for the run's Agent Run operation and resource scope.

Parameters

path

NameTypeRequiredDescription
agentRunIdstringrequiredIdentifies the agent run whose state or history is addressed. Applies to Get a run.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)