Sep 25, 2025
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
Copy
1
2
3
4
5
6
7
8
9
10
require "algolia"
client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
response = client.save_synonym(
"ALGOLIA_INDEX_NAME",
"id1",
Algolia::Search::SynonymHit.new(algolia_object_id: "id1", type: "synonym", synonyms: ["car", "vehicule", "auto"]),
true
)
