Delete Document
Endpoint
DELETE /apiops/projects/{projectName}/knowledge-bases/{kbName}/documents/{documentId}/
Authentication
Requires a Personal API Access Token.
Header
Authorization: Bearer YOUR_TOKEN
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer {token} | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| projectName | string | Yes | Project name |
| kbName | string | Yes | Knowledge base name (parent, resolved by name) |
| documentId | string | Yes | Document id (documents are referenced by id, not name) |
Query Parameters
None
Response
Success Response (200 OK)
{
"status": "SUCCESS",
"deploymentResult": {
"success": true
}
}
Error Response (400 Bad Request)
{
"status": "FAILURE",
"resultMessage": "Document id can not be empty!"
}
or
{
"status": "FAILURE",
"resultMessage": "Knowledge base (name: product-docs) was not found!"
}
Error Response (401 Unauthorized)
{
"status": "FAILURE",
"resultMessage": "Token is not valid!"
}
cURL Example
curl -X DELETE \
"https://demo.apinizer.com/apiops/projects/MyProject/knowledge-bases/product-docs/documents/6651b3c4e4b0c3a2d1f0aaaa/" \
-H "Authorization: Bearer YOUR_TOKEN"
Notes and Warnings
- Id-Based (Deliberate Exception): The document is addressed by
documentId, not by name. The parent knowledge base is resolved bykbNamefirst. - Ownership Enforcement: The document is resolved by
documentIdANDknowledgeBaseIdANDprojectIdbefore deletion, so a document id from another knowledge base or project cannot be deleted. - Vector Purge: Deleting a document also removes its indexed chunks from the VectorDB. This operation is irreversible.
- Knowledge Base Preserved: Only the single document is removed; the knowledge base and its other documents are untouched. To remove the whole knowledge base, use Delete Knowledge Base.
- Permissions: Requires
AI_DEVELOPMENT+MANAGEpermission in the project.
Related Documentation
- List Documents - Discover document ids
- Upload Document - Add a document to the knowledge base
- Delete Knowledge Base - Remove the whole knowledge base instead
- Knowledge Bases API - Resource overview