Export Synonyms
Required API Key:
any key with the
settings
ACL
index.browseSynonyms({ // A `batch` callback function that's called // on every batch of synonyms with the // signature: (synonyms: Synonyms[]) => any batch: function }) index.browseSynonyms({ // A `batch` callback function that's called // on every batch of synonyms with the // signature: (synonyms: Synonyms[]) => any batch: function, // All the following parameters are optional // + any requestOptions })
You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.
You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.
About this method # A
Retrieve an index’s complete list of synonyms.
The list includes all synonyms - whether created on the dashboard or pushed by the API.
The method returns an iterator.
You can import and export synonyms from the Algolia dashboard.
Examples # A
Read the Algolia CLI documentation for more information.
1
2
3
4
5
index.browseSynonyms({
batch: batch => console.log(batch),
}).then(() => {
// done
});
Parameters # A
Response # A
Returns a synonym iterator.