Get Synonym

1
synonym = index.get_synonym('a-unique-identifier')

1
2
3
index.getSynonym('a-unique-identifier').then(synonym => {
  console.log(synonym);
});

1
synonym = index.get_synonym('a-unique-identifier')

1
2
3
4
5
index.getSynonym(withID: "myID") { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
Synonym synonym = index.GetSynonym("a-unique-identifier");

// Asynchronous
Synonym synonym = index.GetSynonymAsync("a-unique-identifier");

1
2
3
4
Synonym synonym = index.getSynonym("a-unique-identifier");

// Async version
CompletableFuture<Synonym> synonym = index.getSynonym("a-unique-identifier");

1
synonym, err := index.GetSynonym("a-unique-identifier")

1
2
3
var synonym: Future[Synonym] = client.execute {
    get synonym "a-unique-identifier" from "index_name"
}

1
index.getSynonym(ObjectID("myID"))

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl -X GET \
     -H "X-Algolia-API-Key: ${API_KEY}" \
     -H "X-Algolia-Application-Id: ${APPLICATION_ID}" \
    "https://${APPLICATION_ID}.algolia.net/1/indexes/{indexName}/synonyms/{objectID}"


Upon success, the response is 200 OK and contains the synonym object:


{
  "objectID": "1",
  "type": "synonym",
  "synonyms": [ "iphone", "ephone", "aphone", "yphone", "apple phone"]
}


If the synonyms could not be found, the response is 404 Not Found:


{"message":"Synonym set does not exist","status":404}