Skip to main content
POST
/
v2.0
/
flows
/
{flowId}
/
intents
Create an Intent
curl --request POST \
  --url 'https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/intents?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "OrderFood",
  "description": "Intent to order food",
  "condition": "<string>",
  "rules": [
    "<string>"
  ],
  "isRejectIntent": true,
  "isDisabled": true,
  "tags": [
    "<string>"
  ],
  "confirmationSentences": [
    "<string>"
  ],
  "disambiguationSentence": "<string>",
  "data": {},
  "localeReference": "<string>",
  "childFeatures": false,
  "biasTowardsParentOrChildIntents": "parents",
  "parentIntentId": "<string>",
  "analyticsLabel": "<string>",
  "overrideIntentDefaultRepliesAsExamples": "on"
}
'
{
  "name": "OrderFood",
  "description": "Intent to order food",
  "condition": "<string>",
  "rules": [
    "<string>"
  ],
  "isRejectIntent": true,
  "isDisabled": true,
  "tags": [
    "<string>"
  ],
  "confirmationSentences": [
    "<string>"
  ],
  "disambiguationSentence": "<string>",
  "data": {},
  "localeReference": "<string>",
  "childFeatures": false,
  "biasTowardsParentOrChildIntents": "parents",
  "parentIntentId": "<string>",
  "analyticsLabel": "<string>",
  "overrideIntentDefaultRepliesAsExamples": "on",
  "_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

​
api_key
string
query
required

Supply the API Key in the Url-Query

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

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
Pattern: ^[a-z0-9]{24}$

Query Parameters

​
shouldGenerateSentences
boolean
​
generateSentenceLimit
integer
Required range: 5 <= x <= 20

Body

application/json
​
name
string
Example:

"OrderFood"

​
description
string
Example:

"Intent to order food"

​
condition
string
​
rules
string[]
​
isRejectIntent
boolean
​
isDisabled
boolean
​
tags
string[]
​
confirmationSentences
string[]
​
disambiguationSentence
string
​
data
object
​
localeReference
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
childFeatures
Example:

false

​
biasTowardsParentOrChildIntents
enum<string>
Available options:
parents,
children
​
parentIntentId
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
analyticsLabel
string
​
overrideIntentDefaultRepliesAsExamples
enum<string>

Toggle overriding the flow setting for using default replies as training examples

Available options:
on,
off,
useFlowSettings

Response

Returns Intent metadata 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.

​
name
string
Example:

"OrderFood"

​
description
string
Example:

"Intent to order food"

​
condition
string
​
rules
string[]
​
isRejectIntent
boolean
​
isDisabled
boolean
​
tags
string[]
​
confirmationSentences
string[]
​
disambiguationSentence
string
​
data
object
​
localeReference
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
childFeatures
Example:

false

​
biasTowardsParentOrChildIntents
enum<string>
Available options:
parents,
children
​
parentIntentId
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
​
analyticsLabel
string
​
overrideIntentDefaultRepliesAsExamples
enum<string>

Toggle overriding the flow setting for using default replies as training examples

Available options:
on,
off,
useFlowSettings
​
_id
string
Required string length: 24
Pattern: ^[a-z0-9]{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
Pattern: ^[a-z0-9]{24}$
​
lastChangedBy
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$