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

Deleting Chat History in Batches

Function

Deletes historical dialog information in batches based on dialog IDs.

URI

DELETE /v1/{project_id}/applications/{application_id}/uni-search/chat-history/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

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

chat_ids

Yes

Array of strings

Definition:

IDs of the chats to be deleted.

Constraints:

N/A

Value range:

Chat ID. The value must be a string of 1 to 64 characters. It can only contain letters, digits, underscores (_), and hyphens (-).

Default value:

N/A

repo_ids

No

Array of strings

Definition: IDs of the knowledge bases corresponding to the chat history to be deleted. Constraints: N/A ** Value range: ** Each ID contains 1 to 64 characters. The maximum length of the list is 100. Default value: N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Definition:

Total number of chats to be deleted.

Value range:

N/A

deleted_count

Integer

Definition:

Number of chats successfully deleted.

Value range:

N/A

Example Requests

Delete chat history records in batches.

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/chat-history/batch

{
  "chat_ids" : [ "a51ce4e0-66b4-446c-8376-13deba725da5", "06611077-453e-4fd0-83f9-b635d8c84bc2" ],
  "repo_ids" : [ "7741920e-7c1c-4a48-8555-c43b66153272", "7741920e-7c1c-4a48-8555-c43b66153272" ]
}

Example Responses

Status code: 200

Response to the request for deleting chat history in batches.

{
  "totalCount" : 2,
  "deletedCount" : 2
}

Status Codes

Status Code

Description

200

Response to the request for deleting chat history in batches.

Error Codes

See Error Codes.

Parent topic: Chat History