v1

latestOpenAPI 3.0.02026-07-17301761.7 KB

Start a workflow asynchronously

post/workflow/start

Request body

workflowNamestring required

The name of the workflow to execute

{"stackTrail":"paths:/workflow/start:post:requestBody:content:application/json:schema:properties:input","oasType":"schema","type":"unknown","description":"The payload to send to the workflow"}
workflowIdstring

(Optional) The workflowId to use. Must be unique

catalogstring

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

taskQueuestring

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

Response

The workflow start result

workflowIdstring

The id of the started workflow

runIdstring nullable

The first execution's run id for this workflow