Read sandbox CPU, memory, and GPU usage for a session tree
Returns the tree’s sandbox attachments and one page of per-minute resource usage buckets for them, ordered by attachment then time. Each bucket carries the minute’s average and peak; resolution=raw adds the individual samples as parallel arrays indexed by offsetsMs. A tree whose compute was released and revived has several attachments; follow revivedFromSandboxId to connect them. live reports whether a sandbox is still attached, which is the cue to keep polling. An empty sandboxes list means the tree never ran in a sandbox or sampling is disabled; an attachment with samplingSource=unsupported means the sandbox could not measure itself.
Authorizations
A Recursion API key, created in the console under API keys.
Headers
Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.
1Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.
1Path Parameters
Any session id (UUID) in the tree. The sandbox is shared by the whole tree, so every id in it returns the same usage.
Query Parameters
Inclusive lower bound on bucketStartedAt, RFC 3339. Omit for the start of the tree.
Exclusive upper bound on bucketStartedAt, RFC 3339. Omit for now.
minute returns per-minute summaries only; raw also includes each bucket's per-sample arrays at the producer's cadence (five seconds by default). Use raw for the window on screen and minute for the overview.
minute, raw Maximum buckets per page, across all of the tree's sandbox attachments.
1 <= x <= 720Signed continuation token from a previous page's nextCursor. Bound to the organization, session, and filters it was issued for.
Response
OK
RFC 3339 server time at which the page was read.
One page of minute buckets ordered by (sandbox_id, bucket_start). Each bucket names its attachment; join on sandboxes to place it on a lane.
True while a sandbox that can be sampled is still attached to the tree. A client keeps polling while this is true and stops once it turns false; an attached sandbox that cannot measure itself does not keep it true.
Cursor for the next page, or null on the last page.
Resolution the buckets were read at.
minute, raw Root of the tree the usage belongs to.
Every sandbox attachment the tree has had, oldest first, including ones that have since been released or closed. Empty when the tree never had a sandbox or sampling is disabled. Complete on every page.
Session id named in the request.
Total matching buckets when known; null when the snapshot cannot count them cheaply.
0 <= x <= 9007199254740991