Skip to main content
GET
Read sandbox CPU, memory, and GPU usage for a session tree

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Path Parameters

session_id
string<uuid>
required

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

from
string<date-time>

Inclusive lower bound on bucket_start, RFC 3339. Omit for the start of the tree.

to
string<date-time>

Exclusive upper bound on bucket_start, RFC 3339. Omit for now.

resolution
enum<string>
default:minute

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.

Available options:
minute,
raw
limit
integer
default:120

Maximum buckets per page, across all of the tree's sandbox attachments.

Required range: 1 <= x <= 720
page_token
string

Signed continuation token from a previous page's next_page_token. Bound to the organization, session, and filters it was issued for.

Response

Sandbox CPU, memory, and accelerator usage for a session tree, as minute buckets per sandbox attachment. Samples are what the sandbox measured of itself, collected on tool calls and on read.

Sandbox CPU, memory, and accelerator usage for a session tree, as minute buckets per sandbox attachment. Samples are what the sandbox measured of itself, collected on tool calls and on read.

as_of
string<date-time>
required

RFC 3339 server time at which the page was read.

buckets
object[]
required

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.

live
boolean
required

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.

resolution
enum<string>
required

Resolution the buckets were read at.

Available options:
minute,
raw
root_session_id
string
required

Root of the tree the usage belongs to.

sandboxes
object[]
required

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
string
required

Session id named in the request.

next_page_token
string

Present when more buckets remain. Pass as page_token with the same query to continue.