Batch indexing operations on one index

Adds, updates, or deletes records in one index with a single API request.

Batching index updates reduces latency and increases data integrity.

  • Actions are applied in the order they’re specified.
  • Actions are equivalent to the individual API requests of the same name.

This operation is subject to indexing rate limits.

Usage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
from algoliasearch.search.client import SearchClientSync
from json import loads

# 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.batch(
    index_name="ALGOLIA_INDEX_NAME",
    batch_write_params={
        "requests": [
            {
                "action": "addObject",
                "body": {
                    "key": "bar",
                    "foo": "1",
                },
            },
            {
                "action": "addObject",
                "body": {
                    "key": "baz",
                    "foo": "2",
                },
            },
        ],
    },
)
Did you find this page helpful?
Python API clients v4