Get bases

Describes ONE org's Base — whether its store exists, and what it occupies.

GET /v1/base/bases/{org}

Base → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/base/bases/{org}`
Method	`GET`
Operation	`get_base_bases_by_org`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Describes ONE org's Base — whether its store exists, and what it occupies.

The org must be one the caller's token carries; any other is not found, so this cannot be used to learn which orgs exist. That check is the same membership set the listing is built from, which is why the two can never disagree about what a caller may see.

Request

1 field.

Field	In	Type	Required	Description
`org`	path	string	yes	Org is the org whose Base to describe, from the path.

Response

Status	Body	Meaning
`200`	base.baseView	ok
`default`	problem-details	refused

200 body — 3 fields.

Field	In	Type	Always	Description
`bytes`	body	integer (int64)	—	Bytes is the store's size on disk, present only once it exists.
`exists`	body	boolean	—	Exists reports whether this Base's store has been provisioned.
`org`	body	string	—	Org is the org this Base belongs to.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo base bases get <org>

.ts

.py

.go

.rs

.java

import { Configuration, BaseApi } from 'hanzoai';

const api = new BaseApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getBaseBasesByOrg({ org: 'org' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import BaseApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = BaseApi(client).get_base_bases_by_org(org='org')

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

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

use hanzo_client::apis::{configuration::Configuration, base_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = base_api::get_base_bases_by_org(&cfg, Default::default()).await?;

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

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

var result = new BaseApi(client).getBaseBasesByOrg();

curl https://api.hanzo.ai/v1/base/bases/<org> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches base through the base tool, which names its 3 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_base_bases"
         }
       }
     }'

Base API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousResume runs NextList bases