You're viewing an archived version of our docs. Check out our current documentation →

Retrieve a synonym

Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the search operation.

Usage

Required ACL: settings
1
2
3
4
5
require "algolia"

client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.get_synonym("ALGOLIA_INDEX_NAME", "id1")
Ruby API clients v3