Get sandbox

Returns one sandbox: its class, project, image, the runtime it was given, its status and when its lease ends.

GET /v1/sandbox/{id}

Sandbox → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/sandbox/{id}`
Method	`GET`
Operation	`get_sandbox_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns one sandbox: its class, project, image, the runtime it was given, its status and when its lease ends.

A sandbox is its lessee's and its org admins'. An id the caller does not hold — another org's, or another member's — is the same 404 an unknown id gives.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the sandbox to address, from the path.

Response

Status	Body	Meaning
`200`	sandbox.Sandbox	ok
`default`	problem-details	refused

200 body — 16 fields.

Field	In	Type	Always	Description
`actor`	body	string	—	Actor is the subject who LEASED this sandbox — the validated caller of the act that took the lease, never a value a request supplied.
`class`	body	string	—	Class is what the sandbox is FOR, and it decides the image, the working directory and the isolation: "exec" for a code-interpreter call (workdir /mnt/data, no project, bounded per org), "dev" for a workspace bound to a project (workdir /work, single-attach), "desktop" for one with a screen.
`cluster`	body	string	—	Cluster is the attached cluster this sandbox runs on — the fleet-local name the lease named — or empty for the home cluster.
`connectedAt`	body	integer (int64)	—	ConnectedAt is when somebody was last known to have this sandbox's project OPEN, Unix seconds.
`createdAt`	body	integer (int64)	—	CreatedAt is when the lease was taken, Unix seconds — by the lease that made the sandbox, and again by each resume, which gives a parked sandbox a new pod on a new lease.
`error`	body	string	—	Error is why the sandbox could not come up, in plain words.
`expiresAt`	body	integer (int64)	—	ExpiresAt is when the lease ends, Unix seconds.
`id`	body	string	—	ID is the sandbox's server-minted handle and what every operation addresses it by.
`image`	body	string	—	Image is the container image this sandbox is actually running — the one the class chose, or an override the policy admitted.
`kind`	body	string	—	Kind is the resource family this row belongs to.
`lastUsedAt`	body	integer (int64)	—	LastUsedAt is when the sandbox last did work, Unix seconds.
`org`	body	string	—	Org is the org that holds the lease — the validated caller's, never a value a request supplied.
`project`	body	string	—	Project is the project this sandbox is bound to.
`runtime`	body	string	—	Runtime is the isolation boundary this sandbox GOT, which is not always the one it asked for: a caller states a preference and runtimeFor answers with what the sandbox can actually have.
`status`	body	string	—	Status is where the sandbox is in its life: "pending" while the pod is coming up, "running" once it can take work, "error" when it cannot, and "parked" when its pod is stopped and its disk kept, until a resume.
`volume`	body	string	—	Volume is the persistent volume attached to the sandbox, when it has one.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo sandbox get <id>

.ts

.py

.go

.rs

.java

import { Configuration, SandboxApi } from 'hanzoai';

const api = new SandboxApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getSandboxById({ id: 'id' });

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_by_id(id='id')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.SandboxAPI.GetSandboxById(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::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_by_id(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.SandboxApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new SandboxApi(client).getSandboxById();

curl https://api.hanzo.ai/v1/sandbox/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool sandbox, op get_sandbox_by_id — 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": "sandbox",
         "arguments": {
           "op": "get_sandbox_by_id",
           "input": {
             "id": "<id>"
           }
         }
       }
     }'

Sandbox API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList terminal NextList sandbox