MImistral
workflows

Execute Workflow

Changed on

Execute Workflow

post/v1/workflows/{workflow_identifier}/execute

Request

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
force_new_traceboolean

If true, ignore the caller's trace context and start a new, independent trace for this execution instead of joining the caller's trace.

traceparentstring nullable

W3C trace context to join this execution to the caller's trace. Ignored when force_new_trace is set.

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

Changes

  • fa73befe1c61Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • 61436a496404Revision changes
    • info

      added the new optional request property