Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Intents

Get an Intent

Gets an Intent from a Flow.

get/v2.0/flows/{flowId}/intents/{intentId}

Path parameters

flowIdstring required

The unique identifier for the Flow.

intentIdstring required

The unique identifier for the Intent.

Query parameters

preferredLocaleIdstring

The unique identifier for the Locale for the response.

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 an Intent 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
}