Api reference
Upsert synonyms (bulk replace)
Replaces all synonym groups for the index in one operation. Missing groups are deleted.
Replaces all synonym groups for the index in one operation. Missing groups are deleted.
Authorization
BearerAuth AuthorizationBearer <token>
Search API key (ss_search_*) from the dashboard or keys API. Scopes (search, ingest, admin) are stored on the key; each route requires the matching scope.
In: header
Path Parameters
indexId*string
Search index ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://loading/api/v1/indexes/string/synonyms" \ -H "Content-Type: application/json" \ -d '{ "synonyms": [ { "root": "string", "synonym": "string" } ] }'{
"synced": 0
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}{
"error": "string",
"message": "string",
"details": null
}