Skip to main content
POST
/
workflow
/
start
Start a workflow asynchronously
curl --request POST \
  --url http://localhost:3001/workflow/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflowName": "<string>",
  "input": "<unknown>",
  "workflowId": "<string>",
  "taskQueue": "<string>"
}
'
{
  "workflowId": "<string>"
}

Body

application/json
workflowName
string
required

The name of the workflow to execute

input
any
required

The payload to send to the workflow

workflowId
string

(Optional) The workflowId to use. Must be unique

taskQueue
string

The name of the task queue to send the workflow to

Response

The workflow start result

workflowId
string

The id of the started workflow