Execute a workflow synchronously

Changed on

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

post/workflow/run

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.

timeoutnumber

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

Response

The workflow result

OR

Changes

    • info

      added the new optional request property

    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status