Create or replace a synonym

If a synonym with the specified object ID doesn’t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the batch operation.

Usage

Required ACL: editSettings
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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.save_synonym(
    index_name="ALGOLIA_INDEX_NAME",
    object_id="id1",
    synonym_hit={
        "objectID": "id1",
        "type": "synonym",
        "synonyms": [
            "car",
            "vehicule",
            "auto",
        ],
    },
    forward_to_replicas=True,
)
Did you find this page helpful?
Python API clients v4