Skip to main content
PATCH
Update Run

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

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.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

run_id
string<uuid>
required

Body

application/json

Schema for updating a run

status
enum<string> | null
Available options:
scheduling,
running,
running_checks,
success,
cancelled,
task_failed,
error
error
string[] | null
output_data
Output Data · object | null
output_attachment_ids
string[] | null
run_message_history
Run Message History · object[] | null
input_values
Input Values · object | null
usage_metadata
Usage Metadata · object | null
post_run_checks
RunPostRunCheckSnapshot · object[] | null
started_at
string<date-time> | null
ended_at
string<date-time> | null
release_session_after
boolean | null

Response

Successful Response

Run response schema

workflow_id
string<uuid>
required
machine_id
string<uuid> | null
required
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
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

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

model_metadata
WorkflowModelMetadata · object | null

Per-run model metadata overrides used for execution. Null means the run falls back to the workflow's model_metadata.

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 (schema is flexible)

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