了解 Knowledge Studio API 的服务地址、协议约定、请求格式与限流规则
通过 Knowledge Studio API,您可以以编程方式管理知识库、导入文档、执行检索以及调用知识问答服务。所有接口均通过 DashScope 网关提供服务。
Knowledge Studio API 包含三组接口,路径前缀不同:
例如,检索接口的完整地址为:
所有接口返回统一的 JSON 结构。
成功响应:
失败响应:
排查问题时,请提供
列表接口支持分页查询。不同接口的请求方法、参数命名与传参位置存在差异,调用时需注意区分:
各接口设有请求频率限制,超出时返回 HTTP
调用 API 前,请先获取 API Key。
服务地址
{workspaceId} 是业务空间 ID,格式如 llm-xxxxxxxxxxxx,在控制台 业务空间管理 页面查看或创建。
所有接口使用统一的服务地址:
| 接口组 | 路径前缀 | 说明 |
|---|---|---|
| 知识库管理 | /api/v1/indices/ | 知识库 CRUD、文档管理、切片管理、检索 |
| 数据导入 | /api/v1/connector/dash/ | 类目管理、文件上传、连接器配置 |
| 知识问答 | /api/v2/apps/bailian-rag-agent/ | 知识问答服务(SSE 流式) |
协议约定
- 所有接口均通过 HTTPS 访问,不支持 HTTP。
- 请求体和响应体均为 JSON 格式,字符集 UTF-8。
- 知识库管理、文档管理、切片管理、检索、数据导入等接口统一使用
POST方法;少数查询接口使用GET方法并通过 query string 传参,包括查询知识库列表、查询文档列表、查询导入任务状态。各接口的实际方法与参数位置以接口说明为准。
通用请求头
| Header | 必填 | 说明 |
|---|---|---|
Authorization | 是 | Bearer <API-Key>,在控制台 API Key 页获取。详见鉴权说明。 |
Content-Type | 是 | POST 请求为 application/json。 |
通用响应格式
所有接口返回统一的 JSON 结构。
成功响应:
request_id,以便技术支持快速定位。完整错误码见错误码参考。
分页
列表接口支持分页查询。不同接口的请求方法、参数命名与传参位置存在差异,调用时需注意区分:
| 适用接口 | 方法 | 页码参数 | 每页条数 | 传参位置 |
|---|---|---|---|---|
| 查询知识库列表 | GET | page_number(从 1 开始) | page_size | Query String |
| 查询文档列表 | GET | page_num | page_size | Query String |
| 查询切片列表 | POST | page_num | page_size | Request Body |
| 查询文件详情列表 | POST | pageNumber(从 1 开始) | pageSize | Request Body |
查询知识库列表的分页参数必须通过 query string 传递(
page_number、page_size,注意是 page_number 而非 page_num);若放在请求体中,服务端会忽略并按默认值返回。限流
各接口设有请求频率限制,超出时返回 HTTP 429。完整的限流规则见限流说明。