获取知识库

接口说明

通过 knowledgeBaseId 读取单个知识库。

接口信息

字段	值
方法	GET
路径	/openapi/v2/knowledge-bases/{knowledgeBaseId}
Operation ID	getKnowledgeBase
鉴权	Bearer OpenAPI key

入参

名称	位置	必填	类型	示例	说明
knowledgeBaseId	path	是	string	knowledge-base-11111111-1111-4111-8111-111111111111	知识库 API 返回的知识库标识。

请求体

这个接口没有请求体。

请求示例

curl -X GET "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111" \
  -H "Authorization: Bearer <openapi-key>"

成功响应

200

返回指定知识库。

字段	必填	类型	说明
knowledgeBase	是	object	知识库记录。

成功响应示例

{
  "knowledgeBase": {
    "knowledgeBaseId": "knowledge-base-11111111-1111-4111-8111-111111111111",
    "name": "Product Docs",
    "description": "Product documentation",
    "activeContentRevision": 1,
    "resourceRevision": 1,
    "createdAt": "2026-06-17T00:00:00.000Z",
    "updatedAt": "2026-06-17T00:00:00.000Z"
  }
}

错误码

下表列出这个接口已声明的全部错误响应。

HTTP 状态	错误码	说明
401	UNAUTHORIZED	Bearer API key 缺失、格式错误、未知、已撤销或已删除。
404	NOT_FOUND	请求的资源不存在。
429	RATE_LIMITED	请求超过当前配置的速率限制。
500	INTERNAL_ERROR	API 遇到内部错误。
503	DATABASE_REPOSITORY_UNAVAILABLE	当前接口所需的数据暂时不可用。

后续操作

• 创建上传会话
• 列出文件树
• 修改知识库