v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Intents

Create an Intent

Creates an Intent in a Flow.

post/v2.0/flows/{flowId}/intents

Path parameters

flowIdstring required

The unique identifier for the Flow.

Query parameters

shouldGenerateSentencesboolean
generateSentenceLimitinteger

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.

Request body

namestring
descriptionstring
conditionstring
rulesstring[]
isRejectIntentboolean
isDisabledboolean
tagsstring[]
confirmationSentencesstring[]
disambiguationSentencestring
dataobject
localeReferencestring
biasTowardsParentOrChildIntents'parents' | 'children'
parentIntentIdstring
analyticsLabelstring
overrideIntentDefaultRepliesAsExamples'on' | 'off' | 'useFlowSettings'

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

Example request

{
  "name": "OrderFood",
  "description": "Intent to order food"
}

Response

Returns Intent metadata object.

namestring
descriptionstring
conditionstring
rulesstring[]
isRejectIntentboolean
isDisabledboolean
tagsstring[]
confirmationSentencesstring[]
disambiguationSentencestring
dataobject
localeReferencestring
biasTowardsParentOrChildIntents'parents' | 'children'
parentIntentIdstring
analyticsLabelstring
overrideIntentDefaultRepliesAsExamples'on' | 'off' | 'useFlowSettings'

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

_idstring
createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring
lastChangedBystring

Example response

{
  "name": "OrderFood",
  "description": "Intent to order food",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}