Api reference
Delete documents by query
Deletes all documents matching a Typesense filter expression. Requires admin scope. This is a direct Typesense operation (not buffered). Returns the number of deleted documents.
Deletes all documents matching a Typesense filter expression. Requires admin scope. This is a direct Typesense operation (not buffered). Returns the number of deleted documents.
Authorization
BearerAuth AuthorizationBearer <token>
Search API key (ss_search_*) from the dashboard or keys API. Scopes (search, ingest, admin) are stored on the key; each route requires the matching scope.
In: header
Path Parameters
indexId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
filterBy*string
Typesense filter expression. E.g. 'price:>100' or 'category:=electronics'
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/api/v1/indexes/string/documents/delete-by-query" \ -H "Content-Type: application/json" \ -d '{ "filterBy": "string" }'{
"deleted": 0,
"filterBy": "string"
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}Empty