Get a Lexicon - Cognigy Documentation

GET

v2.0

lexicons

{lexiconId}

Get a Lexicon

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

{
  "name": "EU countries",
  "description": "Countries members of the European Union, e.g. Spain",
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "values": "<any>",
  "_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

Authorization

string

header

required

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

api_key

string

query

required

Supply the API Key in the Url-Query

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

Query Parameters

metaOnly

boolean

Return only the lexicon meta data if set to true

Response

Returns Lexicon 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.

name

string

The name of the lexicon

Example:

"EU countries"

description

string

A meaningful description of the lexicon

Example:

"Countries members of the European Union, e.g. Spain"

referenceId

string<uuid>

values

any

deprecated

_id

string

Required string length: 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

lastChangedBy

string

Required string length: 24

Delete a LexiconDelete a [Lexicon](doc:lexicon) resource in a project.

⌘I

Get a Lexicon

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

{
  "name": "EU countries",
  "description": "Countries members of the European Union, e.g. Spain",
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "values": "<any>",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}