Documents

Bulk Delete Documents

⚠️ This endpoint is deprecated and will be removed in 2.0.0. Please use the Bulk delete documents endpoint instead.

Deletes multiple documents based on the provided filter criteria. This endpoint allows for efficient batch deletion of documents matching specified parameters.

At least one filter parameter must be provided (title, document_id, start_date, or end_date).

When successful, the endpoint returns a summary of the deletion operation, including count of successfully deleted documents and any skipped documents.

delete/api/documents

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Query parameters

titlestring

String to filter by Document Title

document_idstring

Filter documents by document ID

start_datestring date-time

Filter documents created on or after this date (ISO 8601 format, e.g. 2025-05-13T17:00:00Z)

end_datestring date-time

Filter documents created on or before this date (ISO 8601 format, e.g. 2025-05-13T17:00:00Z)

Response

Documents were successfully deleted

deleted_countinteger

Number of documents successfully deleted

skipped_countinteger

Number of documents that were skipped due to access restrictions or other issues

total_matchedinteger

Total number of documents that matched the filter criteria

Changes

No recorded changes to this operation across all 1 revision of this API.