You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/openapi-v2-workflows.json
+7-2Lines changed: 7 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -2502,7 +2502,7 @@
2502
2502
"post": {
2503
2503
"operationId": "executeWorkflowV2",
2504
2504
"summary": "Execute Workflow",
2505
-
"description": "Execute the deployment; `run.source: \"manual\"` uses draft state. Manual runs require a personal key or OAuth write access; workspace keys, anonymous callers, and async are rejected. Start at a runnable trigger, or resume from `sourceRunId` using the same-workflow snapshot. Public deployments allow anonymous sync or streaming; async requires credentials. Sync timeouts return `200` with failed status and `TIMEOUT`. Each option carries the modes it requires and the modes that reject it; a violated combination is a 400.\n\nOAuth scope: `api:write`.",
2505
+
"description": "Execute a deployment or use `run.source: \"manual\"` for draft state. Manual runs require personal or OAuth write access and reject workspace keys, anonymous callers, and async. Start at a trigger or resume from same-workflow `sourceRunId`. Public deployments allow anonymous sync or streaming. Request `application/x-ndjson` for 15-second heartbeats and final resource. Timeouts return `200` with failed status and `TIMEOUT`. Each option carries the modes it requires and the modes that reject it; a violated combination is a 400.\n\nOAuth scope: `api:write`.",
2506
2506
"x-sim-operation": "workflows.execute",
2507
2507
"x-oauth-scope": "api:write",
2508
2508
"tags": ["Workflows"],
@@ -2566,7 +2566,7 @@
2566
2566
},
2567
2567
"responses": {
2568
2568
"200": {
2569
-
"description": "A synchronous run result or Server-Sent Event stream.",
2569
+
"description": "A synchronous run result, heartbeat-delimited NDJSON result stream, or Server-Sent Event stream.",
0 commit comments