Documentation menu
Agent Runs

List the run's checkpoint metadata

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

Returns one row per persisted checkpoint artifact for the run.

Use the returned identifiers to fetch any checkpoint resources needed by the client.

Authentication

  • Requires session or API key with operation agent-runs:checkpoints:list
  • The caller must be authorized for this operation within the run's owning organization and its persisted Project, Environment, or Agent scope

Parameters

path

NameTypeRequiredDescription
agentRunIdstringrequiredIdentifies the agent run whose state or history is addressed. Applies to List the run's checkpoint metadata.

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List the run's checkpoint metadata.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List the run's checkpoint metadata.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — checkpoints: array<object> (required); pagination: 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)