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 Lexicon Entries
Gets entries from a Lexicon. By default, 25 entries are returned. To change this value, use the limit query parameter. Additionally, you can filter, sort, and paginate the results.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/lexicons/{lexiconId}/entries \
--header 'X-API-Key: <api-key>'[
{
"_id": "<string>",
"mainKeyphrase": "pizza",
"data": {},
"keyphrases": {
"_id": "<string>",
"value": "pizza",
"isMainKeyphrase": true
},
"slotReferences": [
"<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
The unique identifier for the Project.
24^[a-z0-9]{24}$The maximum number of items to return. Use this parameter to control page size. The default value is 25, and the maximum permitted value is 100.
1 <= x <= 100The number of items to skip before returning the results. Use this parameter with limit for offset-based pagination. The default value is 0.
x >= 0The order in which results are returned. Set a sorting rule in the format field:direction, where direction can be asc for ascending order or desc for descending order. For example, name:asc sorts by name in ascending order.
1The cursor that points to the next page of results. Use the nextCursor value returned in a previous response to request the next set of items.
24The cursor that points to the previous page of results. Use the previousCursor value returned in a previous response to request the previous set of items.
24Response
Returns array of a Lexicon Entries
24^[a-z0-9]{24}$the keyphrase value
"pizza"
Additional JSON-data of the lexicon entry
{}Show child attributes
Show child attributes
The used slots by the lexicon entry
24^[a-z0-9]{24}$curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/lexicons/{lexiconId}/entries \
--header 'X-API-Key: <api-key>'[
{
"_id": "<string>",
"mainKeyphrase": "pizza",
"data": {},
"keyphrases": {
"_id": "<string>",
"value": "pizza",
"isMainKeyphrase": true
},
"slotReferences": [
"<string>"
]
}
]