v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Delete Knowledge Base Document Or Folder

Delete a document or folder from the knowledge base.

delete/v1/convai/knowledge-base/{documentation_id}

Path parameters

documentation_idstring required

The id of a document from the knowledge base. This is returned on document addition.

Example:21m00Tcm4TlvDq8ikWAM

The id of a document from the knowledge base. This is returned on document addition.

Query parameters

forceboolean

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

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

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.

Response

Successful Response

{"stackTrail":"paths:/v1/convai/knowledge-base/{documentation_id}:delete:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}