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

Authorization

apiKey
X-API-Key<token>

Your SteelEngine API key (personal or workspace). Generate one from the SteelEngine dashboard under Settings > API Keys.

In: header

Path Parameters

id*string

The unique identifier of the deployed workflow to execute.

Request Body

application/json

Execution configuration including input values and execution mode options.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/workflows/string/execute" \  -H "Content-Type: application/json" \  -d '{    "input": {      "query": "What is the weather in Tokyo?"    }  }'
{  "success": true,  "executionId": "exec_abc123",  "output": {    "content": "The weather in Tokyo is sunny, 22°C."  },  "error": null,  "metadata": {    "startTime": "2026-01-15T10:30:00Z",    "endTime": "2026-01-15T10:30:01Z",    "duration": 1250  }}
PreviousPATCHUpdate Workspace
NextPOSTCancel Execution