workflow_start_workflow_by_name
Start a new Conductor workflow execution by name, with options for idempotency, priority, correlation, and input data.
Instructions
Starts a new execution of a conductor workflow by its name
Args: workflow_name: The name of the workflow definition to create a new execution for correlation_id: An integer used as unique identifier for the workflow execution, used to correlate the current workflow instance with other workflows. priority: A number starting at 0 representing the priority of the execution of the workflow. Lower numbers mean higher priority. idempotency_key: An arbitrary, user-provided string used to ensure idempotency when calling this endpoint multiple times. idempotency_strategy: A string representing one of the following three strategies: RETURN_EXISTING: Return the workflowId of the workflow instance with the same idempotency key. FAIL: Start a new workflow instance only if there are no workflow executions with the same idempotency key. FAIL_ON_RUNNING: Start a new workflow instance only if there are no RUNNING or PAUSED workflows with the same idempotency key. Completed workflows can run again. data: A dictionary containing any arguments to pass into the workflow for creation
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflow_name | Yes | ||
| correlation_id | No | ||
| priority | No | ||
| idempotency_strategy | No | RETURN_EXISTING | |
| idempotency_key | No | ||
| data | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |