# Get model health

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

Get aggregate model health and the latest channel check results.

```text
GET https://billing.moi.matrixorigin.cn/api/v1/taas/ai-models/{id}/health
```

## Before you begin

1. Prepare a personal access token. For creation and management, see [Manage personal access tokens](../../../../../guides/billing/credentials.md#personal-access-token).
2. Select a model from [List the model catalog](list-models.md).

Results are scoped to data accessible to the current user.

## Request example

Replace `$MOI_PERSONAL_ACCESS_TOKEN` and `$MODEL_ID` with your personal access token and the selected catalog model’s ID.

```bash
curl --get "https://billing.moi.matrixorigin.cn/api/v1/taas/ai-models/$MODEL_ID/health" \
  -H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"
```

## Path parameters

::::{div} mo-api-parameter-table

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The selected catalog model’s ID, from `items[].id` in the model catalog response. |

::::

## Successful response

Returns HTTP `200` with the model’s overall health and channel check results.

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} Response example

```json
{
  "overall_status": "healthy",
  "details": [
    {
      "provider_id": "provider_example",
      "provider_native_model_id": "native_example",
      "provider_native_model_name": "example-chat",
      "target_id": "target_example",
      "status": "healthy",
      "latency_ms": 120,
      "checked_at": 1788710400,
      "error_message": ""
    }
  ]
}
```

:::::
:::::{tab-item} Fields

| Field | Type | Description |
| --- | --- | --- |
| `overall_status` | string | Aggregate model health status. |
| `details` | array of object | Channels with recorded checks; empty when none exist. |
| `details[].provider_id` | string | Provider ID for the channel. |
| `details[].provider_native_model_id` | string | Provider-native model object ID. |
| `details[].provider_native_model_name` | string | Provider-native model name. |
| `details[].target_id` | string | Health-check target ID. |
| `details[].status` | string | Check status. |
| `details[].latency_ms` | integer | Check `latency` in milliseconds. |
| `details[].checked_at` | integer | Check time, Unix seconds. |
| `details[].error_message` | string | Check error description; empty when no error. |

In field paths, `[]` denotes each array item.

:::::
::::::
:::::::