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

Changes

Changed in 11 of the 20 revisions of this API.92221

Aug 7, 202609a49e59843528See the full diff
- ▲
  added to the response body oneOf list for the response status
  response-body-one-of-added
- ▲
  the response's body type changed from object to no type for status
  response-body-type-changed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 202645d6788e92302See the full diff
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ▲
  the response property // became optional for the status
  response-property-became-optional
Jul 3, 2026fcefb3d333021See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
Jun 17, 2026666a503b2fcd1See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
Jun 16, 20265d02013bc7af11See the full diff
- ●
  added the new continued_as_new enum value to the response property for the response status
  response-property-enum-value-added
- ○
  removed the continued enum value from the response property for the response status
  response-property-enum-value-removed
Jun 11, 20263a0b1d5521591See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
May 29, 2026116dbed86e241See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
May 19, 2026e911085405d144See the full diff
- ●
  added the new canceled enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new continued enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new terminated enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new timed_out enum value to the response property for the response status
  response-property-enum-value-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Apr 30, 2026c8798d226c672See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  request property deprecated
  request-property-deprecated
Apr 24, 202601552bfa957923See the full diff
- ▲
  added to the response body oneOf list for the response status
  response-body-one-of-added
- ▲
  the response's body type changed from object to no type for status
  response-body-type-changed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed

Full history (11 revisions)