Get a Lexicon Entry - Cognigy Documentation

GET

v2.0

lexicons

{lexiconId}

entries

{entryId}

Get a Lexicon Entry

curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/lexicons/{lexiconId}/entries/{entryId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "mainKeyphrase": "pizza",
  "data": "{\"key1\": \"value1\" }",
  "slotReferences": [
    "<string>"
  ],
  "keyphrases": {
    "_id": "<string>",
    "value": "pizza",
    "isMainKeyphrase": true
  },
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

api_key

string

query

required

Supply the API Key in the Url-Query

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

lexiconId

string

required

The Id of the Lexicon

Required string length: 24

Pattern: ^[a-z0-9]{24}$

entryId

string

required

The id of an entry in the Lexicon

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Response

Returns Lexicon Entry Object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

mainKeyphrase

string

required

the keyphrase value

Example:

"pizza"

data

string

Additional JSON-data of the lexicon entry

Example:

"{\"key1\": \"value1\" }"

slotReferences

string[]

The used slots by the lexicon entry

Required string length: 24

Pattern: ^[a-z0-9]{24}$

keyphrases

object

Show child attributes

_id

string

Required string length: 24

Pattern: ^[a-z0-9]{24}$

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

createdBy

string

Required string length: 24

Pattern: ^[a-z0-9]{24}$

lastChangedBy

string

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Delete a Lexicon EntryDeletes a [Lexicon entry](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon.

Get a Lexicon Entry

curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/lexicons/{lexiconId}/entries/{entryId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "mainKeyphrase": "pizza",
  "data": "{\"key1\": \"value1\" }",
  "slotReferences": [
    "<string>"
  ],
  "keyphrases": {
    "_id": "<string>",
    "value": "pizza",
    "isMainKeyphrase": true
  },
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Overview

API

Authorizations

Headers

Path Parameters

Response