知识库文件列表

curl -X POST 'https://HOST:PORT/api/v1/third_interface/knowledge/file_list'

鉴权

出于安全考虑,必须将 TOKEN 存储于服务端并通过后端接口调用,避免在前端代码中直接暴露,以防止凭证泄露造成损失

请在 HTTP 请求的 Authorization 请求头中包含您的 TOKEN,格式如下:

Authorization: Bearer {YOUR_TOKEN}

TOKEN获取可通过 个人令牌 和 OAuth 应用获取,具体见 个人令牌授权OAuth 授权码授权

应用秘钥private_key 的获取具体见 生成应用密钥

Request body

  • file_name (str): 文件名(模糊搜索)
  • knowledge_id (int): 知识库ID
  • folder_id (int): 文件夹ID
  • page_num (int): 页码
  • page_size (int): 页大小
参数名 示例值 参数类型 是否必填 参数描述
file_name 半云科技 string 文件名(模糊搜索)
knowledge_id 740 number 知识库ID
folder_id - null 文件夹ID
page_num 1 number 页码
page_size 10 number 页大小

Response

  • status_code (int): 状态码,200表示成功
  • status_message (string): 状态信息
  • data (dict): 返回的数据
    • items (list) 数据列表
      • id: (int): 文件ID
      • status: (int): 解析状态 1解析中 2解析成功 3解析失败
      • progress_status: (int): 解析进度
      • object_name: (string): 对象名
      • file_source: (int): 来源
      • knowledge_id: (int): 知识库ID
      • size: (string): 文件大小
      • md5: (string): md5
      • file_name: (string): 文件名
      • user_id: (int): 用户ID
      • create_by: (string): 创建者username
      • knowledge_type: (int): 知识库文件类型
      • parent_id: (int): 文件夹id
      • create_time: (datetime): 创建时间
      • update_time: (datetime): 更新时间
    • page_num: (int): 页码
    • page_size: (int): 页大小

响应示例

{
  "status_code": 200,
  "status_message": "SUCCESS",
  "data": {
    "items": [
      {
        "id": 3005,
        "status": 2,
        "progress_status": 5,
        "object_name": "1_740/23a6d853-3717-4d48-aee1-3989ea21169e.pdf",
        "file_source": 1,
        "knowledge_id": 740,
        "size": "1.22 MB",
        "md5": "72d6c26865284218d66b352c0817d7e761d2fdbfcc820316a7715be6945bc75c",
        "file_name": "半云科技员工手册.pdf",
        "user_id": 1,
        "create_by": "admin",
        "knowledge_type": "file",
        "parent_id": 0,
        "create_time": "2025-07-28T11:08:30",
        "update_time": "2025-07-28T11:08:30"
      }
    ],
    "total": 1,
    "page_num": 1,
    "page_size": 10
  }
}