Add a Synonym to an Entity

Authorization

API Key

x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

id*string

Entity public ID (ent_...). A merged-away id resolves to the surviving entity.

Query Parameters

bucket?string

Optional bucket public ID (bkt_...) to scope the entity lookup to one bucket. Omit for the unscoped (all account+environment) view.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

text*string

The human-readable synonym surface form to attach (e.g. Acme Corp, ACME). It is normalized (lowercased, whitespace-folded) for the uniqueness key and the matcher's exact-match path.

locale?string

Optional BCP 47 locale tag (e.g. en-US) for language-specific synonyms.

Response Body

`application/json`

curl -X POST "https://api.bem.ai/v3/entities/string/synonyms" \  -H "Content-Type: application/json" \  -d '{    "text": "ACME Corporation",    "locale": "en-US"  }'

{
  "synonymID": "string",
  "text": "string",
  "normalizedText": "string",
  "source": "extracted",
  "locale": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}