Sign in

v1

latestOpenAPI 3.1.02026-07-22136108233.0 KB
runs

Update Run

Update a run's data.

Only the fields provided in the request body will be updated. The run must belong to the authenticated organization.

patch/v1/runs/{run_id}

Path parameters

run_idstring uuid required

Headers

Idempotency-Keystring
Example:550e8400-e29b-41d4-a716-446655440000

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Request body

status'scheduling' | 'running' | 'running_checks' | 'success' | 'cancelled' | 'task_failed' | 'error'
errorstring[] nullable
output_dataobject nullable
output_attachment_idsstring[] nullable
run_message_historyobject[] nullable
input_valuesobject nullable
usage_metadataobject nullable
started_atstring date-time nullable
ended_atstring date-time nullable
release_session_afterboolean nullable

Response

Successful Response

workflow_idstring uuid required
machine_idstring uuid nullable required
idstring uuid required
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

Per-run prompt override used for execution. Null means the run falls back to the workflow's current main_prompt.

pool_idsstring[] nullable
sensitive_input_aliasesobject nullable
usage_metadataobject nullable

Arbitrary usage/billing metadata captured during a run (schema is flexible)

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