Sign in

v2

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-0912817.8 KB
Sandboxes

Create a new sandbox

Creates a sandbox and returns immediately with status: starting. The VM boots asynchronously. Poll GET /sandboxes/{id} until status is active before running commands.

post/sandboxes

Request body

namestring required

Human-readable name for the sandbox.

from_snapshotstring uuid

If provided, boot the sandbox from this snapshot instead of creating a fresh VM. The snapshot must belong to the same team.

Example request

{
  "network": {
    "allow_out": [
      "api.openai.com",
      "*.github.com",
      "8.8.8.8/32"
    ],
    "deny_out": [
      "0.0.0.0/0"
    ]
  }
}

Response

Sandbox created

idstring uuid
namestring
status'starting' | 'active' | 'pausing' | 'idle' | 'deleted'
vcpu_countinteger
memory_mibinteger
ip_addressstring

IP address of the running VM (present when status is active).

snapshot_idstring uuid

ID of the latest snapshot (present after a pause).

created_atstring date-time