v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Intent Trainer

Get Trainer Records

Gets Intent Trainer records in a Project. By default, 25 Trainer Records are returned. To change this value, use the limit query parameter. Additionally, you can filter, sort, and paginate the results.

get/v2.0/trainer

Query parameters

projectIdstring

The unique identifier for the Project.

filterstring

The string to filter Intent Trainer records by text.

limitinteger

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.

skipinteger

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

sortstring

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.

nextstring

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.

previousstring

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.

understood'false' | 'true'

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

intentFound'false' | 'true'

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

slotFound'false' | 'true'

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

userSlotsFound'false' | 'true'

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

systemSlotsFound'false' | 'true'

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

typestring[]

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

scoreRangenumber[]

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

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Response

Returns the Trainer Records with pagination

totalinteger
nextCursorstring nullable
previousCursorstring nullable

Example response

{
  "items": [
    {
      "text": "I want a Pizza",
      "count": 2,
      "createdAt": 1694518620,
      "lastChanged": 1694518620
    }
  ],
  "total": 1
}