v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Lexicons

Create a New Lexicon

Creates a Lexicon in a Project.

post/v2.0/lexicons

Query parameters

resourceIdstring

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

shouldGenerateLexiconEntriesboolean

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

languageCodestring

Example:en-US

Language code.

shouldGenerateSynonymsboolean

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

generateLexiconEntriesLimitinteger

Number of entries to be generated by the Generative AI.

defaultSlotstring

Default Slot where to associate the generated Lexicon entries.

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

namestring

The name of the lexicon

descriptionstring

A meaningful description of the lexicon

projectIdstring

The unique identifier for the Project.

Example request

{
  "name": "EU countries",
  "description": "Countries members of the European Union, e.g. Spain"
}

Response

Returns Lexicon metadata object.

namestring

The name of the lexicon

descriptionstring

A meaningful description of the lexicon

referenceIdstring uuid

{"stackTrail":"paths:/v2.0/lexicons:post:responses:201:content:application/json:schema:properties:values","oasType":"schema","type":"unknown"}

_idstring

createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring

lastChangedBystring

Example response

{
  "name": "EU countries",
  "description": "Countries members of the European Union, e.g. Spain",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}