Guest Machines
API referenceRuns

List a run's steering messages

GET/api/v1/runs/{run_id}/steering

List the messages sent to a run, oldest first, with what became of each one.

Pages hold up to limit messages. When has_more is true, pass the last message's id as after_id to read the next page.

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.

Authorization

AuthorizationBearer <token>

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

run_id*Run Id

Query Parameters

after_id?|

Return messages sent after this message id.

limit?Limit
Range1 <= value <= 100
Default50

Header Parameters

X-Org-Id?|

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" \  -H "Authorization: Bearer $GUEST_MACHINES_API_KEY"
{  "items": [    {      "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"    }  ],  "has_more": true}