API reference
Every endpoint of the sandbox API. Base URL https://sandbox-as-a-service.com/v1, bearer auth with an
API key from your dashboard. The machine-readable spec is at
/openapi.json; the explorer below is generated from it.
| Endpoint | What it does |
|---|---|
POST /v1/sandboxes | Create a sandbox |
GET /v1/sandboxes | List sandboxes |
PARAMETERS /v1/sandboxes/{id} | |
GET /v1/sandboxes/{id} | Get a sandbox |
DELETE /v1/sandboxes/{id} | Destroy a sandbox |
PARAMETERS /v1/sandboxes/{id}/exec | |
POST /v1/sandboxes/{id}/exec | Run a command |
POST /v1/sandboxes/{id}/ports | Expose a port on a public preview URL |
GET /v1/sandboxes/{id}/ports | List the preview URLs open on a sandbox |
DELETE /v1/sandboxes/{id}/ports/{port} | Close a preview URL |
PARAMETERS /v1/sandboxes/{id}/files | |
PUT /v1/sandboxes/{id}/files | Write a file |
GET /v1/sandboxes/{id}/files | Read a file or list a directory |
DELETE /v1/sandboxes/{id}/files | Delete a file or directory |
PARAMETERS /v1/sandboxes/{id}/extend | |
POST /v1/sandboxes/{id}/extend | Extend a sandbox lifetime |
PARAMETERS /v1/executions/{id} | |
GET /v1/executions/{id} | Get an execution result |
GET /v1/usage | Get usage summary |
GET /v1/account | Get account details |
Quickstart · Lifecycle · Running commands · Files · Errors · MCP server · Pricing