레퍼런스HTTP APISessions

Files the session left under out/ at its latest checkpoint

GET
/v1/sessions/{id}/outputs

Lists the files under the workspace's out/ directory as the session's latest committed checkpoint recorded them: path (relative to the workspace, starting with out/), bytes and sha256. A file over the output limits is listed with omitted: too_large and sha256: null; its bytes were not kept, so it cannot be downloaded. A file written after the latest checkpoint is not listed until the next one commits. A session with no committed checkpoint answers an empty list with checkpoint_revision: null. Download a listed file with GET /v1/sessions/{id}/outputs/{path}. Reading changes nothing.

Scope: sessions:read (API key or cookie session).

Authorization

headerAuthorizationBearer <token>

For servers and scripts: an API key sent as an HTTP bearer token, Bearer <key>. It holds exactly the scopes it was issued with; a key issued before scopes existed holds none. It never needs the CSRF header, and it cannot manage agents, members, teams or API keys. Issue one in the web console under Settings → API keys; each operation names the scope it needs.

Scope: sessions:read

Path Parameters

id*string

The session's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

The outputs of the session's latest committed checkpoint.

application/json
  1. response
session_id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
checkpoint_revision*|null
items*array<>
Example Request
curl -X GET 'https://example.com/v1/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/outputs'
Example Response
{  "session_id": "0f8b6a52-3d1e-4c7a-9b2f-5e6d7c8a9b01",  "checkpoint_revision": 2,  "items": [    {      "path": "out/report.md",      "bytes": 2048,      "sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",      "omitted": null    },    {      "path": "out/recording.mp4",      "bytes": 734003200,      "sha256": null,      "omitted": "too_large"    }  ]}