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 Sim API key (personal or workspace). Generate one from the Sim 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://www.sim.ai/api/workflows/{id}/execute" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "input": {      "key": "value"    }  }'
{
  "success": true,
  "executionId": "exec_9f8e7d6c5b",
  "output": {
    "result": "Hello, world!"
  },
  "error": null,
  "metadata": {
    "duration": 1250,
    "startTime": "2025-06-20T14:15:22Z",
    "endTime": "2025-06-20T14:15:23Z"
  }
}
{
  "success": true,
  "async": true,
  "jobId": "job_4a3b2c1d0e",
  "executionId": "exec_9f8e7d6c5b",
  "message": "Execution queued",
  "statusUrl": "https://www.sim.ai/api/jobs/job_4a3b2c1d0e"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}