workflow

Run Workflow

post/workflows/{workflow_name}/run

Path parameters

workflow_namestring required

The name of the workflow to execute.

workflow_label_namestring nullable

Specify a workflow label name to run a specific labeled version.

workflow_version_numberinteger nullable

Specify a workflow version number to run a specific version.

metadataobject nullable

A dictionary of metadata key-value pairs.

input_variablesobject

A dictionary of input variables required by the workflow.

return_all_outputsboolean

If set to true, all outputs from the workflow execution will be returned.

callback_urlstring uri nullable

HTTP URL where execution results are posted asynchronously. When provided, the API returns 202 Accepted immediately.

Workflow execution created successfully

successboolean required

Indicates if the request was successful.

messagestring required

A message describing the result.

warningstring nullable

Warning about missing or unused input variables, if any.

workflow_version_execution_idinteger required

The ID of the created workflow execution.