Add or replace a record

If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index.

If you want to use auto-generated object IDs, use the saveObject operation. To update some attributes of an existing record, use the partial operation instead. To add, update, or replace multiple records, use the batch operation.

Usage

Required ACL: addObject
1
2
3
4
5
6
7
8
9
10
11
12
13
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.add_or_update_object(
    index_name="ALGOLIA_INDEX_NAME",
    object_id="uniqueID",
    body={
        "key": "value",
    },
)
Did you find this page helpful?
Python API clients v4