v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Lexicons

Create a Lexicon Entry

Creates a Lexicon entry with a Keyphrase and optional Lexicon Slots.

post/v2.0/lexicons/{lexiconId}/entries

Path parameters

lexiconIdstring required

The unique identifier for the Lexicon.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

datastring

Additional JSON-data of the lexicon entry

slotReferencesstring[]

The used slots by the lexicon entry

mainKeyphrasestring required

the keyphrase value

Example request

{
  "data": "{\"key1\": \"value1\" }",
  "mainKeyphrase": "pizza"
}

Response

Created Entry Object.

datastring

Additional JSON-data of the lexicon entry

slotReferencesstring[]

The used slots by the lexicon entry

mainKeyphrasestring required

the keyphrase value

_idstring

createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring

lastChangedBystring

Example response

{
  "data": "{\"key1\": \"value1\" }",
  "mainKeyphrase": "pizza",
  "keyphrases": {
    "value": "pizza",
    "isMainKeyphrase": true
  },
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}