# 探测嵌入模型

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

需要当前工作区 regular 访问级别。


```http
POST https://api.moi.matrixorigin.cn/v5/embedding/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/embedding/probe-models" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID" \
  --header "Content-Type: application/json" \
  --data-raw '{"address":"https://provider.example.invalid/v1","api_key":"provider-key-example"}'
```

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

| 参数 | 位置 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- | --- |
| `X-Workspace-ID` | 请求头 | string | 是 | 同环境工作区 ID。 |
| `address` | 请求体 | string | 是 | 提供商 API 根地址，产品去掉前后空白后追加 /models。 |
| `api_key` | 请求体 | string | 否 | 提供商模型列表凭据；可省略用于无需密钥的服务，与 MOI_KEY 分开。 |

需要当前工作区 regular 访问级别。会向提供商发送 GET /models，带密钥时使用 Bearer；不会创建后端。按名称模式区分 LLM/Embedding，不能证明真实能力，重复候选不保证合并。服务未返回 200、响应无效或超过大小限制均失败。

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

## 成功响应

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

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "models": [
      "bge-m3"
    ]
  }
}
```

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

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

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

## 错误响应

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