<span id="根式嵌入模型后端列表"></span>

# List embedding backends through the root API

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

List embedding model backends readable in the current workspace.


```http
GET https://api.moi.matrixorigin.cn/v5/embedding/backends
```

<span id="调用前准备"></span>

## Before you call this API

Set `BASE_URL` to the product API prefix `https://api.moi.matrixorigin.cn/v5`; use the corresponding product API URL for a dedicated deployment.

[Configure identity, workspace, and object permissions in the same environment](objects.md#prepare).

<span id="请求"></span>

## Request

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

```bash
curl --request GET \
  "$BASE_URL/embedding/backends" \
  --header "X-API-Key: $MOI_KEY" \
  --header "X-Workspace-ID: $WORKSPACE_ID"
```

:::::
:::::{tab-item} Parameters

| Parameter | Location | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Workspace-ID` | Headers | string | Yes | Workspace ID in the same environment. |

No pagination or total. Returns data.backends; an empty result may be null. Lists filter by model_backend.read and are not the complete routing pool of system-default/deployed models.

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

<span id="成功响应"></span>

## Successful response

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

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "backends": [
      {
        "id": 12,
        "name": "临时后端",
        "type": "OPENAI",
        "timeout_seconds": 30,
        "models": [
          "bge-m3"
        ],
        "created_at": 1794445200,
        "updated_at": 1794445200,
        "reasoning_control_protocol": "REASONING_CONTROL_NONE",
        "endpoints": [
          {
            "id": 21,
            "backend_id": 12,
            "address": "https://provider.example.invalid/v1",
            "status": "ONLINE",
            "created_at": 1794445200,
            "updated_at": 1794445200
          },
          {
            "id": 22,
            "backend_id": 12,
            "address": "https://provider.example.invalid/v1",
            "status": "OFFLINE",
            "created_at": 1794445200,
            "updated_at": 1794445200
          }
        ]
      }
    ]
  }
}
```

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

HTTP 200。

| Field | Type | Description |
| --- | --- | --- |
| `code` | string | OK on success. |
| `msg` | string | OK on success. |
| `data` | object | [Actual objects for this protocol](objects.md#responses). |

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

<span id="错误响应"></span>

## Error responses

[Errors and result confirmation](objects.md#errors) distinguishes the two protocols. Parse omitted fields, SDK zero values, and empty HTTP responses separately. Confirm writes with the corresponding reads.
