> For the complete documentation index, see [llms.txt](https://docs.uptiq.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.uptiq.ai/cookbooks/platform-admin/models/enable-a-model-family.md).

# Enable a model family

Turn on a model family and assign its Economy, Smart, and Premium tiers.

`POST /model-families` creates the family and can set its tier assignments in the same call. This is the API equivalent of [Enable a model family](https://docs.uptiq.ai/platform-guides/admin/models/enable-a-model-family).

## At a glance

| Item            | Value                                           |
| --------------- | ----------------------------------------------- |
| ⚙️ Microservice | `Identity Hub`                                  |
| 🌍 Environment  | `QA`                                            |
| 🔗 Base URL     | `https://api-builder-qa.uptiq.dev/identity-hub` |
| ⌘ Endpoint      | `POST /model-families`                          |

{% columns %}
{% column %}

#### What it does

Creates a model family and assigns its routing tiers.
{% endcolumn %}

{% column %}

#### Success looks like

The service returns `201 Created` and the model family ID.
{% endcolumn %}
{% endcolumns %}

{% hint style="warning" %}
**This decides where inference runs.** Read [AI models and data](https://docs.uptiq.ai/platform-guides/security-and-compliance/ai-models-and-data) before choosing a provider if data residency matters — the same caution the UI task states.
{% endhint %}

## Before you start

* Your API key needs the **Configure the AI Gateway** capability (`ConfigureAIGateway`).
* Decide the tier assignments — which model serves Economy, Smart and Premium — before calling this, and confirm any model you name in `defaultTiers` has already been registered with `POST /model-families/{id}/models` (see Notes) or the call will reference a model that doesn't exist yet.

## Request

`POST /model-families`

| Field                 | Type   | Required | What it does                                                                         |
| --------------------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| `name`                | string | Yes      | The routing key accounts configure against — e.g. `anthropic`.                       |
| `displayName`         | string | Yes      | Shown in Control Center.                                                             |
| `description`         | string | No       |                                                                                      |
| `defaultTiers`        | object | No       | `{ "economy": "<model name>", "smart": "<model name>", "premium": "<model name>" }`. |
| `openRouterReasoning` | object | No       | Reasoning-effort configuration when routing through OpenRouter.                      |

## Code snippets

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X POST https://api-builder-qa.uptiq.dev/identity-hub/model-families \
  -H "x-platform-key: YOUR_API_KEY" \
  -H "accountid: YOUR_ACCOUNT_ID" \
  -H "content-type: application/json" \
  -d '{
    "name": "anthropic",
    "displayName": "Anthropic",
    "defaultTiers": {
      "economy": "claude-haiku-4-5",
      "smart": "claude-sonnet-4-5",
      "premium": "claude-opus-4-1"
    }
  }'
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
const res = await fetch("https://api-builder-qa.uptiq.dev/identity-hub/model-families", {
  method: "POST",
  headers: {
    "x-platform-key": process.env.UPTIQ_API_KEY,
    accountid: process.env.UPTIQ_ACCOUNT_ID,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    name: "anthropic",
    displayName: "Anthropic",
    defaultTiers: {
      economy: "claude-haiku-4-5",
      smart: "claude-sonnet-4-5",
      premium: "claude-opus-4-1",
    },
  }),
});
const { data } = await res.json();
```

{% endtab %}

{% tab title="Python" %}

```python
import os, requests

res = requests.post(
    "https://api-builder-qa.uptiq.dev/identity-hub/model-families",
    headers={
        "x-platform-key": os.environ["UPTIQ_API_KEY"],
        "accountid": os.environ["UPTIQ_ACCOUNT_ID"],
    },
    json={
        "name": "anthropic",
        "displayName": "Anthropic",
        "defaultTiers": {
            "economy": "claude-haiku-4-5",
            "smart": "claude-sonnet-4-5",
            "premium": "claude-opus-4-1",
        },
    },
)
family = res.json()["data"]
```

{% endtab %}
{% endtabs %}

## Response

| Result          | What it means                                                  | Next action                                    |
| --------------- | -------------------------------------------------------------- | ---------------------------------------------- |
| ✅ `201 Created` | `data` contains the family ID and `message` confirms creation. | Use the ID to register models with the family. |

## Developer notes

| Situation                      | What to do                                                                                                                                                           |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Register a model               | Call `POST /model-families/{id}/models` before referencing a new model in `defaultTiers`. The request needs `name`, `modelName`, `description`, and `prices`.        |
| Avoid duplicate tier routing   | Check [model availability](/cookbooks/platform-admin/models/check-model-availability.md) after saving. The API accepts the same model for two tiers without warning. |
| Configure provider credentials | Set provider authentication separately. See [Configure your own provider key](/cookbooks/platform-admin/models/use-your-own-provider-key.md).                        |

## Related

* [Enable a model family](https://docs.uptiq.ai/platform-guides/admin/models/enable-a-model-family) — as a screen
* [Configure your own provider key](/cookbooks/platform-admin/models/use-your-own-provider-key.md)
* [Check model availability](/cookbooks/platform-admin/models/check-model-availability.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.uptiq.ai/cookbooks/platform-admin/models/enable-a-model-family.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.