Returns all active synonyms for a given language as a plain-text file, with one synonym definition per line. This is used to supply synonym lists to the search engine configuration.
Requires the synonym:read or search.read permission.
Request
GET /synonym/file/{language}
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
language | string | Yes | The language code for which to export synonyms (e.g. de, en). |
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Example Request
GET /synonym/file/de
Authorization: Bearer <token>Response
Returns a plain-text file (text/plain) with the filename {language}.txt. Each line contains one synonym definition string.
Example Response
car,automobile,vehicle
couch,sofa,settee