Sign in

v1

latestOpenAPI 3.1.02026-07-22136108233.0 KB
runs

Retry Run

Retry an existing run in-place (same run_id).

  • Rejects if run is active (scheduling or running).
  • Always clears previous outputs/history/output attachments.
  • Replaces input attachments if file_inputs are provided.
  • Optionally overrides inputs, sensitive inputs, session/machine/pools.
  • Triggers immediate assignment attempt unless the session is busy.
post/v1/runs/{run_id}/retry

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

input_valuesobject nullable

Override input values for workflow variables

sensitive_input_valuesobject nullable

Provide new sensitive inputs (supports nested objects); stored in vault and mapped to aliases

machine_idstring uuid nullable

Override specific machine for this retry

pool_idsstring[] nullable

Override pool filters if not using a specific machine

reuse_sessionboolean nullable

Keep existing session_id. If false and no session_id provided, clears session fields

session_idstring uuid nullable

Set/override session_id for this retry

start_sessionboolean nullable

Start a fresh new session for this retry (creates new session_id)

session_aliasstring nullable

Set/override session_alias for this retry (used with start_session or session_id)

release_session_afterboolean nullable

Override release_session_after behavior for this retry

is_priorityboolean nullable

Override priority for this retry. If omitted, the run keeps its existing priority.

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