Updated on 2025-08-13 GMT+08:00

Closing the Knowledge Base

Function

This interface is used to close a knowledge base by ID. After a knowledge base is closed, it cannot be searched.

URI

PUT /v1/koosearch/repos/{repo_id}/disable

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repo_id

Yes

String

Knowledge base ID. The value is a string of 1 to 64 characters and can contain only digits, letters, hyphens (-), and underscores (_).

How to obtain:

Log in to the KooSearch experience platform. In the navigation tree on the left, choose Knowledge Bases to view knowledge base IDs. Each knowledge base has a unique ID stored in the vector database.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Parameter description:

Token used for API authentication. For how to obtain the token, see section 3.2 "Authentication."

Constraints:

N/A.

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

None

Example Responses

Status code: 400

Incorrect request body parameter

{
  "error_code" : "string",
  "error_message" : "string"
}

Status Codes

Status Code

Description

200

Succeeded in closing the knowledge base.

400

Incorrect request body parameter

500

Internal error

Error Codes

See Error Codes.