Create read

Reads one path in the caller's sandbox: a file's bytes, or a directory's entries when the path names one.

POST /v1/sandbox/read

Sandbox → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/sandbox/read`
Method	`POST`
Operation	`read_sandbox_file`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reads one path in the caller's sandbox: a file's bytes, or a directory's entries when the path names one.

Request

2 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	body	string	—	ID is the sandbox to read from, from an earlier lease.
`path`	body	string	—	Path is read relative to the sandbox's working directory unless it is absolute, and a path that climbs out of it is refused rather than rewritten.

Response

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

200 body — 4 fields.

Field	In	Type	Always	Description
`data`	body	string	—	Data is the file's bytes, verbatim, base64 on the wire.
`dir`	body	boolean	—	Dir says which of the two answers this is: true and the path is a directory, so read Entries; false and it is a file, so read Data.
`entries`	body	string[]	—	Entries is a directory's contents as bare NAMES, not paths — one level, no recursion, dotfiles included, "." and ".." excluded (`ls -1A`).
`path`	body	string	—	Path is the RESOLVED absolute path that was read — the caller's relative path joined onto the sandbox's working directory (Leased.Workdir), so it names the same file for a reader who does not know the class.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo sandbox read

.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.readSandboxFile({ id: "<id>", path: "<path>" });

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).read_sandbox_file(id="<id>", path="<path>")

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

resp, _, err := client.SandboxAPI.ReadSandboxFile(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::read_sandbox_file(&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).readSandboxFile();

curl -X POST https://api.hanzo.ai/v1/sandbox/read \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "id": "<id>",
       "path": "<path>"
     }'

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

Sandbox API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate sandbox NextRun sandbox