CYcyberdesk-hq
runs

Get Run

Get a specific run by ID.

The run must belong to the authenticated organization. Returns the run with its associated workflow and machine data.

Use the include parameter to fetch related resources in the response. Related resources are returned in the included array following the JSON:API pattern.

get/v1/runs/{run_id}

Request

  • Base URL
    https://api.cyberdesk.io
  • URL
    https://api.cyberdesk.io/v1/runs/{run_id}
  • Auth
    HTTP bearer

Path parameters

run_idstring uuid required

Query parameters

includestring nullable

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

Response

Successful Response

idstring uuid required
workflow_idstring uuid required
machine_idstring uuid nullable
user_idstring uuid nullable
organization_idstring nullable
is_priorityboolean
status'scheduling' | 'running' | 'running_checks' | 'success' | 'cancelled' | 'task_failed' | 'error' required
errorstring[] nullable
output_dataobject nullable
input_attachment_idsstring[] nullable
output_attachment_idsstring[] nullable
run_message_historyobject[] nullable
input_valuesobject nullable
main_promptstring nullable
pool_idsstring[] nullable
sensitive_input_aliasesobject nullable
usage_metadataobject nullable

Arbitrary usage/billing metadata captured during a run

session_idstring uuid nullable
session_aliasstring nullable
release_session_afterboolean nullable
created_atstring date-time required
started_atstring date-time nullable
ended_atstring date-time nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.