Synonyms API client methods

This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.

This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.

This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.

This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.

List of methods

Save synonym saveSynonym saveSynonym saveSynonym save_synonym save_synonym saveSynonym saveSynonym SaveSynonym saveSynonym save synonym	Add a synonym to an index or replace it.
Save synonyms saveSynonyms saveSynonyms saveSynonyms save_synonyms save_synonyms SaveSynonyms saveSyonyms SaveSynonyms saveSynonyms save synonyms	Create or update multiple synonyms.
Delete synonym deleteSynonym deleteSynonym deleteSynonym delete_synonym delete_synonym DeleteSynonym deleteSynonym DeleteSynonym deleteSynonym delete synonym	Remove a single synonym from an index using its object id.
Clear all synonyms clearSynonyms clearSynonyms clearSynonyms clear_synonyms clear_synonyms ClearSynonyms clearSynonyms ClearSynonyms clearSynonyms clear synonyms	Remove all synonyms from an index.
Get synonym getSynonym getSynonym getSynonym get_synonym get_synonym GetSynonym getSynonym GetSynonym getSynonym get synonym	Get a single synonym object using its synonym ID (`objectID`).
Search synonyms searchSynonyms searchSynonyms searchSynonyms search_synonyms search_synonyms SearchSynonyms searchSynonyms SearchSynonyms searchSynonyms search synonyms	Get all synonyms that match a query.
Replace all synonyms replaceAllSynonyms replaceAllSynonyms replaceAllSynonyms replace_all_synonyms replace_all_synonyms ReplaceAllSynonyms replaceAllSynonyms ReplaceAllSynonyms replaceAllSynonyms Replace all synonyms	Push a new set of synonyms and erase all previous ones.
Copy synonyms copySynonyms copySynonyms copySynonyms copy_synonyms copy_synonyms CopySynonyms Copy synonyms CopySynonyms copy Copy synonyms	Copy the synonyms of an index to another index on the same app.
Export Synonyms browseSynonyms browseSynonyms browseSynonyms index.browse_synonyms() browse_synonyms BrowseSynonyms SynonymsIterable BrowseSynonyms browseSynonyms exportSynonyms	Retrieve an index’s complete list of synonyms.

Did you find this page helpful?