# 查询知识库列表

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

查询当前工作区的知识库元数据，并按状态、来源、可见范围、索引状态、所有者或关键词筛选。

```text
GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/knowledge-bases
```

## 调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

## 请求参数

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 请求示例

```bash
curl --get "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/knowledge-bases" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  --data-urlencode "status=active" \
  --data-urlencode "index_status=ready" \
  --data-urlencode "query=产品" \
  --data-urlencode "limit=20"
```

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

::::{tab-set}
:::{tab-item} 路径参数

| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `workspace_id` | string | 是 | 当前工作区 ID，必须与 X-Workspace-ID 一致。 |

:::
:::{tab-item} 查询参数

| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `status` | string； | 否 | 状态。允许：`draft`、`active`、`disabled`、`archived`。 |
| `source_type` | string； | 否 | 来源类型。允许：`manual`、`catalog_resource`、`file_collection`、`external_drive`、`connector_export`。 |
| `visibility` | string； | 否 | 可见范围。允许：`private`、`workspace`。 |
| `index_status` | string； | 否 | 索引状态。允许：`empty`、`indexing`、`ready`、`failed`。 |
| `owner_user_id` | string | 否 | 按所有者用户 ID 筛选。 |
| `query` | string | 否 | 按关键词筛选。 |
| `limit` | integer | 否 | 单次返回数量。未提供或小于等于 0 时为 50，最大为 200。 |
| `offset` | integer | 否 | 返回偏移量。未提供或小于 0 时为 0。 |

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

## 查询参数

状态、来源、可见范围和索引状态会去除首尾空白并转为小写。`query` 按名称和说明做大小写不敏感的字面包含匹配，`%` 和 `_` 不作为通配符。结果按更新时间降序、ID 升序排列。

## 成功响应

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

```json
{
  "code": 0,
  "data": {
    "items": [
      {
        "id": "kb_01",
        "workspace_id": "ws_01",
        "name": "产品文档",
        "status": "active",
        "source_type": "catalog_resource",
        "visibility": "workspace",
        "index_status": "ready",
        "version": 1,
        "created_at": "2026-08-18T01:00:00Z",
        "updated_at": "2026-08-18T01:00:00Z"
      }
    ],
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}
```

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

成功时返回 `200`。`data.items` 为本页知识库，`data.total` 为筛选结果总数。没有匹配项时，`data.items` 返回 `[]`。

本文中，字段路径中的 `[]` 表示数组中的每一项。例如，`items[].name` 表示 `items` 数组中每一项的 `name` 字段。

::::{tab-set}
:::{tab-item} 通用字段

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 0。 |

:::
:::{tab-item} 响应数据

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `data.items` | array或 null | 本页知识库列表；没有匹配项时可能为 `null`。 |
| `data.total` | integer | 符合筛选条件的知识库总数。 |
| `data.limit` | integer | 本次实际采用的分页值。 |
| `data.offset` | integer | 本次实际采用的分页值。 |

:::
:::{tab-item} `items` 数组元素

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `data.items[].id` | string | 知识库 ID。 |
| `data.items[].workspace_id` | string | 所属工作区 ID。 |
| `data.items[].name` | string | 名称和说明；未设置说明时不返回。 |
| `data.items[].description` | string | 名称和说明；未设置说明时不返回。 |
| `data.items[].status` | string | 知识库状态和来源类型。 |
| `data.items[].source_type` | string | 知识库状态和来源类型。 |
| `data.items[].catalog_asset_refs` | array | 关联资产；未设置时不返回。成员说明见[创建知识库中的关联资产字段](create-agent-knowledge-base.md#关联资产字段)。 |
| `data.items[].default_retrieval_profile_ref` | string | 默认检索配置引用；未设置时不返回。 |
| `data.items[].tags` | array of string | 标签；未设置时不返回。 |
| `data.items[].owner_user_id` | string | 所有者用户 ID；未设置时不返回。 |
| `data.items[].visibility` | string | 可见范围和索引状态。 |
| `data.items[].index_status` | string | 可见范围和索引状态。 |
| `data.items[].last_indexed_at` | string | 最近索引时间和错误信息；未设置时不返回。 |
| `data.items[].last_index_error` | string | 最近索引时间和错误信息；未设置时不返回。 |
| `data.items[].version` | integer | 资源版本。 |
| `data.items[].labels` | object | 扩展标签、注释和元数据；未设置时不返回。 |
| `data.items[].annotations` | object | 扩展标签、注释和元数据；未设置时不返回。 |
| `data.items[].metadata` | object | 扩展标签、注释和元数据；未设置时不返回。 |
| `data.items[].created_by` | string | 创建者和最近更新者 ID；未设置时不返回。 |
| `data.items[].updated_by` | string | 创建者和最近更新者 ID；未设置时不返回。 |
| `data.items[].created_at` | string | 创建和最近更新时间，采用 RFC 3339 格式。 |
| `data.items[].updated_at` | string | 创建和最近更新时间，采用 RFC 3339 格式。 |

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

## 错误响应

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

```json
{
  "code": 2,
  "message": "invalid knowledge base metadata"
}
```

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

### 常见 HTTP 错误

```{list-table}
:header-rows: 1

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - 400
  - `2`
  - 请求字段、工作区或操作前置条件无效。
  - 修正参数后再提交。
* - 401
  - `6`
  - 认证凭据缺失或无效。
  - 检查凭据类型、有效期及认证头。
* - 403
  - `5`
  - 当前身份或有效角色无执行该操作的权限。
  - 使用有权限的身份，或联系管理员授权。
* - 404
  - `3`
  - 目标对象或所需引用未找到。
  - 核对对象标识、所属工作区和当前状态。
* - 409
  - `4`
  - 资源状态、请求内容或并发条件冲突。
  - 重新读取当前状态和版本，按实际结果处理。
* - 503
  - `15`
  - 业务、运行时或授权依赖暂不可用。
  - 恢复依赖后先核对已有结果，不自动重复写入。
```

## 后续操作

使用 `data.items[].id` 调用[查询知识库详情](get-agent-knowledge-base.md)。