Run the active deployment, or set run.source: "manual" to run the saved draft. Deployed execution requires workspace read access and OAuth api:write scope or an API key; public deployments also allow anonymous synchronous or streamed runs. Manual runs require personal-key or OAuth write access and cannot be async.
Use async: true for a queue receipt, or stream: true for SSE. For a synchronous run with both flags false, send Accept: application/x-ndjson for heartbeat frames and a final frame containing data. Timeouts return 200 with status: "failed" and error.code: "TIMEOUT"; inspect run status. See Streaming for event formats. Input descriptions specify compatible modes; invalid combinations return 400.
Supply X-Run-Id to prevent duplicate execution. Reuse returns 409, without replaying results. A 503 with error.details.code: "ASYNC_ENQUEUE_AMBIGUOUS" omits Retry-After because the run may already have started. Reconcile using the returned run ID; do not start another run with a new or omitted ID.
OAuth scope: api:write.
/api/v2/workflows/{workflowId}/executeYour Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.
In: header
Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.
curl -X POST "https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/execute" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "input": { "ticketId": "ticket_123" } }'{
"data": {
"runId": "run_8f14e45f-ceea-467f-a",
"workflowId": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
"status": "completed",
"output": {
"result": "Ticket routed to Support"
},
"blockOutputs": null,
"error": null,
"startedAt": "2026-08-09T18:04:10.000Z",
"endedAt": "2026-08-09T18:04:11.000Z",
"durationMs": 1000
}
}{
"data": {
"runId": "run_8f14e45f-ceea-467f-a",
"statusUrl": "https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/runs/run_8f14e45f-ceea-467f-a"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required"
}
}{
"error": {
"code": "USAGE_LIMIT_EXCEEDED",
"message": "Usage limit exceeded. Please upgrade your plan to continue."
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Insufficient workspace permissions",
"details": {
"code": "INSUFFICIENT_WORKSPACE_ROLE"
}
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}{
"error": {
"code": "CONFLICT",
"message": "Run ID has already been used",
"details": {
"code": "RUN_ID_CONFLICT",
"runId": "0f7c1a2e-9b3d-4c58-8a21-6d4e5f7a9b01"
}
}
}{
"error": {
"code": "PAYLOAD_TOO_LARGE",
"message": "Request body is too large"
}
}{
"error": {
"code": "UNSUPPORTED_MEDIA_TYPE",
"message": "Request body must be sent as application/json"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "API rate limit exceeded",
"details": {
"retryAfter": "2026-01-01T00:00:30.000Z"
}
}
}{
"error": {
"code": "CLIENT_CLOSED_REQUEST",
"message": "Client cancelled request",
"details": {
"runId": "0f7c1a2e-9b3d-4c58-8a21-6d4e5f7a9b01"
}
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service temporarily unavailable"
}
}Path parameters
Unique workflow identifier.
1 <= lengthHeader parameters
Run ID for API-key or OAuth callers; ignored for anonymous requests. Reuse it after an uncertain response: a claimed ID returns 409 with RUN_ID_CONFLICT, without replaying results. Check Get workflow run, but 404 can persist while the ID remains claimed and does not establish whether execution started. Do not automatically restart with a fresh or omitted ID; either can start another run.
^[A-Za-z0-9._:-]+$1 <= length <= 128Comma-separated workflow identifiers naming the workflow-to-workflow call chain that led to this request. Each hop appends its own workflow id, and Sim sets it automatically; supply it yourself only when relaying an existing chain. A chain at the maximum depth is rejected with 409 and error.details.code: "CALL_CHAIN_DEPTH_EXCEEDED".
Request body
application/json
Input, workflow-state selection, and execution-mode options. Input descriptions specify compatible modes; invalid combinations return 400.
TypeScript definitions
Use the request body type in TypeScript.
Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json