Skip to main content
GET
/
v2.0
/
lexicons
/
{lexiconId}
/
keyphrases
Get keyphrases of a Lexicon
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/lexicons/{lexiconId}/keyphrases \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
[
  {
    "_id": "<string>",
    "mainKeyphrase": "<any>",
    "data": {},
    "keyphrases": {
      "_id": "<string>",
      "value": "pizza",
      "isMainKeyphrase": true
    },
    "slotReferences": [
      "<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

Path Parameters

​
lexiconId
string
required

The Id of the Lexicon

Required string length: 24

Query Parameters

​
projectId
string

Filter by projectId

Required string length: 24
​
filter
string

The value field to filter the lexicon keyphrases

​
limit
integer

The maximum number of items to return. The default is 25.

Required range: 1 <= x <= 100
​
skip
integer

The number of items to skip. The default is 0. Used along with a limit of a pagination.

Required range: x >= 0
​
sort
string

The order of the sorting items-desc (descending) or asc (ascending). For example, to sort the records by name in ascending order, specify name:asc.

Minimum length: 1
​
next
string

This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination.

Required string length: 24
​
previous
string

This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination.

Required string length: 24

Response

Returns array of a Lexicon Keyphrases

​
_id
string
Required string length: 24
​
mainKeyphrase
any

the keyphrase value

​
data
string

Additional JSON-data of the lexicon entry

Example:
{}
​
keyphrases
object
​
slotReferences
string[]

The used slots by the lexicon entry