Skip to main content
POST
/
v2.0
/
flows
/
{flowId}
/
intents
/
train
Create a Task to Train the Intents of Flow
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents/train \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "localeId": "<string>",
  "mode": "full"
}'
{
  "_id": "<string>",
  "status": "queued",
  "type": "trainIntents",
  "parameters": {},
  "lastChangedAt": 1594243850,
  "lastCreatedAt": 1594243850,
  "currentStep": 0,
  "totalStep": 100
}

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

​
flowId
string
required

The Id of the Flow

Required string length: 24

Query Parameters

​
filter
string

Filter records by specific field eg:name.

​
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

Body

application/json
​
localeId
string
Required string length: 24
​
mode
enum<string>
Available options:
full,
quick

Response

Successfully created Task to train Intents

​
_id
string
Required string length: 24
​
status
enum<string>

The status of the task

Available options:
queued,
active,
done,
cancelling,
cancelled,
error
Example:

"queued"

​
type
string
Example:

"trainIntents"

​
parameters
object
​
lastChangedAt
number
Example:

1594243850

​
lastCreatedAt
number
Example:

1594243850

​
currentStep
integer
Example:

0

​
totalStep
integer
Example:

100

⌘I