Help Center/ Cloud Search Service_KooSearch/ API Reference/ API/ APIs/ File Management/ API for Deleting Documents in Batches
Updated on 2025-08-13 GMT+08:00
View PDF
Share

API for Deleting Documents in Batches

Function

Delete documents in batches based on document IDs.

URI

DELETE /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/files/batch

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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

file_ids

Yes

Array of strings

Definition:

File ID arrays.

Constraints:

N/A

Value range:

Each file ID can contain only 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Definition:

Total number of documents to be deleted.

Value range:

N/A

deleted_count

Integer

Definition:

Total number of documents successfully deleted.

Value range:

N/A

Status code: 400

Table 5 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 6 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

API for deleting documents in batches.

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/0c3fae2d-428e-454c-ad80-2e5c5fa7b33a/files/batch

{
  "file_ids" : [ "520543f5c9eaa1e192963b2cb8fb0d0b", "48b60057c4d83a519745c30bda653022" ]
}

Example Responses

Status code: 200

Deletion succeeded.

{
  "total_count" : 1,
  "deleted_count" : 1
}

Status Codes

Status Code

Description

200

Deletion succeeded.

400

Parameter error.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: File Management