> 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/check-model-availability.md).

# Check model availability

Confirm a model is usable, per provider, before an agent depends on it.

`GET /ai-gateways/model-catalog` returns every enabled model family with its models and their availability per provider. This is the API equivalent of [Check model availability](https://docs.uptiq.ai/platform-guides/admin/models/check-model-availability).

## At a glance

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

{% columns %}
{% column %}

#### What it does

Lists enabled model families and provider availability.
{% endcolumn %}

{% column %}

#### Success looks like

The service returns `200 OK` with matching catalog entries.
{% endcolumn %}
{% endcolumns %}

## Before you start

Your API key needs the **Use the AI Gateway** capability (`ConsumeAIGateway`) — distinct from **Configure the AI Gateway**, which [Enable a model family](/cookbooks/platform-admin/models/enable-a-model-family.md) needs.

## Request

`GET /ai-gateways/model-catalog`

| Parameter     | Where | Required | What it does                            |
| ------------- | ----- | -------- | --------------------------------------- |
| `family`      | query | No       | Narrow to one family, e.g. `anthropic`. |
| `status`      | query | No       | Filter by availability status.          |
| `search`      | query | No       | Free-text match.                        |
| `searchMatch` | query | No       | Matching mode for `search`.             |

## Code snippets

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

```bash
curl "https://api-builder-qa.uptiq.dev/identity-hub/ai-gateways/model-catalog?family=anthropic" \
  -H "x-platform-key: YOUR_API_KEY" \
  -H "accountid: YOUR_ACCOUNT_ID"
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
const res = await fetch(
  "https://api-builder-qa.uptiq.dev/identity-hub/ai-gateways/model-catalog?family=anthropic",
  {
    headers: {
      "x-platform-key": process.env.UPTIQ_API_KEY,
      accountid: process.env.UPTIQ_ACCOUNT_ID,
    },
  }
);
const { data } = await res.json();
```

{% endtab %}

{% tab title="Python" %}

```python
import os, requests

res = requests.get(
    "https://api-builder-qa.uptiq.dev/identity-hub/ai-gateways/model-catalog",
    params={"family": "anthropic"},
    headers={
        "x-platform-key": os.environ["UPTIQ_API_KEY"],
        "accountid": os.environ["UPTIQ_ACCOUNT_ID"],
    },
)
catalog = res.json()["data"]
```

{% endtab %}
{% endtabs %}

## Response

| Result     | What it means                                                              | Next action                                      |
| ---------- | -------------------------------------------------------------------------- | ------------------------------------------------ |
| ✅ `200 OK` | `data` lists enabled families, their models, and availability by provider. | Check the provider status for your target model. |

{% hint style="warning" %}
**An account with no configured model families returns `data: []`, not an error.** Verified against QA on 22 September 2026:

```json
{ "message": "Model catalog retrieved", "data": [] }
```

An empty array means "nothing configured here", which is indistinguishable from "your filter matched nothing". Check without the `family` filter before concluding a specific family is missing, and see *If a model shows unavailable* below.
{% endhint %}

## If a model shows unavailable

Same order the UI task recommends:

1. Is the family created at all? `GET /model-families` lists every family in the account. **Verified against QA: this returns `403 UNAUTHORIZED` and is not reachable with any account-level credential.** It was retested with a user session token holding all five account roles (Organisation Admin, Developer, Governance Manager, Auditor, Account Admin) and all 36 scopes — still `403`. No `model-families` permission exists in the `permissions` enum of [Create an API key](/cookbooks/platform-admin/programmatic-access/issue-an-api-key.md) either. Treat this as a platform-operator endpoint and check the family in Control Center instead.
2. Is a provider authenticated for it? Check [Configure your own provider key](/cookbooks/platform-admin/models/use-your-own-provider-key.md) was actually called for that provider — a family with no key set for any provider has nothing to serve requests with.
3. Was the tier assignment saved? Re-check `defaultTiers` on the family record.

## Developer notes

| Situation                     | What to do                                                                                                                                                                                    |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data` is empty               | Remove the `family` filter before deciding a family is missing. An unconfigured account and an unmatched filter both return `data: []`.                                                       |
| A model shows unavailable     | Follow the troubleshooting sequence above: check the family, provider credential, and tier assignment.                                                                                        |
| A model fails while available | Investigate the execution. This endpoint reports configuration, not live provider health. See [Investigate an agent run](/cookbooks/platform-admin/agents-and-evidence/investigate-a-run.md). |

## Related

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