Sign in

v5

OpenAPI 3.1.02026-07-31129337684.6 KB
Workflow Execution

Execute Checkpoint Run

Trigger a new workflow run from a checkpoint of an existing workflow run.

post/workflows/v1/workflows/{workflow_id}/runs/{workflow_run_id}/checkpoint-run

Path parameters

workflow_idstring required
Example:5eb7cf5a86d9755df3a6c593
workflow_run_idstring required
Example:5eb7cf5a86d9755df3a6c593

Request body

resume_turn_indexinteger required

The turn index from the source workflow run to resume from.

start_node_logical_idstring nullable

Optional logical ID of the node to start execution from, bypassing the default start node.

Response

Successful Response

logical_idstring nullable

Unique ID associated with this particular run of the workflow

workflow_idstring nullable

ID of the workflow being run

version_numberinteger nullable

Version number of the workflow this run is associated with. 0 is the initial version (default).

status'not_started' | 'started' | 'running' | 'failed' | 'completed' | 'paused' | 'waiting_for_user_input' | 'cancelled' | 'aborted_looping_risk'
termination_sourcestring nullable

Describes what caused the run to reach a terminal state (especially FAILED). None for normal completions. Well-known values: 'execution_error', 'stale_run_reaper', 'finally_safety_net'.

run_bystring nullable

Identifier of the user or system that initiated the workflow run

version_namestring nullable

Version name of the workflow this run is associated with

workflow_run_idstring nullable

DB Object ID of this workflow run

miscellaneousobject nullable

Miscellaneous metadata that can be used by the workflow run

voice_conversation_idstring nullable

ID of the voice conversation/call that produced this workflow run, if any. Used to cross-link the run with its conversation log in the dashboard.

source_workflow_run_idstring nullable

For evaluation runs, this is the id of the original workflow run being evaluated. For checkpoint resumed runs, this is the id of the parent run being cloned.

checkpoint_source_turn_indexinteger nullable

For checkpoint resumed runs, this stores the turn index of the parent run that was cloned.

is_evaluation_runboolean

Flag indicating if this workflow run is an evaluation run triggered automatically after another workflow run completed