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
| Name | Type | Required | Description |
|---|---|---|---|
agentRunId | string | required | Identifies the agent run whose state or history is addressed. Applies to List the run's checkpoint metadata. |
query
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List the run's checkpoint metadata. |
cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List the run's checkpoint metadata. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — checkpoints: array<object> (required); pagination: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |