Sign in

v13

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-015232292.9 KB
Workflows

Execute Workflow

Execute a deployed workflow. Supports synchronous, asynchronous, and streaming modes. For async execution, the response includes a statusUrl you can poll for results.

post/api/workflows/{id}/execute

Path parameters

idstring required
Example:3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36

The unique identifier of the deployed workflow to execute.

Request body

inputobject

Key-value pairs matching the workflow's defined input fields. Use the Get Workflow endpoint to discover available input fields.

triggerTypestring

How this execution was triggered. Defaults to api when called via the REST API. Recorded in execution logs for filtering.

streamboolean

When true, returns results as Server-Sent Events (SSE) for real-time block-by-block output streaming.

selectedOutputsstring[]

List of specific block IDs whose outputs to include in the response. When omitted, all block outputs are returned.

Response

Synchronous execution completed successfully.

successboolean

Whether the workflow executed successfully without errors.

executionIdstring

Unique identifier for this execution. Use this to query logs or cancel the execution.

outputobject

Workflow output keyed by block name and output field. Structure depends on the workflow's block configuration.

errorstring nullable

Error message if the execution failed. null on success.

Example response

{
  "success": true,
  "executionId": "e4f8d2b6-9a1c-4e3d-8b7f-5c0a2d9e6f13",
  "output": {
    "result": "Hello, world!"
  },
  "metadata": {
    "duration": 1250,
    "startTime": "2025-06-20T14:15:22Z",
    "endTime": "2025-06-20T14:15:23Z"
  }
}