Skip to main content
The sandbox API creates and manages isolated microVM sandboxes. The prime CLI and the prime_sandboxes Python SDK call the same endpoints. Base URL: https://api.primeintellect.ai/api/v1/sandbox

Authentication

Send a Prime API key as a bearer token. The key needs the sandbox scope. Create or check a key in API keys.
Team scoping is per endpoint. team_id is a query parameter on list endpoints and on volume get, resize, and delete; create endpoints take it in the request body. Routes addressed by sandbox, checkpoint, or network ID take the team from the resource.

Create and poll a sandbox

Creation is asynchronous. The response contains the sandbox id and an initial status. Poll GET /api/v1/sandbox/{sandbox_id} until the status is RUNNING, or use POST /api/v1/sandbox/status:batchGet for several sandboxes at once.

Endpoint groups

Batch lookups use POST endpoints with a colon suffix, such as /status:batchGet and /checkpoints:batchGet. Send the IDs in the JSON body.

Errors

HTTP errors return {"detail": "<message>"}. Validation errors return an errors array; each item has param and details string fields. Not every endpoint returns every code. The endpoint reference lists each operation’s success and validation responses.

Lifecycle

Resources, timeouts, labels, and deletion

Pause and resume

Keep memory and disk in place between runs

Checkpoints

Save, restore, and fork a sandbox

Volumes

Persistent storage and publishing

Network isolation

Allow or deny outbound traffic

Private networks

Sandbox-to-sandbox connectivity and public ports