Help Center/ Cloud Search Service_KooSearch/ API Reference/ API/ APIs/ Knowledge Base Management/ Disabling a knowledge base
Updated on 2025-08-13 GMT+08:00
View PDF
Share

Disabling a knowledge base

Function

This API is used to disable a knowledge base by ID, thus making it unsearchable.

URI

PUT /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{repo_id}/stop

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default value:

N/A

application_id

Yes

String

Definition:

Application ID. For details about how to obtain the application ID, see Obtaining an Application ID.

Constraints:

Character string

Value range:

The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default value:

N/A

repo_id

Yes

String

Definition:

Knowledge base ID.

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.

Constraints:

N/A

Value range:

Length: 1 to 64 characters. The value can contain only digits, letters, hyphens (-), and underscores (_).

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

Token used for API authentication. For details about how to obtain the token, see Obtaining an IAM User Token.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Succeeded in closing the knowledge base.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

This API is used to disable a knowledge base by ID, thus making it unsearchable.

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/knowledge-repo/90cbdf34-8ba8-4f90-96d5-25fc7537164c/stop

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.