Skip to main content
GET
Get Run

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

run_id
string<uuid>
required

Query Parameters

include
string | null

Comma-separated list of related resources to include. Allowed values: workflow, machine, machine.pools. Example: include=workflow,machine

Response

Successful Response

Run response with optional included related resources.

When the include query parameter is used, related resources are returned in the included array following the JSON:API pattern.

Example request: GET /v1/runs/123?include=workflow,machine

id
string<uuid>
required
workflow_id
string<uuid>
required
status
enum<string>
required
Available options:
scheduling,
running,
running_checks,
success,
cancelled,
task_failed,
error
created_at
string<date-time>
required
machine_id
string<uuid> | null
user_id
string<uuid> | null
organization_id
string | null
is_priority
boolean
default:false
error
string[] | null
output_data
Output Data · object | null
input_attachment_ids
string[] | null
output_attachment_ids
string[] | null
run_message_history
Run Message History · object[] | null
input_values
Input Values · object | null
main_prompt
string | null
model_metadata
WorkflowModelMetadata · object | null

JSONB-backed workflow model configuration metadata.

Stored on the Workflow row as model_metadata to avoid adding many FK columns. All fields are optional; when missing/null, the system falls back to Cyberdesk defaults.

pool_ids
string<uuid>[] | null
sensitive_input_aliases
Sensitive Input Aliases · object | null
usage_metadata
Usage Metadata · object | null

Arbitrary usage/billing metadata captured during a run

post_run_checks
RunPostRunCheckSnapshot · object[] | null

Version-tolerant snapshot/results for the run's post-run checks.

session_id
string<uuid> | null
session_alias
string | null
release_session_after
boolean | null
started_at
string<date-time> | null
ended_at
string<date-time> | null
included
IncludedResource · object[] | null

Related resources requested via the include query parameter