v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Flows

Get Flow Settings

Gets Flow settings, including execution behavior, Slot parsing, Intent mapping, default replies, locale settings, thresholds, Yes/No logic, and Slot usage. All metadata, such as creation and modification timestamps and user information, is also included.

get/v2.0/flows/{flowId}/settings

Path parameters

flowIdstring required

The unique identifier for the Flow.

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 the Flow Settings object.

continueExecutionAfterAttachedFlowboolean

continueExecutionAterDefaultReplyboolean

continueExecutionAfterNegativeConfirmationboolean

passDefaultRepliesIntoFlowboolean

flowIntentMappingOrder'joint' | 'main' | 'attached'

useAttachedFlowThresholdsboolean

useAttachedFlowContinueAfterDefaultReplyboolean

useAttachedFlowPassDefaultRepliesIntoFlowboolean

implicitSlotParsing'disabled' | 'full' | 'system' | 'lexicon'

useAttachedFlowImplicitSlotParsingboolean

lexiconSlotsWithSubMatchesboolean

useIntentDefaultRepliesAsExamplesboolean

Enable/Disable using default replies as training examples.

learnNewExampleSentencesboolean

learnNewExampleSentencesThresholdinteger

negativeConfirmationWordsstring[]

positiveConfirmationWordsstring[]

yesNoLogic'yesNoIntents' | 'yesNoIntentsWithRules' | 'confirmationWords'

yesNoIntentThresholdinteger

_idstring

createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring

lastChangedBystring

Example response

{
  "intentThreshold": {
    "lower": 0.4,
    "upper": 0.5
  },
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}