知识库接口文档型
文档查询
接口描述
查询知识库中的文档数据。
基础信息
| 请求地址 | /doc/documents |
|---|---|
| 请求域名 | • 办公网域名：http://jiuwen-api.vmic.xyz/v1 • IDC域名：http://jiuwen-api.vivo.lan:8080/v1 |
| 请求方法 | GET |
请求参数
Request Header
| 参数 | 取值 | 说明 |
|---|---|---|
| Authorization | Bearer {{API-SECRET-KEY}} | 用于验证客户端身份的 API密钥。注意：请只替换红色部分！Bearer和密钥中间有一个空格，请勿删除！ |
| Content-Type | application/json | 响应的HTTP内容类型。 |
Request Param
| 参数 | 类型 | 是否必传 | 默认值 | 说明 |
|---|---|---|---|---|
| page | int | 否 | 1 | 页数 |
| limit | int | 否 | 20 | 分页数量 |
| keyword | string | 否 | null | 分页关键字 |
返回参数
内容较多，详见下方示例
示例
Request
curl -X GET 'http://{HOST}/doc/documents?page=1&limit=20' Response
[
{
"id": "83f77ee721334f6c",
"dataset_id": "d20216a9c29c4c7b",
"name": "你的名字永远这么好听.pdf",
"status": "completed",
"display_status": "available",
"enabled": 1,
"doc_theme": "你的名字永远这么好听",
"source_name": "你的名字永远这么好听",
"source_link": "https://jiuwen-test.vmic.xyz/open-api/attachment/view/26978",
"extra": null,
"disabled_time": null,
"file_id": "26978",
"file_key": "upload_files/html2pdf/3e859bb9c6e24a13.pdf",
"created_at": "2025-09-19 10:20:48",
"updated_at": "2025-09-19 10:32:30",
"created_by": "835",
"updated_by": "835",
"start_process_time": "2025-09-19 10:32:23",
"end_process_time": "2025-09-19 10:32:30",
"refer_link": "https://jiuwen-test.vmic.xyz/open-api/attachment/view/26978",
"refer_link_name": "你的名字永远这么好听",
"data_source_type": "upload_file",
"data_source_info_dict": {
"upload_file_id": 26978
}
},
{
"id": "865babc9562c41ef",
"dataset_id": "d20216a9c29c4c7b",
"name": "这个是我新创建.pdf",
"status": "completed",
"display_status": "available",
"enabled": 1,
"doc_theme": "这个是我新创建",
"source_name": "这个是我新创建",
"source_link": "https://jiuwen-test.vmic.xyz/open-api/attachment/view/26977",
"extra": null,
"disabled_time": null,
"file_id": "26977",
"file_key": "upload_files/html2pdf/cd2550fe81f94937.pdf",
"created_at": "2025-09-19 09:51:43",
"updated_at": "2025-09-19 09:51:47",
"created_by": "835",
"updated_by": "835",
"start_process_time": "2025-09-19 09:51:43",
"end_process_time": "2025-09-19 09:51:47",
"refer_link": "https://jiuwen-test.vmic.xyz/open-api/attachment/view/26977",
"refer_link_name": "这个是我新创建",
"data_source_type": "upload_file",
"data_source_info_dict": {
"upload_file_id": 26977
}
}
]