知识库列表

接口说明

列出当前 workspace 可见的全部知识库（按更新时间倒序）。调用检索接口前，应先通过本接口获取 knowledge_id。

• 接口路径：GET /v1/openapi/knowledge

请求头

参数名	必填	说明
Authorization	是	鉴权凭证，格式 Bearer sk_xxx

请求参数

Query 参数

参数	类型	必填	说明
keyword	string	否	知识库名称模糊匹配
page	int	否	页码，默认 1
page_size	int	否	每页条数，默认 20，上限 100

请求体

本接口为 GET 请求，无请求体，仅需鉴权头（参见认证与鉴权）。

成功响应示例

{
  "code": 200,
  "data": {
    "total": 2,
    "items": [
      {
        "id": "1368b2d9-60ff-48fc-9f14-0c39711896ef",
        "name": "华西医疗百科",
        "description": "华西医院常见疾病百科知识库",
        "icon": "https://oss.example.com/knowledge/icon/default.png",
        "type": 1,
        "status": 1,
        "dataset_num": 12,
        "words_num": 384521
      },
      {
        "id": "9e5b1c6f-5cb2-4d6c-9b15-2c0eaa8e3f01",
        "name": "用药指南",
        "description": "常见慢病用药与禁忌指南",
        "icon": "https://oss.example.com/knowledge/icon/default.png",
        "type": 1,
        "status": 1,
        "dataset_num": 5,
        "words_num": 152340
      }
    ]
  },
  "message": "success",
  "trace_id": "b335f4b309e7885786478563ff37bf95"
}

data 字段说明

字段	类型	说明
total	int	总条数
items[].id	string	知识库 ID（UUID），调用 detail / retrieve 接口时使用
items[].name	string	知识库名称
items[].description	string	知识库描述
items[].icon	string	知识库图标完整 URL（用户未设置时返回默认图标）
items[].type	int	知识库类型：1=文档集、2=表格集、3=图片集
items[].status	int	启用状态：0=禁用、1=启用；禁用的知识库仍可见但调用 retrieve 接口会返回空结果
items[].dataset_num	int	该知识库下数据集（文件）数量
items[].words_num	int	知识库累计字符数（图片集为 0）

调用示例

curl -X GET 'https://runtime-api.invalid/v1/openapi/knowledge?page=1&page_size=20' \
  -H 'Authorization: Bearer sk_your_api_key'

注意事项

• 返回结果包含禁用状态的知识库，调用 知识检索 前请关注 status 字段：禁用知识库的检索请求会返回空记录而非报错。
• 列表接口不返回 retriever_config 等检索配置摘要，如需了解默认检索策略请通过 知识库详情 接口查询。