Skip to main content
GET
Get session sandbox status

Authorizations

x-api-key
string
header
required

Query Parameters

sessionId
string
required

The id of the session whose sandbox status to read.

Response

Sandbox status retrieved successfully.

status
enum<string>
required

active when a non-expired sandbox is bound to the session; no_sandbox otherwise. The chat UI flips out of its loading state when this becomes active.

Available options:
active,
no_sandbox
hasSnapshot
boolean
required

True when a paused/snapshotted sandbox exists and can be resumed. Used by the UI to decide whether to show "resume" vs "create" affordances when status is no_sandbox.

lifecycleVersion
integer
required

Optimistic concurrency token for lifecycle transitions. Clients can pass this back to lifecycle-mutating endpoints to detect races.

lifecycle
object
required

Lifecycle envelope shared between GET /api/sandbox/status and GET /api/sandbox/reconnect. Server-clock-stamped snapshot of the sandbox's lifecycle FSM state and the timestamps the UI uses to render countdown timers.