Deployments.ai Docs
Runtime

Show a run by ID without its thread

GET /v1/runs/{runId} · SDK getRunById · CLI deployments run get

GET
/v1/runs/{runId}

Requires runs:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Path Parameters

runId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment?string

Required 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.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required 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.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required 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.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

RunResponse

application/json
  1. response
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
updatedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
version*number|||
environmentId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
projectId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
workspaceId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
agentDeploymentId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
agentReleaseId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
attempt*number|||
automation?
checkpointCount*number|||
completedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
error?
executionBindingId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
executionPurpose*string
Value in"customer""evaluation""preview"
executor*string
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
object*"run"
Value in"run"
parentSpanId?string
priority*number|||
releaseSelection?string
Value in"candidate""primary"
replayedFromRunId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
replayedFromTraceId?string
spanId*string
startedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
status*string
Value in"canceled""completed""failed""queued""running""waiting-for-approval""waiting-for-tool"
threadId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
traceId*string
trigger*string
curl -X GET "https://example.com/v1/runs/string"
{  "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"}