OpenapiSandbox
Create ticket
Mints a short-lived grant to open a terminal on a sandbox.
POST /v1/sandbox/{id}/terminal/ticket
| Address | https://api.hanzo.ai/v1/sandbox/{id}/terminal/ticket |
| Method | POST |
| Operation | post_sandbox_by_id_terminal_ticket |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Mints a short-lived grant to open a terminal on a sandbox.
The ticket travels in the query string of the URL it answers with, because a browser cannot set an Authorization header on a WebSocket handshake. It is single-purpose and short-lived for exactly that reason. A sandbox that is not running is 409 rather than a ticket that cannot be used.
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 |
|---|---|---|
201 | ticketGrant | created |
201 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
expiresIn | body | integer | — | ExpiresIn is how long the ticket is good for, in seconds. |
ticket | body | string | — | Ticket is the grant itself. It is single-purpose and short-lived, and it travels in a query string because a WebSocket handshake carries no Authorization… |
url | body | string | — | URL is the PATH to open, ticket included — not an absolute URL. |
Failure carries the platform error shape — see Errors.
Examples
hanzo sandbox terminal ticket <id>import { Configuration, SandboxApi } from 'hanzoai';
const api = new SandboxApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postSandboxByIdTerminalTicket({ 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).post_sandbox_by_id_terminal_ticket(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.SandboxAPI.PostSandboxByIdTerminalTicket(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::post_sandbox_by_id_terminal_ticket(&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).postSandboxByIdTerminalTicket();curl -X POST https://api.hanzo.ai/v1/sandbox/<id>/terminal/ticket \
-H "Authorization: Bearer $HANZO_API_KEY"MCP reaches sandbox through the sandboxes tool, which names its 19 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_sandboxes"
}
}
}'How is this guide?