Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Collection Documents

Batch Delete Documents

Batch delete multiple documents by explicit IDs or filters.

Supports TWO modes:

  1. Explicit IDs mode: Provide 'document_ids' array

    • Deletes specific documents by ID
    • Returns detailed per-document results
    • Maximum 1000 documents per batch

  2. Filter mode: Provide 'filters' to delete all matching documents

    • Deletes ALL documents matching the filters
    • Returns total count only
    • Use with caution - can delete many documents

Key Features:

  • Per-document success/failure reporting in explicit mode
  • Validates documents exist in the specified collection
  • Automatic document count update for the collection
  • Efficient bulk deletion

Examples: Explicit IDs mode: json { "document_ids": ["doc_123", "doc_456", "doc_789"] } 

Filter mode (logical AND/OR/NOT shape — NOT MVS-native must/key):
```json
{
    "filters": {"AND": [{"field": "metadata.status", "operator": "eq", "value": "archived"}]}
}
```
delete/v1/collections/{collection_identifier}/documents/batch

Path parameters

collection_identifierstring required

The ID of the collection to delete documents from.

The ID of the collection to delete documents from.

Request body

document_idsstring[] nullable

OPTIONAL. List of document IDs to delete. Use this mode when you know exact document IDs to delete. Mutually exclusive with filters mode. Maximum 1000 documents per batch request.

Example request

{
  "description": "Explicit IDs mode: Delete 3 specific documents",
  "document_ids": [
    "doc_123",
    "doc_456",
    "doc_789"
  ]
}

Response

Successful Response

deleted_countinteger required

Total number of documents successfully deleted

failed_countinteger

Total number of documents that failed to delete

messagestring

Summary message of the operation

Example response

{
  "deleted_count": 3,
  "failed_count": 0,
  "message": "Successfully deleted 3 document(s)",
  "results": [
    {
      "document_id": "doc_123",
      "success": true
    },
    {
      "document_id": "doc_456",
      "success": true
    },
    {
      "document_id": "doc_789",
      "success": true
    }
  ]
}