List Knowledge Bases

Prerequisites

Get an API key and a workspace ID, and configure authentication first. See API overview and Authentication.

Endpoint

GET /api/v1/indices/rag/index/list Paginate through every Knowledge Base in the current workspace, returning basic information plus embedding and rerank model configurations. Pagination and filter parameters are passed through the query string.

Request parameters

The following parameters are passed through the query string.

Parameter	Required	Type	Description
`page_number`	No	integer	Page number, starting from 1. Default: 1.
`page_size`	No	integer	Number of Knowledge Bases per page. Valid range: 1-100. Default: 10.
`pipeline_name`	No	string	Fuzzy filter by Knowledge Base name; returns Knowledge Bases whose names contain this value. When omitted, all Knowledge Bases in the workspace are returned. 1-20 characters; supports Unicode letter category characters (including English letters, Chinese characters, digits, etc.), and may contain half-width colons (:), underscores (_), half-width periods (.), or hyphens (-).

Request example

curl -G "$BASE_URL/api/v1/indices/rag/index/list" \
  -H "Authorization: Bearer $BAILIAN_API_KEY" \
  -d "page_number=1" \
  -d "page_size=20"

BASE_URL is https://{workspace_id}.cn-beijing.maas.aliyuncs.com ({workspace_id} is the workspace ID), and BAILIAN_API_KEY is your Alibaba Cloud Model Studio API key.

Response example

Returns 200 on success.

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "page_number": 1,
    "total_count": 1,
    "rows": [
      {
        "id": "your-kb-id",
        "name": "my-knowledge-base",
        "description": "your-kb-description",
        "dataType": "unstructured",
        "structureType": "unstructured",
        "knowledgeType": null,
        "embeddingModelName": "text-embedding-v4",
        "embeddingDimension": null,
        "multimodalEmbeddingModelName": null,
        "rerankModelName": "qwen3-rerank",
        "rerankMinScore": 0.2,
        "rerankTopN": null,
        "rerankMode": null,
        "rerankInstruct": null,
        "chunkSize": 600,
        "overlapSize": 100,
        "separator": null,
        "chunkMode": null,
        "sourceType": "DATA_CENTER_CATEGORY",
        "docIds": [
          "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
          "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx"
        ],
        "columns": null,
        "enableRewrite": true,
        "connectorId": null,
        "sparseSimilarityTopK": null,
        "denseSimilarityTopK": null
      }
    ],
    "page_size": 20
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}

Response fields

Field	Type	Description
`code`	string	Response code. `Success` when successful.
`status_code`	integer	HTTP status code.
`request_id`	string	Unique request identifier. Provide this ID when troubleshooting.
`success`	boolean	Whether the request succeeded.
`message`	string	Response message. `success` when successful.
`status`	string	Request status: `SUCCESS` or `FAILED`.
`data`	object	Paged result. Sub-fields: `page_number` (integer, current page number), `total_count` (integer, total number of Knowledge Bases), `page_size` (integer, current page size, same as the request), `rows` (array, Knowledge Base list; see the table below for element fields).

rows element fields

Field	Type	Description
`id`	string	Unique Knowledge Base identifier.
`name`	string	Knowledge Base name.
`description`	string	Knowledge Base description.
`dataType`	string	Data type, for example `unstructured`.
`structureType`	string	Structure type: `unstructured` or `structured`.
`knowledgeType`	string	Knowledge Base type.
`embeddingModelName`	string	Embedding model, for example `text-embedding-v4`.
`embeddingDimension`	integer	Embedding dimension.
`multimodalEmbeddingModelName`	string	Multimodal embedding model name (image/audio-video Knowledge Bases).
`chunkSize`	integer	Chunk size in characters.
`overlapSize`	integer	Chunk overlap size in characters.
`separator`	string	Chunk separator.
`chunkMode`	string	Chunk mode.
`rerankModelName`	string	Rerank model, for example `qwen3-rerank`. Empty means rerank is not enabled.
`rerankMinScore`	number	Minimum rerank score threshold.
`rerankTopN`	integer	Number of results returned by rerank.
`rerankMode`	string	Rerank mode.
`rerankInstruct`	string	Custom rerank instruction.
`sourceType`	string	Data source type, for example `DATA_CENTER_CATEGORY`.
`docIds`	`array<string>`	Associated category/document ID list.
`columns`	`array<object>`	Column information, returned for structured Knowledge Bases. Sub-field: `IsSearch` (boolean, whether the column participates in Knowledge Base retrieval; `true` allows searching the data in this column).
`structuredIndexConfig`	object	Index configuration of Data Query or Image Q&A Knowledge Bases.
`connectorId`	string	Associated connector ID.
`enableRewrite`	boolean	Whether query rewrite is enabled.
`sparseSimilarityTopK`	integer	Sparse retrieval TopK.
`denseSimilarityTopK`	integer	Dense retrieval TopK.
`knowledgeScene`	string	Knowledge Base scenario.
`workspaceId`	string	ID of the workspace the Knowledge Base belongs to.
`enableHeaders`	boolean	Whether chunks retain heading hierarchy information.
`enableVisualText`	boolean	Whether visual text parsing is enabled.
`chunkOverlap`	integer	Chunk overlap length.
`categoryIds`	array	Associated category ID list.
`tableIds`	array	Table ID list associated with a structured Knowledge Base.
`dataSource`	object	Data source configuration.
`sinkType`	string	Vector storage type. Default: `DEFAULT`.
`sinkInstanceId`	string	ID of a self-managed vector storage instance. Empty when the default storage is used.
`sinkRegion`	string	Region of the vector storage.
`metaExtractColumns`	array	Metadata extraction column configuration.
`pipelineTag`	string	Knowledge Base tag.
`createIndexType`	string	How the Knowledge Base was created.
`dataSync`	boolean	Whether data sync is enabled.
`datasourceCode`	string	Data source code, used by structured Knowledge Bases.
`table`	string	Associated data table name, used by structured Knowledge Bases.
`database`	string	Associated database name, used by structured Knowledge Bases.
`channelType`	string	Channel type.

Error codes

HTTP status code	Error code (`code`)	Description
400	`Index.InvalidParameter`	Invalid request parameters: `Required parameter missing or invalid.`
401	`InvalidApiKey`	Invalid or missing API key: `Invalid API-key provided.`

​Prerequisites

​Endpoint

​Request parameters

​Request example

​Response example

​Response fields

​rows element fields

​Error codes