Skip to main content
GET
/
v2.0
/
trainer
/
{recordId}
Get a TrainerRecord
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/trainer/{recordId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "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>"
}

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

​
recordId
string
required

The Id of the Record

Required string length: 24

Response

Returns TrainerRecord Object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
text
string

The text of the user

Example:

"I want a Pizza"

​
count
number

How often the text was used as an input

Example:

2

​
flowReferenceId
string<uuid>
​
handled
boolean
​
handleAction
enum<string>
Available options:
addedToIntent,
skip,
ignored
​
nlu
object

The last NLU object that was created (from InputObject) based on the message

​
meta
object
​
snapshotReference
string

Reference to a snapshot in case this record was created because a user talked to a snapshot

​
_id
string
Required string length: 24
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
​
lastChangedBy
string
Required string length: 24