Skip to main content
通用

API 概览

了解 Knowledge Studio API 的服务地址、协议约定、请求格式与限流规则

通过 Knowledge Studio API,您可以以编程方式管理知识库、导入文档、执行检索以及调用知识问答服务。所有接口均通过 DashScope 网关提供服务。
调用 API 前,请先获取 API Key

服务地址

{workspaceId} 是业务空间 ID,格式如 llm-xxxxxxxxxxxx,在控制台 业务空间管理 页面查看或创建。 所有接口使用统一的服务地址:
https://{workspaceId}.cn-beijing.maas.aliyuncs.com
Knowledge Studio API 包含三组接口,路径前缀不同:
接口组路径前缀说明
知识库管理/api/v1/indices/知识库 CRUD、文档管理、切片管理、检索
数据导入/api/v1/connector/dash/类目管理、文件上传、连接器配置
知识问答/api/v2/apps/bailian-rag-agent/知识问答服务(SSE 流式)
例如,检索接口的完整地址为:
https://llm-xxxxxxxxxxxx.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/retrieve

协议约定

  • 所有接口均通过 HTTPS 访问,不支持 HTTP。
  • 请求体和响应体均为 JSON 格式,字符集 UTF-8
  • 知识库管理、文档管理、切片管理、检索、数据导入等接口统一使用 POST 方法;少数查询接口使用 GET 方法并通过 query string 传参,包括查询知识库列表查询文档列表查询导入任务状态。各接口的实际方法与参数位置以接口说明为准。

通用请求头

Header必填说明
AuthorizationBearer <API-Key>,在控制台 API Key 页获取。详见鉴权说明
Content-TypePOST 请求为 application/json

通用响应格式

所有接口返回统一的 JSON 结构。 成功响应:
{
  "code": "Success",
  "status_code": 200,
  "data": { },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
失败响应:
{
  "code": "Index.InvalidParameter",
  "status_code": 400,
  "message": "Required parameter(xxx) missing or invalid, please check the request parameters.",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
排查问题时,请提供 request_id,以便技术支持快速定位。完整错误码见错误码参考

分页

列表接口支持分页查询。不同接口的请求方法、参数命名与传参位置存在差异,调用时需注意区分:
适用接口方法页码参数每页条数传参位置
查询知识库列表GETpage_number(从 1 开始)page_sizeQuery String
查询文档列表GETpage_numpage_sizeQuery String
查询切片列表POSTpage_numpage_sizeRequest Body
查询文件详情列表POSTpageNumber(从 1 开始)pageSizeRequest Body
查询知识库列表的分页参数必须通过 query string 传递(page_numberpage_size,注意是 page_number 而非 page_num);若放在请求体中,服务端会忽略并按默认值返回。

限流

各接口设有请求频率限制,超出时返回 HTTP 429。完整的限流规则见限流说明