Delete records matching a query

This operation doesn’t accept empty queries or filters.

It’s more efficient to get a list of object IDs with the browse operation, and then delete the records using the batch operation.

Usage

Required ACL: deleteIndex
1
2
3
4
5
6
7
8
9
10
11
from algoliasearch.search.client import SearchClientSync

# In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods.
client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.delete_by(
    index_name="ALGOLIA_INDEX_NAME",
    delete_by_params={
        "filters": "brand:brandName",
    },
)
Did you find this page helpful?
Python API clients v4