DocumentList - 查看文档列表
更新时间：2026-01-22
API访问域名
| 请求方式 | GET |
|---|---|
| base url | https://keyue.cloud.baidu.com |
| 后缀接口 | /open/v1/api/v2/llm/document/list |
| Authentication | token为API Key |
说明
无
请求参数
Header参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| Content-Type | string | 是 | 内容类型 | 固定值：application/json |
| token | string | 是 | API KEY | 机器人API KEY。 详细获取方式参考：准备工作 |
| uid | string | 是 | 用户ID | 详细获取方式参考：准备工作 |
| username | string | 是 | 用户名 | 详细获取方式参考：准备工作 |
Parameter参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| pn | integer | 是 | 页码 | 1 |
| ps | integer | 是 | 每页数量 | 5 |
| keyword | string | 否 | 关键字 | |
| dirId | string | 是 | 目录ID | |
| origin | string | 否 | 来源 | |
| knowledgePublic | int | 否 | 知识类型 | 0:agent内部知识；1:公共知识 |
| i18n | int | 否 | 国际化类型 | 0:普通公共知识；1:国际化公共知识 |
Body参数
无
响应参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| time | integer | 是 | 时间 | 1717499666293 |
| data | object | 是 | 数据 | 数据对象 ，详见data子数据 |
| code | integer | 是 | 状态码 | 200 |
| msg | string | 是 | 状态信息 | OK |
data子数据
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| total | integer | 是 | 总数 | 1 |
| pn | integer | 是 | 页码 | 1 |
| ps | integer | 是 | 每页数量 | 20 |
| list | array | 是 | 列表 | 详见list子数据 |
| refresh | boolean | 是 | 刷新 | false |
list子数据
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| _effect | integer | 是 | 生效 | 0 |
| agentId | string | 是 | ||
| id | string | 是 | 文档知识id | |
| name | string | 是 | 名称 | http://fgahjfgah.com |
| size | string | 否 | 大小 | 146.0B |
| wordNumber | string | 是 | 字数 | 0 |
| learnStatus | integer | 是 | 学习状态 | -1学习失败；0学习中；1学习成功；2知识增强中；3抓取中；-2抓取失败 |
| dispatcherStatus | integer | 是 | ||
| fileKey | 否 | 文件密钥 | null | |
| modelId | string | 是 | ||
| modelFileKey | 否 | |||
| datasetId | string | 是 | 数据集ID | 1 |
| dirId | string | 是 | 目录ID | 0 |
| updated | string | 是 | 更新时间 | 2024-06-0416:08:41 |
| create | string | 是 | 创建时间 | 2024-06-0416:08:41 |
| createdUserId | string | 是 | 创建用户ID | e1befa4f6e464e24930eba7fc92dd5c2 |
| createdUsername | string | 是 | 创建用户名 | wyl_test7 |
| lastEditId | string | 是 | 最后编辑ID | e1befa4f6e464e24930eba7fc92dd5c2 |
| lastEditUsername | string | 是 | 最后编辑用户名 | wyl_test7 |
| errorMsg | string | 否 | 错误信息 | 模型训练超时:3600s |
| type | integer | 是 | 类型 | 2 |
| available | integer | 是 | 可用性 | 生效状态：1-生效，0-失效 |
| labels | 否 | 标签 | null | |
| labelList | array | 否 | 标签列表 | [] |
| paramsJson | string | 是 | 参数JSON | {} |
| jobId | string | 是 | ||
| knowledgeEnhancement | integer | 否 | 知识增强 | 0:未增强，1:增强，2:增强但失败 |
| effectStartTime | string | 是 | 生效开始时间 | 2000-01-01 00:00:00 |
| effectEndTime | string | 是 | 生效结束时间 | 2099-12-31 23:59:59 |
| publishTime | 否 | 发布时间 | ||
| learntTime | 否 | 学习时间 | ||
| enhanceMessage | 否 | 增强信息 | ||
| enhanceState | integer | 否 | 增强状态 | 0 |
| webUrl | string | 否 | 网页URL | http://fgahjfgah.com |
| refresh | integer | 否 | 刷新 | 0 |
| refreshTime | 否 | 刷新时间 | ||
| knowledgeEnhancementFromJson | boolean | 否 |
请求示例
Bash
1curl --location --request GET 'https://keyue.cloud.baidu.com/open/v1/api/v2/llm/document/list?keyword=&dirId=d03e3b67-5996-431c-948f-46ee42bd7e1b&pn=1&ps=20&knowledgePublic=1&i18n=1&origin=common_ninebot' \
2--header 'token: xxxx' \
3--header 'Content-Type: application/json' \
4--header 'uid: xxxx' \
5--header 'username: xxxx'响应示例
1{
2 "time": 1747315642845,
3 "data": {
4 "total": 2,
5 "pn": 1,
6 "ps": 20,
7 "list": [
8 {
9 "_effect": 0,
10 "agentId": "10996#1",
11 "id": "a4674ac6-2219-42cd-9116-003695310852",
12 "name": "B转向灯工作异常.jpg",
13 "size": "2.1MB",
14 "wordNumber": "1231",
15 "learnStatus": 1,
16 "dispatcherStatus": 2,
17 "fileKey": "Ym9zXzE3M2QwYTBhLWFiMjItNDNkYy05Y2YyLWY1MjdkNDk1MDk1ZQ==",
18 "modelId": "a4674ac6-2219-42cd-9116-003695310852",
19 "modelFileKey": "Ym9zX2tub3dsZWRnZS1lbmdpbmUvMTA5OTYjMS9vZmZsaW5lLzAvMC9hNDY3NGFjNi0yMjE5LTQyY2QtOTExNi0wMDM2OTUzMTA4NTIvc291cmNlLnBkZg==",
20 "datasetId": "1001",
21 "dirId": "0",
22 "dirName": "默认",
23 "updated": "2025-05-15 19:14:09",
24 "created": "2025-05-15 19:14:09",
25 "createdUserId": "48c93c8a53fd47c1bb7a130417531fd9",
26 "createdUsername": "",
27 "lastEditId": "48c93c8a53fd47c1bb7a130417531fd9",
28 "lastEditUsername": "",
29 "errorMsg": null,
30 "type": 0,
31 "available": 1,
32 "labelValueIds": null,
33 "paramsJson": "{}",
34 "jobId": "392c915c-f082-422d-937e-c2ed9f846490",
35 "knowledgeEnhancement": 0,
36 "effectStartTime": "2000-01-01 00:00:00",
37 "effectEndTime": "2099-12-31 23:59:59",
38 "publishTime": null,
39 "learntTime": "2025-05-15 19:28:14",
40 "enhanceMessage": null,
41 "enhanceState": 0,
42 "webUrl": "",
43 "refresh": null,
44 "refreshTime": "2025-05-15 19:28:14",
45 "videoTime": null,
46 "videoDesc": null,
47 "customField": null,
48 "knowledgeEnhancementFromJson": false
49 },
50 {
51 "_effect": 0,
52 "agentId": "10996#1",
53 "id": "bcce8eb1-9a54-4d70-bc2b-3f68b0f3c411",
54 "name": "九号电摩Q系列说明书.pdf",
55 "size": "1.9MB",
56 "wordNumber": "16257",
57 "learnStatus": 1,
58 "dispatcherStatus": 2,
59 "fileKey": "Ym9zX2FlOGIwMjRmLWViNGQtNDRiMS1iZmEzLWU2ZjJjMDgwMjMzYQ==",
60 "modelId": "bcce8eb1-9a54-4d70-bc2b-3f68b0f3c411",
61 "modelFileKey": "Ym9zX2tub3dsZWRnZS1lbmdpbmUvMTA5OTYjMS9vZmZsaW5lLzAvMC9iY2NlOGViMS05YTU0LTRkNzAtYmMyYi0zZjY4YjBmM2M0MTEvc291cmNlLnBkZg==",
62 "datasetId": "1001",
63 "dirId": "0",
64 "dirName": "默认",
65 "updated": "2025-05-15 19:13:46",
66 "created": "2025-05-15 19:13:46",
67 "createdUserId": "48c93c8a53fd47c1bb7a130417531fd9",
68 "createdUsername": "",
69 "lastEditId": "48c93c8a53fd47c1bb7a130417531fd9",
70 "lastEditUsername": "",
71 "errorMsg": null,
72 "type": 0,
73 "available": 1,
74 "labelValueIds": null,
75 "paramsJson": "{}",
76 "jobId": "80935e8c-3e11-4b9b-af3d-55e2df9f8542",
77 "knowledgeEnhancement": 0,
78 "effectStartTime": "2000-01-01 00:00:00",
79 "effectEndTime": "2099-12-31 23:59:59",
80 "publishTime": null,
81 "learntTime": "2025-05-15 19:30:50",
82 "enhanceMessage": null,
83 "enhanceState": 0,
84 "webUrl": "",
85 "refresh": null,
86 "refreshTime": "2025-05-15 19:30:50",
87 "videoTime": null,
88 "videoDesc": null,
89 "knowledgeEnhancementFromJson": false
90 }
91 ],
92 "allInstructions": null,
93 "refresh": false
94 },
95 "code": 200,
96 "msg": "OK"
97}1| code(错误码) | msg（错误信息） |
2| 4008651 | API Key 为空，请填写AI客服对应的API Key |
3| 4008652 | AI客服不存在，请检查 token 是否正确 |