Returns the entitlement key vocabulary: every key with its namespace, JSON…
Returns the entitlement key vocabulary: every key with its namespace, JSON type, nullability, unit, enum and title, the list of namespaces, and the engine…
GET /v1/plan/vocab
| Address | https://api.hanzo.ai/v1/plan/vocab |
| Method | GET |
| Operation | get_plan_vocab |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the entitlement key vocabulary: every key with its namespace, JSON type, nullability, unit, enum and title, the list of namespaces, and the engine features a license can grant. It is derived from entitlements.schema.json on every call, so it cannot fall behind the schema.
Request
GET /v1/plan/vocab takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | planVocab | ok |
200 body — 4 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
engine_features | body | string[] | — | EngineFeatures are the inference-engine capabilities a license can grant: inference, embeddings, rerank, training, vision, audio, tools. |
keys | body | object | — | Keys maps every entitlement key to its descriptor — key, namespace, JSON type(s), nullability, unit, enum and title, as the schema declares them. |
keys.* | body | any | — | |
namespaces | body | string[] | — | Namespaces are the entitlement key namespaces: the prefix before the dot in "ai.tokens_per_min". |
Failure carries the platform error shape — see Errors.
Examples
hanzo plans vocabimport { Configuration, PlanApi } from 'hanzoai';
const api = new PlanApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPlanVocab();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PlanApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PlanApi(client).get_plan_vocab()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.PlanAPI.GetPlanVocab(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, plan_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = plan_api::get_plan_vocab(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PlanApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new PlanApi(client).getPlanVocab();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/plan/vocab \
-H "Authorization: Bearer $HANZO_API_KEY"Tool plan, op get_plan_vocab — 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": "plan",
"arguments": {
"op": "get_plan_vocab",
"input": {}
}
}
}'How is this guide?