Sign in

Execute a workflow synchronously

Executes a workflow and waits for it to complete before returning the result

post/workflow/run

Request body

workflowNamestring required

The name of the workflow to execute

{"stackTrail":"paths:/workflow/run: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

taskQueuestring

The name of the task queue to send the workflow to

timeoutnumber

(Optional) The max time to wait for the execution, defaults to 30s

Response

The workflow result

workflowIdstring

The workflow execution id

{"stackTrail":"paths:/workflow/run:post:responses:200:content:application/json:schema:properties:output","oasType":"schema","type":"unknown","description":"The output of the workflow, null if workflow failed"}
status'completed' | 'failed'

The workflow execution status

errorstring nullable

Error message if workflow failed, null otherwise

Changes