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
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.
timeoutnumber
(Optional) The max time to wait for the execution, defaults to 30s
Response
The workflow result
workflowIdstring
The workflow execution id
runIdstring
The specific run id for this execution
{"stackTrail":"components:schemas:WorkflowResultResponse:properties:input","oasType":"schema","type":"unknown","description":"The original input passed to the workflow, null if unavailable"}
{"stackTrail":"components:schemas:WorkflowResultResponse:properties:output","oasType":"schema","type":"unknown","description":"The result of workflow, null if workflow failed"}
aggregationsobject nullable
Convenience totals aggregated from LLM and http usage and cost
status'completed' | 'failed' | 'canceled' | 'terminated' | 'timed_out' | 'continued'
The workflow execution status
errorstring nullable
Error message if workflow failed, null otherwise