v2

latestOpenAPI 3.1.02026-07-262937191.0 MB
workflows

Execute Workflow

Execute Workflow

post/v1/workflows/{workflow_identifier}/execute

Path parameters

workflow_identifierstring required

Request body

execution_idstring nullable

Allows you to specify a custom execution ID. If not provided, a random ID will be generated.

wait_for_resultboolean

If true, wait for the workflow to complete and return the result directly.

timeout_secondsnumber nullable

Maximum time to wait for completion when wait_for_result is true.

custom_tracing_attributesobject nullable
extensionsobject nullable

Plugin-specific data to propagate into WorkflowContext.extensions at execution time.

task_queuestring nullable

Deprecated. Use deployment_name instead.

deployment_namestring nullable

Name of the deployment to route this execution to

Response

Successful Response

OR