Update Knowledge Base

Prerequisites

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

Endpoint

POST /api/v1/indices/rag/index/update Update the name, description, rerank minimum score, and other basic information of a Knowledge Base. Fields such as DenseSimilarityTopK, SparseSimilarityTopK, and PipelineCommercialType are specific to POP and are not supported by the REST endpoint — do not pass them.

The parameter is id — not index_id or indexId. Watch for the naming difference compared to other endpoints.

Request body

Field	Required	Type	Description
`id`	Yes	string	Knowledge Base ID. The parameter name is `id` — not `index_id` or `indexId`.
`name`	No	string	Knowledge Base name. 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 (-).
`description`	No	string	Knowledge Base description.
`rerankMinScore`	No	number	Minimum rerank score threshold. Valid range: [0, 1]. Chunks with scores below this value are filtered out.

Request example

curl -X POST "$BASE_URL/api/v1/indices/rag/index/update" \
  -H "Authorization: Bearer $BAILIAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "your-kb-id",
    "name": "your-kb-name",
    "description": "your-kb-description",
    "rerankMinScore": 0.01
  }'

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": {
    "updated_at": 1782191157000,
    "created_at": 1782180218000,
    "id": "your-kb-id"
  },
  "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	Response data. Sub-fields: `id` (string, Knowledge Base ID), `updated_at` (integer, update time as a Unix timestamp in milliseconds), `created_at` (integer, creation time as a Unix timestamp in milliseconds).

​Prerequisites

​Endpoint

​Request body

​Request example

​Response example

​Response fields

Prerequisites

Endpoint

Request body

Request example

Response example

Response fields