List quota

Answers the caller's sandbox quota: the account it belongs to — the org, or a person in the signup org — how many of that account's paid sandboxes are running, and how many may run at once (-1 for no bound).

GET /v1/sandbox/quota

Addresshttps://api.hanzo.ai/v1/sandbox/quota
MethodGET
Operationget_sandbox_quota
AuthAuthorization: Bearer $HANZO_API_KEY

Answers the caller's sandbox quota: the account it belongs to — the org, or a person in the signup org — how many of that account's paid sandboxes are running, and how many may run at once (-1 for no bound). Staff set the quota per org or per plan; where they set none it is 100.

Request

GET /v1/sandbox/quota takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200sandbox.Quotaok
defaultproblem-detailsrefused

200 body — 3 fields.

FieldInTypeAlwaysDescription
accountbodystring—Account is the account the quota belongs to: the org, or a person in the signup org.
quotabodyinteger (int64)—Quota is how many it may hold at once; -1 for no bound.
runningbodyinteger (int64)—Running is how many of its paid sandboxes hold a pod now.

Failure carries the platform error shape — see Errors.

Examples

hanzo sandbox quota
import { Configuration, SandboxApi } from 'hanzoai';

const api = new SandboxApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getSandboxQuota();
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_quota()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.SandboxAPI.GetSandboxQuota(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_quota(&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).getSandboxQuota();

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/quota \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool sandbox, op get_sandbox_quota — 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_quota",
           "input": {}
         }
       }
     }'

Sandbox API · All Hanzo APIs · Interactive reference

Was this page useful?
Broken link or missing step? Drop it in #docs on Discord or open a PR.