List Knowledge Bases

GET

/api/v1/indices/rag/index/list

cURL

curl -G "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/list" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -d "page_number=1" \
  -d "page_size=20"

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "page_number": 1,
    "total_count": 1,
    "rows": [
      {
        "id": "your_kb_id",
        "name": "my-knowledge-base",
        "description": "Sample knowledge base",
        "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"
}

Before calling, make sure you have an API key and a workspace ID — see Authentication.

Authorizations

string

header

required

DashScope API Key, obtained from the API Key page in the console.

Query Parameters

integer

default1

Page number, starting at 1.

Required range:x >= 1

integer

default10

Knowledge Bases per page.

Required range:1 <= x <= 100

string

Filter by exact Knowledge Base name.

Response

200-application/json

string

Response code. Success on success.

integer

HTTP status code.

string

Unique request identifier. Include this ID when reporting an issue.

object

Show child attributes

integer

Current page number.

integer

Total Knowledge Bases.

object[]

Knowledge Base list.

Show child attributes

string

Unique Knowledge Base ID.

string

Knowledge Base name.

string

Knowledge Base description.

string

Data type, e.g. unstructured.

string

Structure type: unstructured or structured.

string

Knowledge Base type.

string

Embedding model, e.g. text-embedding-v4.

integer

Embedding dimension.

string

Multimodal embedding model name (image/audio-video KBs).

integer

Chunk size (characters).

integer

Chunk overlap (characters).

string

Chunk separator.

string

Chunking mode.

string

Rerank model, e.g. qwen3-rerank. Empty if disabled.

number

Rerank minimum score threshold.

integer

Rerank returned count.

string

Rerank mode.

string

Custom rerank instruction.

string

Data source type, e.g. DATA_CENTER_CATEGORY.

string[]

Associated category/document IDs.

object[]

Column info, returned for structured KBs.

Show child attributes

boolean

Whether the column participates in knowledge base retrieval. When true, the knowledge base is allowed to search within this column.

object

Index configuration for data-query or image-QA Knowledge Bases.

string

Associated connector ID.

boolean

Whether query rewrite is enabled.

integer

Sparse retrieval TopK.

integer

Dense retrieval TopK.

string

Knowledge Base scene.

string

ID of the workspace the Knowledge Base belongs to.

boolean

Whether chunk header hierarchy is retained.

boolean

Whether visual text parsing is enabled.

integer

Chunk overlap length.

unknown[]

List of associated category IDs.

unknown[]

Table IDs associated with a structured Knowledge Base.

object

Data source configuration.

string

Vector store type; DEFAULT by default.

string

Instance ID of a self-managed vector store; empty when using the default store.

string

Region of the vector store.

unknown[]

Metadata extraction column configuration.

string

Knowledge Base tag.

string

How the Knowledge Base was created.

boolean

Whether data sync is enabled.

string

Data source code, used by structured Knowledge Bases.

string

Associated table name, used by structured Knowledge Bases.

string

Associated database name, used by structured Knowledge Bases.

string

Channel type.

integer

Current page size (matches the request).

boolean

Whether the request succeeded.

string

Informational message; success on success.

string

Request status: SUCCESS or FAILED.