Skip to main content
POST
Execute a workflow synchronously

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.

timeout
number

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

Response

The workflow result

Current workflow result with direct output and memo-based trace information

v
enum<string>
required

Workflow result response version

Available options:
2
workflowId
string
required

The workflow execution id

runId
string | null
required

The specific run id for this execution

status
enum<string>
required

The workflow execution status

Available options:
completed,
failed,
cancelled,
terminated,
timed_out,
continued_as_new
input
any | null
required

The original input passed to the workflow, null if unavailable

output
any | null
required

Direct workflow output, null if no output is available

trace
object | null
required

Available destinations for trace data

error
object · null · null
required

Structured error details captured from the workflow or activity failure