Retrieve a workflow run plan version
/api/v1/workflows/runs/{run_id}/plan/versions/{version}Retrieve the complete definition for one immutable plan version. Version snapshots are fetched individually so the base plan response stays compact.
Required access
Credentials: automation account, delegated token, user session, user API key
User API keys use the owner’s current permissions, subject to any key restrictions. Capability scopes below apply to automation account keys and delegated tokens.
Scope: workflows:read
The caller must be able to read both the workflow run and its saved workflow, matching the current-plan endpoint.
A user-owned key prefixed gsmc_uk_, bound to one organization. It follows its owner's current membership, role and resource permissions, optionally restricted to read-only access. No X-Org-Id header is needed; a conflicting organization is rejected. Credential creation, personal connection setup and human attestations require a signed-in session. Runs are private to the calling user; sharing an agent grants access to your own personal memory of it, never to the agent's own memory.
In: header
Path Parameters
Header Parameters
Selects the active organization for a direct user session that has more than one membership. Automation account keys and delegated tokens are each bound to one organization and ignore it.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/workflows/runs/0/plan/versions/0" \ -H "Authorization: Bearer $GUEST_MACHINES_API_KEY"{ "version": 0, "definition": { "steps": [ { "key": "string", "name": "string", "run_if": "string", "on_error": { "action": "continue", "max_attempts": 3, "backoff": "exponential", "backoff_delay_seconds": 1, "fallback_agent_id": "ea74c5a8-d285-4937-959b-1e318178db0b" }, "limits": { "max_duration_seconds": 1 }, "files": [ { "source": { "kind": "input", "input_alias": "string", "step": "string", "selector": { "file_name": "string", "primary": true }, "iteration": 1 }, "target_alias": "string", "required": true } ], "kind": "agent", "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "instruction": "string", "input": {}, "responder_user_id": "0f708b4a-8382-4a27-a010-8a6f70d21699" } ], "loop": { "from_step": "string", "until": "string", "max_iterations": 3 }, "output": null, "review_after_steps": false }}Change a workflow run's remaining plan POST
At a pending completed-step review, append structured steps or replace only the unstarted suffix. Completed results and the original plan remain intact; the request creates a new plan version for this run.
Respond to a workflow step review POST
Approve the completed result and continue, revise an agent step with feedback while retaining its prior result, or replace the remaining plan and continue.