Retrieve a run's steering message
/api/v1/runs/{run_id}/steering/{message_id}Retrieve one message sent to a run, and what became of it.
Required access
Credentials: 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: runs:read
Only the user who started the run may read its steering messages, and a delegated token acts as that user.
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/runs/0/steering/0" \ -H "Authorization: Bearer $GUEST_MACHINES_API_KEY"{ "message": { "id": 0, "run_id": 0, "status": "pending", "content": "string", "client_ref": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "delivered_at": "2019-08-24T14:15:22Z" }}Steer a working run POST
Send a message to a run while it works. The run reads it before its next step and takes it into account, as if you had said it in a chat.
Retrieve a run plan GET
Retrieve the active plan, its progress, and the version values needed to replace it. Read it before approving or denying a run's tools: `risk_summary.requires_approval` says whether the tools need approval, and a strict plan's `actions` name the tools it would use.