LLM-readable documentation index
Open Dashboard
ApiV3Generated
DocumentationAPI Reference

Entity Synonyms

Overview of the Entity Synonyms API

Hand off to an LLM

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-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 canonical entity, so a synonym added to a stale id lands on the entity that persists.