Replace Synonyms

PUT

https://acme.captain.dev/v1/indexes/:index/synonyms

PUT

/v1/indexes/:index/synonyms

import json
import requests
import uuid
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_write_key"
INDEX = "products"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json",
    "Idempotency-Key": str(uuid.uuid4()),
}
response = requests.put(
    f"{BASE_URL}/v1/indexes/{INDEX}/synonyms",
    headers=headers,
    json={
        "synonyms": [
            {
                "objectID": "s1",
                "type": "synonym",
                "synonyms": ["sofa", "couch", "settee"],
            },
            {
                "objectID": "s2",
                "type": "oneWaySynonym",
                "input": "tv",
                "synonyms": ["television"],
            },
        ],
    },
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

200Updated

{
  "synonyms": [
    {
      "objectID": "s1",
      "type": "synonym",
      "synonyms": [
        "sofa",
        "couch",
        "settee"
      ]
    },
    {
      "objectID": "s2",
      "type": "oneWaySynonym",
      "input": "tv",
      "synonyms": [
        "television"
      ]
    }
  ]
}

Replace the index's synonyms. They apply to the next search, with no rebuild.

Authentication

AuthorizationBearer

A write key, issued by Captain. Server side only. Sent as Authorization: Bearer <key>.

Path parameters

indexstringRequiredformat: "^[a-z0-9][a-z0-9_-]{0,47}$"

index name

Request

This endpoint expects an object.

synonymslist of objectsOptional

Response headers

X-Captain-Applied-Seqinteger

the last update seq search had applied when this request started; the answer reflects at least that much (GET …/updates applied_seq). Not on 401 or 403, nor for an index this server does not have

X-Captain-Index-IncarnationstringOptional

the index’s incarnation, an opaque string: it changes only when the index is deleted and created again (whose seqs start again at 1), or restored from a backup (whose seqs continue from the backup’s). Sent with X-Captain-Applied-Seq

Response

saved

Authentication

Path parameters

Headers

Request

Response headers

Response