Start a workflow asynchronously

Changed on
post/workflow/start

Request

Request body

workflowNamestring required

The name of the workflow to execute

inputunknown required
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.

searchAttributesobject

(Optional) Temporal search attributes to set on the execution. Each attribute must be registered on the namespace. Values are scalars (string, number, boolean) or string arrays (KeywordList). Unregistered names or values that do not match the registered type are rejected with 400.

Response

The workflow start result

workflowIdstring

The id of the started workflow

runIdstring nullable

The first execution's run id for this workflow

Changes