Create Synonym Group

Creates a synonym group.

POST /api/synonymsgroup

Create Synonym Group

cURL

curl --request POST \
  --url https://api.cludo.com/api/synonymsgroup \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "words": [
    "<string>"
  ],
  "language": "<string>"
}
'

import requests

url = "https://api.cludo.com/api/synonymsgroup"

payload = {
    "words": ["<string>"],
    "language": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({words: ['<string>'], language: '<string>'})
};

fetch('https://api.cludo.com/api/synonymsgroup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({words: ['<string>'], language: '<string>'})
};

fetch('https://api.cludo.com/api/synonymsgroup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "groupId": 123,
  "words": [
    "<string>"
  ],
  "language": "<string>"
}

{
  "groupId": 123,
  "words": [
    "<string>"
  ],
  "language": "<string>"
}

{
  "message": "The request could not be processed. Check the request body and required parameters."
}

{
  "message": "unauthorized"
}

{
  "status": "InternalServerError",
  "code": 500,
  "messages": [
    "Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ]
}

Authorizations

Authorization · string · header · required

Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5.

Body

application/json

words · string[] · required

Initial synonym list (minimum two terms is common).

language · string · required

A two-letter ISO language code (e.g. en, da, de) the synonyms belong to.

Response

200

application/json

Synonym group created successfully.

groupId · integer · required

Synonym group ID (assigned by server on create).

words · string[] · required

Equivalents treated as the same intent for search (e.g. motorcycle, bike).

language · string · required

A two-letter ISO language code (e.g. en, da, de) this group applies to.