查询知识库详情¶

读取一个知识库的完整元数据，包括关联资产、索引状态和版本。

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

调用前准备¶

先查询知识库列表取得知识库 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求参数¶

请求示例

curl "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/knowledge-bases/$KNOWLEDGE_BASE_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

路径参数

字段	类型	必填	说明
`workspace_id`	string	是	当前工作区 ID，必须与 X-Workspace-ID 一致。
`knowledge_base_id`	string	是	要查看的知识库 ID。

成功响应¶

响应示例

{
  "code": 0,
  "data": {
    "id": "kb_01",
    "workspace_id": "ws_01",
    "name": "产品文档",
    "description": "已审核的产品资料",
    "status": "active",
    "source_type": "catalog_resource",
    "catalog_asset_refs": [
      {
        "type": "catalog",
        "id": "cat_01",
        "role": "source"
      }
    ],
    "tags": ["产品", "文档"],
    "owner_user_id": "user_01",
    "visibility": "workspace",
    "index_status": "ready",
    "last_indexed_at": "2026-08-18T01:00:00Z",
    "version": 2,
    "labels": {
      "department": "product"
    },
    "created_by": "user_01",
    "updated_by": "user_01",
    "created_at": "2026-08-18T01:00:00Z",
    "updated_at": "2026-08-18T02:00:00Z"
  }
}

字段说明

成功时返回 200。data 为知识库元数据。

通用字段

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

响应数据

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

错误响应¶

响应示例

{
  "code": 3,
  "message": "knowledge base not found"
}

字段说明

常见 HTTP 错误

字段	类型	说明
`400`	`2`（`INVALID_ARGUMENT`）	路径参数无效。建议：检查工作区 ID 和知识库 ID，不要在 ID 中使用路径分隔符。
`401`	`6`（`UNAUTHENTICATED`）	缺少有效身份凭据。建议：检查 API Key。
`404`	`3`（`NOT_FOUND`）	当前工作区中不存在该知识库。建议：检查 `knowledge_base_id`，或先查询知识库列表。
`503`	`15`（`UNAVAILABLE`）	知识库服务暂不可用。建议：稍后重试。

后续操作¶

需要修改元数据时，调用更新知识库。

最后更新于 2026 年 9 月 11 日