Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Overview
API
- GETGet Lexicons
- POSTCreate a New Lexicon
- PATCHPerform Batch Operations on Lexicons
- GETGet a Lexicon
- DELDelete a Lexicon
- PATCHUpdate a Lexicon
- POSTCreate a Download Link for a Lexicon
- GETGet Lexicon Entries
- POSTCreate a Lexicon Entry
- PATCHPerform Batch Operations in a Lexicon
- GETGet a Lexicon Entry
- DELDelete a Lexicon Entry
- PATCHUpdate a Lexicon Entry
- GETGet Keyphrases from a Lexicon Entry
- POSTAdd a Keyphrase to a Lexicon
- POSTDelete a Keyphrase
- POSTAdd a Slot to a Lexicon
- POSTDelete a Lexicon Slot
- GETExport a Lexicon
- POSTImport a Lexicon
- GETGet Keyphrases in a Lexicon
- PATCHUpdate a Keyphrase
- GETGet Lexicon Slots
- POSTCreate a Lexicon Slot
- PATCHPerform Batch Operations in a Lexicon
- DELDelete a Lexicon Slot
- PATCHUpdate a Lexicon Slot
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Get a Lexicon
Gets a Lexicon from a Project.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/lexicons/{lexiconId} \
--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": "<unknown>",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
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.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The unique identifier for the Lexicon.
24^[a-z0-9]{24}$Query Parameters
If set to true, returns only Lexicon metadata.
true, false 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.
The name of the lexicon
"EU countries"
A meaningful description of the lexicon
"Countries members of the European Union, e.g. Spain"
24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/lexicons/{lexiconId} \
--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": "<unknown>",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}