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

20 阅读3分钟

通过调用本接口,开发者可以查询租户内知识库列表。

请求地址

GET``https://api.tbox.cn/api/datasets/queryDatasetsList

请求头

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

请求参数

参数名必填类型说明示例
pageNumInteger分页页码,默认为 1,从第一页数据开始返回。1
pageSizeInteger分页大小,默认为 10,最大为 50。10

请求示例

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

返回参数

参数名类型说明示例
errorCodeString错误码,为 0 表示成功。0
errorMsgString错误信息。success
dataPageObject知识库列表信息-
traceIdString本次请求的唯一标识,通常用于发生错误时的排查定位。0b****4d9

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

data 定义

参数名类型说明
currentPageInteger当前页
datasetsList知识库文件对象列表。
pageSizeInteger分页大小
totalInteger列表总数

datasets 定义

参数名类型说明
datasetIdString知识库 ID
descriptionString知识库描述
nameString知识库名称
storeSizeDouble知识库存储大小

返回示例

成功示例

{
    "data": {
        "currentPage": 1,
        "datasets": [
            {
                "datasetId": "202508059lUk00458063",
                "description": "测试2",
                "name": "测试1",
                "storeSize": 0.0
            },
            {
                "datasetId": "20250804tpAo00457894",
                "description": "测试2",
                "name": "测试2",
                "storeSize": 7808.0
            }
        ],
        "pageSize": 20,
        "total": 2
    },
    "errorCode": "0",
    "errorMsg": "success",
    "traceId": "0b446a1717543635033032613e386f"
}

失败返回

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

错误码

公共错误码

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

参数校验与业务错误码

errorCodeerrorMsg说明
P_1_00_005pageSize不能大于50- 原因:分页大小超出最大 50 条的限制。 解决方案:请修改后,重试。