# Entitlement

URL: https://docs.hanzo.ai/docs/openapi/entitlement

> What your org may run: what the plan grants, and which of those products are switched on.

Also for this capability: **API** · [CLI](https://docs.hanzo.ai/docs/cli/entitlement) · [SDKs](https://docs.hanzo.ai/docs/sdks)

What your org may run: what the plan grants, and which of those products are switched on.

> [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|                |                                        |
| -------------- | -------------------------------------- |
| **Base URL**   | `https://api.hanzo.ai`                 |
| **Operations** | 3                                      |
| **Auth**       | `Authorization: Bearer $HANZO_API_KEY` |

## Specification

Specification pending — no HIP in [hanzoai/hips](https://github.com/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 entitlement …`                               | 2 of 3 — the CLI pins the document on its own clock                       |
| **SDK**  | `EntitlementApi` in every published client          | 3 methods                                                                 |
| **MCP**  | tool `entitlement` on `https://api.hanzo.ai/v1/mcp` | 3 operations, 0 under the document's own id — ask `describe` for the rest |

## Quickstart

```bash
export HANZO_API_KEY=sk-...   # console.hanzo.ai → API keys
```

Then the first call — a read that needs nothing but the key. `GET /v1/entitlement`, operation `get_entitlement`:

**CLI**

```bash
hanzo entitlement get
```

**SDK**

**.ts**

```ts
import { Configuration, EntitlementApi } from 'hanzoai';

const api = new EntitlementApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getEntitlement();
```

**.py**

```python
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()
```

**.go**

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

resp, _, err := client.EntitlementAPI.GetEntitlement(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::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?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.EntitlementApi;

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

var result = new EntitlementApi(client).getEntitlement();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/entitlement \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP reaches **entitlement** through the `entitlement` 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:

```bash
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}`](https://docs.hanzo.ai/docs/openapi/entitlement/get-entitlement-orgs-by-org)   | 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}`](https://docs.hanzo.ai/docs/openapi/entitlement/post-entitlement-orgs-by-org) | Turns products on or off for an org and returns the enabled set afterwards.                                                    |
| [`GET /v1/entitlement`](https://docs.hanzo.ai/docs/openapi/entitlement/get-entitlement)                          | Reports which console apps the CALLER's org may open, and the plan slug that decides it.                                       |

---

[All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)