Skip to main content
GET
/
v2.0
/
trainer
Get Trainer Records
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/trainer \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "text": "I want a Pizza",
      "count": 2,
      "flowReferenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "handled": true,
      "handleAction": "addedToIntent",
      "nlu": {},
      "meta": {},
      "snapshotReference": "<string>",
      "_id": "<string>",
      "createdAt": 1694518620,
      "lastChanged": 1694518620,
      "createdBy": "<string>",
      "lastChangedBy": "<string>"
    }
  ],
  "total": 1,
  "nextCursor": "<string>",
  "previousCursor": "<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

Query Parameters

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

The string to filter Intent Trainer records by text.

​
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
​
understood
enum<string>

If set to true, filters Intent Trainer records for which the user input was marked as understood.

Available options:
false,
true
​
intentFound
enum<string>

If set to true, filters Intent Trainer records for which an Intent was found.

Available options:
false,
true
​
slotFound
enum<string>

If set to true, filters Intent Trainer records for which a Slot was found.

Available options:
false,
true
​
userSlotsFound
enum<string>

If set to true, filters Intent Trainer records for which user-defined Slots were found.

Available options:
false,
true
​
systemSlotsFound
enum<string>

If set to true, filters Intent Trainer records for which system-defined Slots were found.

Available options:
false,
true
​
type
enum<string>[]

The Intent type to filter Intent Trainer records by. You can enter the following values: Greeting, pAnswer, nAnswer, BGreeting.

Available options:
Greeting,
pAnswer,
nAnswer,
BGreeting
​
scoreRange
number[]

The Intent score range to filter by, for example, [0.3,0.6].

Required array length: 2 elements

Response

Returns the Trainer Records with pagination

​
items
object[]
​
total
integer
Example:

1

​
nextCursor
string | null
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
previousCursor
string | null
Required string length: 24
Pattern: ^[a-z0-9]{24}$