Skip to main content
The full interactive API reference is available in the API Reference tab.

​
Base URL & Authentication

All API requests go through the control plane: The control plane handles sandbox lifecycle (create, list, kill, hibernate, wake) and transparently proxies data-plane requests (exec, files, agents, PTY) to the worker that owns the sandbox. SDK users only need the API key.

​
WebSocket Binary Protocol

Exec and PTY WebSocket sessions use binary frames with a 1-byte stream prefix: Connection flow:
  1. Client opens WebSocket with ?api_key=<key>
  2. Server replays scrollback buffer (historical output)
  3. Server sends 0x04 to mark end of scrollback
  4. Live output streams as 0x01/0x02 frames
  5. When the process exits, server sends 0x03 with the exit code
  6. Server closes the connection
Sending input: Prefix your data with 0x00 and send as a binary frame. PTY sessions use the same binary framing but without stream prefixes — raw bidirectional terminal data.

​
Error Format

All errors use a consistent envelope: