Sandbox
Package sandbox is the ONE compute primitive: a sandbox is a gVisor pod that runs somebody else's code, and every lifetime is the same object.
Package sandbox is the ONE compute primitive: a sandbox is a gVisor pod that runs somebody else's code, and every lifetime is the same object.
| Base URL | https://api.hanzo.ai |
| Operations | 19 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Specification
Specification pending — no HIP in hanzoai/hips declares capability: sandbox yet. What this capability serves is below, from the API document; what it is — the store it owns, how it meters, what it publishes — is written as a HIP under HIP-0139.
Four surfaces
| Surface | Reaches this capability as | Coverage |
|---|---|---|
| REST | sandbox at its own prefix | 19 operations |
| CLI | hanzo sandboxes … | 19 of 19 |
| SDK | SandboxApi in every published client | 6 of 19 — the clients are generated at their own release |
| MCP | tool sandboxes on https://api.hanzo.ai/v1/mcp | 19 operations, 7 under the document's own id — ask describe for the rest |
Quickstart
export HANZO_API_KEY=sk-... # console.hanzo.ai → API keysThen the first call — a read that needs nothing but the key. GET /v1/sandbox, operation get_sandbox:
hanzo sandboxes listimport { Configuration, SandboxApi } from 'hanzoai';
const api = new SandboxApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getSandbox();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import SandboxApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = SandboxApi(client).get_sandbox()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.SandboxAPI.GetSandbox(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, sandbox_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = sandbox_api::get_sandbox(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.SandboxApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new SandboxApi(client).getSandbox();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/sandbox \
-H "Authorization: Bearer $HANZO_API_KEY"Tool sandboxes, op get_sandbox — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "sandboxes",
"arguments": {
"op": "get_sandbox",
"input": {}
}
}
}'Endpoints
| Endpoint | What it does |
|---|---|
POST /v1/sandbox/{id}/exec | Run a command in a sandbox |
GET /v1/sandbox/{id}/fs | Read a file, or list a directory |
POST /v1/sandbox/{id}/fs | Write a file |
POST /v1/sandbox/{id}/screen/ticket | Open a screen |
GET /v1/sandbox/{id}/screen/ws | The screen, as a socket |
GET /v1/sandbox/{id}/screen | The screen, as a page |
POST /v1/sandbox/{id}/terminal/ticket | Open a terminal |
GET /v1/sandbox/{id}/terminal/ws | The terminal, as a socket |
GET /v1/sandbox/{id}/terminal | The terminal, as a page |
GET /v1/sandbox/{id} | One sandbox |
DELETE /v1/sandbox/{id} | End a sandbox |
POST /v1/sandbox/end | End a sandbox and release it |
POST /v1/sandbox/lease | Lease a sandbox — a real computer — or resume one you hold |
POST /v1/sandbox/read | Read a file from a sandbox you hold |
POST /v1/sandbox/run | Run a command in a sandbox you hold and read its output |
POST /v1/sandbox/stop | Stop what a sandbox is running, and keep the sandbox |
POST /v1/sandbox/write | Write a file into a sandbox you hold |
GET /v1/sandbox | The sandboxes this org holds |
POST /v1/sandbox | Lease a sandbox |
How is this guide?