Sign in

v4

latestOpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Bulk Delete Knowledge Base Documents

Delete multiple documents or folders from the knowledge base. Each id succeeds or fails independently.

post/v1/convai/knowledge-base/bulk-delete

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

document_idsstring[] required

The ids of documents or folders from the knowledge base.

forceboolean

If set to true, documents or folders will be deleted regardless of whether they are used by any agents and will be removed from the dependent agents. For non-empty folders, this will also delete all child documents and folders.

Example request

{
  "document_ids": [
    "21m00Tcm4TlvDq8ikWAM",
    "31m00Tcm4TlvDq8ikWBM"
  ]
}

Response

Successful Response

object required