Get Synonym

1
synonym = index.get_synonym('synonymID')

1
2
3
index.getSynonym('synonymID').then(synonym => {
  console.log(synonym);
});

1
synonym = index.get_synonym('synonymID')

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

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

1
2
3
4
Synonym synonym = index.GetSynonym("synonymID");

// Asynchronous
Synonym synonym = index.GetSynonymAsync("synonymID");

1
2
3
4
Synonym synonym = index.getSynonym("synonymID");

// Async version
CompletableFuture<Synonym> synonym = index.getSynonym("synonymID");

1
synonym, err := index.GetSynonym("synonymID")

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

1
2
# List all synonyms in the "indexName" index
algolia synonym browse indexName

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

A successful response is 200 OK and contains the synonym object:

{
  "synonymID": "syn-1657790369271-1916",
  "type": "synonym",
  "synonyms": [ "iphone", "apple phone"]
}

If synonyms couldn't be found, the response is 404 Not Found:

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