Bem Entity Synonyms API
Manage the human-readable surface forms (synonyms) attached to a canonicalentity. Synonyms feed the matcher's exact-match path, so adding the rightsynonyms improves cross-document entity resolution.- **`POST /v3/entities/{id}/synonyms`** attaches a `customer_defined` synonym. If the same normalized form already exists as an `extracted` synonym, it is upgraded to `customer_defined` (so the matcher weights it higher); an existing customer/SME synonym is returned unchanged.- **`DELETE /v3/entities/{id}/synonyms/{synonymID}`** soft-deletes a synonym. Only `customer_defined` and `sme_approved` synonyms are deletable; `extracted` synonyms are resolver-owned and the request is rejected with `409 Conflict`.A merged-away entity id transparently resolves to its surviving canonicalentity, so a synonym added to a stale id lands on the entity that persists.
Bem Entity Synonyms API is one of 22 APIs that Bem publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Entity Synonyms. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.bem.ai, https://api.eu1.bem.ai.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Bem Entity Synonyms API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as x-api-key (API Key).
By default, every request must be authenticated.
API Key— Authenticate using API Key in request header
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 DELETE, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Manage the human-readable surface forms (synonyms) attached to a canonical entity. Synonyms feed the matcher's exact-match path, so adding the right synonyms improves cross-docume…
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are EntitySynonymV3 (6 properties), AddEntitySynonymRequestV3 (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Bem 12
Other APIs Bem publishes across the network.
This is an independent, third-party profile of Bem Entity Synonyms API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.