查询RAG知识库列表

收藏
我的收藏

接口说明

查询已创建的rag知识库列表

基本信息

名称描述
HTTP URL
https://open.douyin.com/dy_open_api/ai/v1/query_knowledge_base_list/
HTTP Method
POST
Scope
ai.knowledge_base.open_api
权限要求
无需申请能力

请求参数

请求头
access-token必填String
当ai分身调用时,调用https://open.douyin.com/oauth/client_token/生成的token
当服务商代调用时,调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
content-type必填String
固定值"application/json"
Body
page_num必填Int64
示例:1
page_size必填Int64
示例:10
单页最大 10
knowledge_base_idString
示例:kb23423
知识库id
请求示例
curl --location --request POST '/dy_open_api/ai/v1/query_knowledge_base_list/' \ --header 'access-token: 0801121846735352506a356a6' \ --header 'content-type: application/json' \ --data '{"page_size":10,"page_num":1}'

响应参数

Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例:"access_token无效"
错误描述
err_no必填Int32
示例:28001003
错误码
log_id必填String
示例:"202405291440576E078D8757B9"
日志id
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "err_msg": "success", "log_id": "20241227182608B89E974554DC4287EAA5", "data": { "total": 1, "knowledge_base_list": [ { "update_time": "2024-12-27 18:24:33", "create_time": "2024-12-27 18:24:33", "file_num": 1, "knowledge_base_file_list": [ { "file_size": 3, "file_name": "test_123", "file_id": "kbf342342" } ], "knowledge_base_type": 1, "knowledge_base_desc": "测试1", "knowledge_base_name": "测试1", "knowledge_base_id": "kb23424" } ] } }
切换单列布局

错误码

HTTP 状态码错误码错误码描述排查建议
20028001005
系统内部错误,请重试
请求重试,若依然无解请向平台提交反馈
20028001003
access_token无效
重新请求生成access_token
20028001008
access_token过期,请刷新或重新授权
重新请求生成access_token
20028001016
当前应用已被封禁或下线
clientKey被封禁或者下线
20028001006
网络调用错误,请重试
重试即可
20028001014
应用未授权任何能力
确认应用是否授权能力
20028001018
应用未获得该能力
开通相关能力
20028003017
quota已用完
联系平台处理
20028001019
应用该能力已被封禁
该能力被封禁,联系平台处理
20028001007
参数不合法
根据错误信息检查请求参数是否填写正常
20028003018
请求频率过高
限制qps 5以下,请降低请求频率,稍后重试