Sandbox API

Create isolated sessions, run commands, and manage files. Run commands synchronously, stream their output, or start background commands. Use the session ID to access files, command results, and the terminal. Use the file endpoints and terminal endpoint to work in the same session. Health, readiness, and heartbeat endpoints support session monitoring. See WebSocket connections for terminal WebSocket access. Sandbox Sessions · Sandbox Commands · Sandbox Files · Sandbox Terminal · Sandbox Health

Sandbox Sessions

Create, read, update, or delete sandbox sessions.

Endpoint	Methods	Description
`/sandbox-sessions`	GET, POST	List sandbox sessions; Create sandbox session
`/sandbox-sessions/{session_id}`	GET, PATCH, DELETE	Get sandbox session; Update sandbox session lifetime; Delete sandbox session
`/sandbox-sessions/{session_id}/environment`	GET	Get sandbox environment snapshot

Run commands and inspect command output.

Endpoint	Methods	Description
`/sandbox-sessions/{session_id}/commands`	GET, POST	List sandbox background commands; Start sandbox background command
`/sandbox-sessions/{session_id}/commands/{command_id}`	GET	Get sandbox background command
`/sandbox-sessions/{session_id}/commands/{command_id}/output`	GET	Get sandbox background command output
`/sandbox-sessions/{session_id}/commands/{command_id}/cancel`	POST	Cancel sandbox background command
`/sandbox-sessions/{session_id}/commands/run`	POST	Run sandbox command
`/sandbox-sessions/{session_id}/commands/stream`	POST	Stream sandbox command

List, read, or write sandbox files.

Endpoint	Methods	Description
`/sandbox-sessions/{session_id}/files`	GET, POST	List sandbox files; Write sandbox files
`/sandbox-sessions/{session_id}/file`	GET	Read sandbox file

Open a sandbox terminal.

Endpoint	Methods	Description
`/sandbox-sessions/{session_id}/terminal`	GET	Open sandbox terminal

Check sandbox health, readiness, and heartbeat state.

Endpoint	Methods	Description
`/sandbox-sessions/{session_id}/healthz`	GET	Check sandbox health
`/sandbox-sessions/{session_id}/readyz`	GET	Check sandbox readiness
`/sandbox-sessions/{session_id}/heartbeat`	POST	Update sandbox activity