Entitlement
Package entitlements is what your org may run: what the plan grants, and which of those products are switched on.
Package entitlements is what your org may run: what the plan grants, and which of those products are switched on.
| Base URL | https://api.hanzo.ai |
| Operations | 3 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Specification
Specification pending — no HIP in hanzoai/hips declares capability: entitlement yet. What this capability serves is below, from the API document; what it is — the store it owns, how it meters, what it publishes — is written as a HIP under HIP-0139.
Four surfaces
| Surface | Reaches this capability as | Coverage |
|---|---|---|
| REST | entitlement at its own prefix | 3 operations |
| CLI | hanzo entitlements … | 1 of 3 — the CLI pins the document on its own clock |
| SDK | — | no published client declares one yet — regenerating the clients is what adds them |
| MCP | tool entitlements on https://api.hanzo.ai/v1/mcp | 3 operations, 0 under the document's own id — ask describe for the rest |
Quickstart
export HANZO_API_KEY=sk-... # console.hanzo.ai → API keysThen the first call — a read that needs nothing but the key. GET /v1/entitlement, operation get_entitlement:
hanzo entitlements getimport { Configuration, EntitlementApi } from 'hanzoai';
const api = new EntitlementApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getEntitlement();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import EntitlementApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = EntitlementApi(client).get_entitlement()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.EntitlementAPI.GetEntitlement(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, entitlement_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = entitlement_api::get_entitlement(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.EntitlementApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new EntitlementApi(client).getEntitlement();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/entitlement \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches entitlement through the entitlements tool, which names its 3 operations with its own verbs — this one among them, under a name only the door 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_entitlements"
}
}
}'Answers 200 with object — ok.
Endpoints
| Endpoint | What it does |
|---|---|
GET /v1/entitlement/orgs/{org} | Get lists the products an org has ENABLED — its own intent, which the console's paid-product sidebar reads to decide what to show. |
POST /v1/entitlement/orgs/{org} | Post turns products on or off for an org and returns the enabled set afterwards. |
GET /v1/entitlement | Projection reports which console apps the CALLER's org may open, and the plan slug that decides it. |
How is this guide?