Guest Machines
API referenceRuns

List a run's artifacts

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

List ready artifacts produced by a run or its complete run tree.

Required access

Credentials: service principal, delegated token, user session

Scope: runs:read

Authorization

AuthorizationBearer <token>

An organization-owned automation key, prefixed gsmc_sk_. Already bound to one organization, so it needs no X-Org-Id header. It carries no user identity: it never reaches a private resource however it is scoped, and a run it starts has no user for an interactive tool to reach.

In: header

Path Parameters

run_id*Run Id

Query Parameters

scope?Scope
Default"tree"

Value in

  • "self"
  • "tree"

Header Parameters

X-Org-Id?|

Selects the active organization for a credential that belongs to more than one. Service-principal keys are bound to a single 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/artifacts" \  -H "Authorization: Bearer $GUEST_MACHINES_API_KEY"
{  "artifacts": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "producer_run_id": 0,      "root_run_id": 0,      "chat_message_id": 0,      "visibility": "org_shared",      "status": "deleted",      "source_kind": "inline",      "file_name": "string",      "media_type": "string",      "file_size": 0,      "sha256": "string",      "description": "string",      "is_primary": true,      "metadata": {},      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}

Resolve an uncertain tool outcome POST

Record an explicit human decision for a tool request whose external effect could not be confirmed. The run remains paused until the durable keyed wake is consumed.

Create an artifact download URL POST

Return a short-lived download URL after artifact authorization.