百宝箱开放平台 ✖️ 查询知识库文件列表-阿里云开发者社区

百宝箱开放平台 ✖️ 查询知识库文件列表

2025-10-20 120

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： 通过调用该接口，开发者可查询指定知识库中的文件列表，支持分页参数设置，需提供Authorization令牌及知识库ID，返回文件信息包括名称、大小等，并附带错误码说明。

通过调用本接口，开发者可以查询指定知识库内存在的文件列表。

请求地址

GEThttps://api.tbox.cn/api/datasets/datasetsDocumentsList

请求头

参数名	必填	类型	说明	示例
Authorization	是	String	用于验证客户端身份的访问令牌，你可以在百宝箱中获取，获取方式可参见：授权管理。	`pat_2j4e******THUIVRH1`
Content-Type		text/plain	解释请求正文的方式。	-

请求参数

参数名	必填	类型	说明	示例
datasetId	是	String	知识库 ID，指文件所在的目标知识库 ID。	2555****sdf
pageNum	否	Integer	分页页码，默认为 1，从第一页数据开始返回。	1
pageSize	否	Integer	分页大小，默认为 10，最大为 50。	10

请求示例

curl  --location --request GET 'https://api.tbox.cn/api/datasets/datasetsDocumentsList?pageNum=1&pageSize=20&datasetId=202508051Vvk00458376' \
--header 'Authorization: {your_token}' \
--header 'Content-Type: text/plain'

返回参数

参数名	类型	说明	示例
errorCode	String	错误码，为 0 表示成功。	0
errorMsg	String	错误信息。	success
data	PageObject	知识库文件列表，详细说明请参见：data 定义。	-
traceId	String	本次请求的唯一标识，通常用于发生错误时的排查定位。	0b****4d9

其中，errorCode 与 errorMsg 的对照关系以及对应的解决方案，请参见下方错误码。

data 定义

参数名	类型	说明
currentPage	Integer	当前页
documents	List<Document>	知识库文件对象列表，详细说明请参见：documents 定义。
pageSize	Integer	分页大小
total	Integer	列表总数

documents 定义

参数名	类型	说明
documentId	String	文件 ID
name	String	文件名
storeSize	Double	知识库存储大小
wordCount	Double	文件大小

返回示例

{
    "data": {
        "currentPage": 1,
        "documentsList": [
            {
                "documentId": "20250805edFX7629458673",
                "name": "千岛湖.docx",
                "storeSize": 7808.0,
                "wordCount": 2286
            }
        ],
        "pageSize": 50,
        "total": 1
    },
    "errorCode": "0",
    "errorMsg": "success",
    "traceId": "0b446a1717543881293953712e3875"
}

{
    "errorCode": "P_1_00_005",
    "errorMsg": "pageSize不能大于50",
    "solution": "请确认参数值是否正确！",
    "traceId": "0be8c63017543648690345786e1a1c"
}

错误码

公共错误码

errorCode	errorMsg	说明
S40000	系统异常	原因：系统出现错误。解决方案：请稍后重试，若持续报错，请点击此处与我们取得联系，并将错误码与 traceId 一同反馈，帮助我们快速定位问题。
P_1_10_183	授权令牌无效	原因：token 不正确。解决方案：请校验是否输入了有效令牌或配置新令牌。
P_1_10_184	授权令牌已失效	原因：当前 token 已过期。解决方案：请前往百宝箱开放平台申请新令牌并更新到调用配置中。
P_1_10_185	未检测到授权令牌	原因：未填写 token 信息。解决方案：请参考授权管理完成授权令牌的申请和配置。
P_1_13_682	非法访问，请联系平台	原因：系统检测到异常活动。解决方案：请稍后重试，若持续报错，请点击此处与我们取得联系，并将错误码与 traceId 一同反馈，帮助我们快速定位问题。

参数校验与业务错误码

errorCode	errorMsg	说明
P_1_00_005	pageSize 不能大于50	原因：分页大小超出最大 50 条的限制。解决方案：请修改后，重试。
P_1_00_005	pageNum 不能小于1	原因：分页页码不能小于 1。解决方案：请输入正确数值后，重试。
P_1_00_005	datasetId 不能为空	原因：查询文件列表时，目标知识库 ID 为必填项。解决方案：请填入正确的知识库 ID 后，重试。

百宝箱开放平台 ✖️ 查询知识库文件列表

请求地址

请求头

请求参数

请求示例

返回参数

data 定义

documents 定义

返回示例

错误码

公共错误码

参数校验与业务错误码

行业解决方案

热门文章

最新文章

相关电子书

相关实验场景