Skip to main content
POST
/
v2.0
/
lexicons
Create a new Lexicon
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/lexicons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "EU countries",
  "description": "Countries members of the European Union, e.g. Spain",
  "projectId": "<string>"
}'
{
  "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

​
Accept
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

Query Parameters

​
resourceId
string

An Id of a resource within the corresponding project to copy from

Required string length: 24
​
shouldGenerateLexiconEntries
boolean

Flag to allow the Lexicon creation to use the generative AI to generate entries.

​
languageCode
string

Language code.

Example:

"en-US"

​
shouldGenerateSynonyms
boolean

Flag to allow the Lexicon creation to use the generative AI to generate synonyms.

​
generateLexiconEntriesLimit
integer

Number of entries to be generated by the Generative AI.

​
defaultSlot
string

Default Slot where to associate the generated Lexicon entries.

Body

application/json
​
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"

​
projectId
string
Required string length: 24

Response

Returns Lexicon metadata 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
⌘I