# 探测已配置大语言后端模型

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

需要指定后端的 model_backend.read。


```http
POST https://api.moi.matrixorigin.cn/v5/llm/backends/{backend_id}/probe-models
```

## 调用前准备

`BASE_URL` 使用产品 API 前缀 `https://api.moi.matrixorigin.cn/v5`；专有部署填写对应的产品 API 地址。

[配置同环境身份、工作区和模型信息](objects.md#prepare)。

## 请求

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
curl --request POST \
  "$BASE_URL/llm/backends/$BACKEND_ID/probe-models" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID" \
  --header "Content-Type: application/json" \
  --data-raw '{"api_key":"provider-key-example"}'
```

:::::
:::::{tab-item} 参数说明

| 参数 | 位置 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- | --- |
| `X-Workspace-ID` | 请求头 | string | 是 | 同环境工作区 ID。 |
| `api_key` | 请求体 | string | 是 | 本次提供商密钥，去掉前后空白后不能为空；不自动复用后端保存的密钥。 |
| `backend_id` | 路径 | integer | 是 | 正数后端 ID，由同类后端列表取得。 |

需要指定后端的 model_backend.read。读取经 DAO 筛选的在线候选首地址，不轮换其他候选；没有在线候选会失败。候选不自动写回后端模型清单，后续更新须独立操作。

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

## 成功响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "models": [
      "chat-example"
    ]
  }
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功为 OK。 |
| `data` | object | [模型、探测或设置结果](objects.md#response)。 |

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

## 错误响应

[状态与错误](objects.md#errors)区分字符串与数值协议；探测候选、保存与实际推理分别确认。
