Hanzo AI
OpenapiBase

Get bases

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

GET /v1/base/bases/{org}

Addresshttps://api.hanzo.ai/v1/base/bases/{org}
MethodGET
Operationget_base_bases_by_org
AuthAuthorization: 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.

FieldInTypeRequiredDescription
orgpathstringyesOrg is the org whose Base to describe, from the path.

Response

StatusBodyMeaning
200baseViewok

200 body — 3 fields.

FieldInTypeAlwaysDescription
bytesbodyintegerBytes is the store's size on disk, present only once it exists.
existsbodybooleanExists reports whether this Base's store has been provisioned.
orgbodystringOrg is the org this Base belongs to.

Failure carries the platform error shape — see Errors.

Examples

hanzo base bases get <org>

Base API · All Hanzo APIs · Interactive reference

How is this guide?

On this page