Retry a failed agent run
POST /v1/runs/{runId}/retry · SDK retryRun · CLI deployments run retry
Requires runs:write.
AuthorizationBearer <token>Opaque bearer credential scoped to one service account and tenant.
runId*string^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-environment?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-organization?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-project?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$RunResponse
application/json- response
createdAt*string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timeupdatedAt*string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timeversion*number|||environmentId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$organizationId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$projectId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$workspaceId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$agentDeploymentId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$agentReleaseId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$attempt*number|||automation?checkpointCount*number|||completedAt?string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timeerror?executionBindingId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$executionPurpose*string"customer""evaluation""preview"executor*stringid*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$object*"run""run"parentSpanId?stringpriority*number|||releaseSelection?string"candidate""primary"replayedFromRunId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$replayedFromTraceId?stringspanId*stringstartedAt?string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timestatus*string"canceled""completed""failed""queued""running""waiting-for-approval""waiting-for-tool"threadId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$traceId*stringtrigger*stringcurl -X POST "https://example.com/v1/runs/string/retry"{ "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "environmentId": "string", "organizationId": "string", "projectId": "string", "workspaceId": "string", "agentDeploymentId": "string", "agentReleaseId": "string", "attempt": 0, "automation": { "fireId": "string", "id": "string", "kind": "heartbeat" }, "checkpointCount": 0, "completedAt": "2019-08-24T14:15:22Z", "error": { "property1": null, "property2": null }, "executionBindingId": "string", "executionPurpose": "customer", "executor": "string", "id": "string", "object": "run", "parentSpanId": "string", "priority": 0, "releaseSelection": "candidate", "replayedFromRunId": "string", "replayedFromTraceId": "string", "spanId": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "canceled", "threadId": "string", "traceId": "string", "trigger": "string"}