Bulk Delete Knowledge Base Documents

Deletes multiple knowledge base documents in one request.

Request URL

POST {base_url}/uc-ai/api/v1/knowledge-base/documents/batch-delete

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
ids Yes Array<Integer> The list of IDs of the documents to delete, which must not be empty. You can obtain the IDs using the Search Knowledge Base Documents interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Deletion_Result> The batch deletion result.
Deletion_Result
Parameter Type Description
successCount Integer The number of documents deleted successfully.
failedCount Integer The number of documents that fail to be deleted.
failures Array<Object> The list of documents that fail to be deleted, with failure reasons.

Example

Request example

POST /uc-ai/api/v1/knowledge-base/documents/batch-delete HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjU4MzY1MSwiaWF0IjoxNzkyNTYyMDUxLCJqdGkiOiI5ODRiZjY0Mi00YWNlLTRiZWEtOTk3YS1lNmVhMjVjMTc3NDYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.G2oipgaRjD1M48lPlOjh51mu3Iad7TF4PjFqGpZV8qar5rOq362P0tnF1U8U1HtqHfaIBiyPBJHjt6HVIanxps31_WI9aVw6Uyq4uRL2G3trENCeU8Now78Buvv_frAhxW8KTLiCtT2cNYC3Usn0FCv5H-jMAS4JueCb96nu60usm8V6ytMk7O0i5Bs-cqMwEmQBL75oy4vW70HtCgZrsW0ZCChdi9l5l-OtfnEgLTC1ohfSw592heykBkhCKgFM5RtXW7NFMRWRgtI3E7hdMd-ETIL2TIC-SHL17kRkku6qAzDIMDHro5XkBgccKJkGF2GXHcGgL6-dLgi9SFjrDw
x-tenant-code: jint
Content-Type: application/json
{
  "ids": [
    2112785010068353026,
    211278450047299938
  ]
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "successCount": 2,
    "failedCount": 0,
    "failures": []
  },
  "requestId": "9917c1b4fa6bdf639d593f4d5d9c24de",
  "code": "200",
  "message": "SUCCESS"
}