Overview of the Knowledge Retrieval and Knowledge Q&A APIs, covering the Knowledge Search and Knowledge Chat endpoints.
The Knowledge Retrieval and Q&A APIs belong to the DashScope application gateway system, unlike OpenAPI RPC interfaces (such as
Authentication: All requests must carry the
CreateIndex, ListIndices, Retrieve): they are called over HTTP REST with API Key Bearer authentication. The Base URL is https://{workspaceId}.cn-beijing.maas.aliyuncs.com, where {workspaceId} is the workspace ID.
API List
API | Description | Path |
|---|---|---|
Run a joined semantic search across multiple Knowledge Bases and return chunks ordered by relevance. | POST /api/v1/indices/knowledge/search | |
Knowledge Base-grounded intelligent Q&A, streamed over SSE in three phases: planning, tool calling, and generation. | POST /api/v2/apps/knowledge/chat |
Authorization: Bearer <API-Key> header and use a Base URL prefixed with the workspace ID. Obtain the API Key on the API Key page in the console, and the workspace ID in Workspace Management.
Rate limit: 25 QPS per user by default. If throttled, retry later.