Help Center/ Cloud Search Service_KooSearch/ API Reference/ API/ APIs/ Knowledge Base Directory Management/ Deleting Document Directories
Updated on 2025-08-13 GMT+08:00
View PDF
Share

Deleting Document Directories

Function

Delete the knowledge base document directory.

URI

DELETE /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory/{directory_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

directory_id

Yes

String

Definition:

Directory ID.

Constraints:

N/A

Value range:

The maximum length is 64 characters.

Default value:

N/A

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

Table 3 Response body parameters

Parameter

Type

Description

directory_ids

Array of strings

Definition:

ID of the deleted directory or subdirectory.

Value range:

N/A

Example Requests

Delete the knowledge base document directory.

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/0c3fae2d-428e-454c-ad80-2e5c5fa7b33a/directory/09fad85e-132b-41ab-b8ae-bc7fa7ff1d69

{
  "directory_ids" : [ "09fad85e-132b-41ab-b8ae-bc7fa7ff1d69" ]
}

Example Responses

Status code: 200

Response body for deleting a directory.

{
  "directory_ids" : [ "directory_2" ]
}

Status Codes

Status Code

Description

200

Response body for deleting a directory.

Error Codes

See Error Codes.