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>",
  "catalog": "<string>",
  "taskQueue": "<string>"
}
'
{
  "workflowId": "<string>",
  "runId": "<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

​
catalog
string

The catalog (Temporal task queue) to route the execution to. Falls back to the default catalog.

​
taskQueue
string
deprecated

Deprecated alias for catalog. If both are sent, catalog wins.

Response

The workflow start result

​
workflowId
string

The id of the started workflow

​
runId
string | null

The first execution's run id for this workflow