Skip to main content
GET
/
v2.0
/
lexicons
/
{lexiconId}
/
entries
/
{entryId}
/
keyphrases
Get Keyphrases from a Lexicon Entry
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/lexicons/{lexiconId}/entries/{entryId}/keyphrases \
  --header 'X-API-Key: <api-key>'
[
  {
    "_id": "<string>",
    "mainKeyphrase": "pizza",
    "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

Headers

ā€‹
Accept
enum<string>

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.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
lexiconId
string
required

The unique identifier for the Lexicon.

Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
entryId
string
required

The unique identifier for the entry in the Lexicon.

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Query Parameters

ā€‹
projectId
string

The unique identifier for the Project.

Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
filter
string

The value field to filter the lexicon keyphrases

ā€‹
limit
integer

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.

Required range: 1 <= x <= 100
ā€‹
skip
integer

The number of items to skip before returning the results. Use this parameter with limit for offset-based pagination. The default value is 0.

Required range: x >= 0
ā€‹
sort
string

The 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.

Minimum string length: 1
ā€‹
next
string

The 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.

Required string length: 24
ā€‹
previous
string

The 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.

Required string length: 24

Response

Returns array of a Keyphrases of a Lexicon Entry

ā€‹
_id
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
mainKeyphrase
any

the keyphrase value

Example:

"pizza"

ā€‹
data
string

Additional JSON-data of the lexicon entry

Example:
{}
ā€‹
keyphrases
object
ā€‹
slotReferences
string[]

The used slots by the lexicon entry

Required string length: 24
Pattern: ^[a-z0-9]{24}$