# List routed models

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

Combines currently readable Workspace declarations with system/deployment models allowed by the permission scope.


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

## Before you call this API

Set `BASE_URL` to the product API prefix `https://api.moi.matrixorigin.cn/v5`. For private deployments, use the corresponding product API URL.

[Configure identity, Workspace, and model information in the same environment](objects.md#prepare).

## Request

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

```bash
curl --request GET \
  "$BASE_URL/models" \
  --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. |
| `type` | Queries | string | No | Defaults to chat. Supports chat/vision/ocr/reasoning/embedding/rerank; embeddings aliases embedding at this entry point. |
| `service_slot` | Queries | string | No | Registered service slot ID; applies its configuration as an additional filter, not an arbitrary scenario name. |

Combines currently readable Workspace declarations with system/deployment models allowed by the permission scope. System/TaaS supplementation requires collection filtering to be all. An empty restricted-object read does not establish a global lack of models. rerank currently returns empty; embedding follows embedding-list rules. Results do not prove model capability or successful inference.

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

## Successful response

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

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "models": [
      {
        "model": "chat-example",
        "backend_id": 12,
        "backend_name": "workspace-llm",
        "model_type": "chat",
        "source": "workspace",
        "system_default": false
      }
    ]
  }
}
```

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

| Field | Type | Description |
| --- | --- | --- |
| `code` | string | OK on success. |
| `data` | object | [Model, probe, or configuration results](objects.md#response). |

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

## Error responses

[States and errors](objects.md#errors) distinguishes string and numeric protocols. Confirm probe candidates, saved configuration, and actual inference separately.
