Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Overview
API
- GETGet Flows
- POSTCreate a Flow
- PATCHPerform Batch Operations on Flows
- GETGet a Flow
- DELDelete a Flow
- PATCHUpdate a Flow
- POSTAdd a Locale to a Flow
- GETGet the Chart of specified Flow
- POSTCreate a Flow from a Child Node
- POSTClone a Flow
- POSTRemove a Locale from a Flow
- GETGet Flow Settings
- PATCHUpdate Flow Settings
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
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.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/settings \
--header 'X-API-Key: <api-key>'{
"continueExecutionAfterAttachedFlow": true,
"continueExecutionAterDefaultReply": true,
"continueExecutionAfterNegativeConfirmation": true,
"passDefaultRepliesIntoFlow": true,
"flowIntentMappingOrder": "joint",
"useAttachedFlowThresholds": true,
"useAttachedFlowContinueAfterDefaultReply": true,
"useAttachedFlowPassDefaultRepliesIntoFlow": true,
"implicitSlotParsing": "disabled",
"useAttachedFlowImplicitSlotParsing": true,
"lexiconSlotsWithSubMatches": true,
"useIntentDefaultRepliesAsExamples": true,
"localeSettings": [
{
"type": {
"localeReference": "<string>",
"inheritFallbackLocaleModel": true
}
}
],
"intentThreshold": {
"lower": 0.4,
"upper": 0.5
},
"learnNewExampleSentences": true,
"learnNewExampleSentencesThreshold": 123,
"negativeConfirmationWords": [
"<string>"
],
"positiveConfirmationWords": [
"<string>"
],
"systemSlots": {
"useAgeSlots": true,
"useDateSlots": true,
"useDistanceSlots": true,
"useDurationSlots": true,
"useEmailSlots": true,
"useMoneySlots": true,
"useNumberSlots": true,
"usePercentageSlots": true,
"useTemperatureSlots": true,
"useURLSlots": true
},
"yesNoLogic": "yesNoIntents",
"yesNoIntentThreshold": 123,
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
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.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The unique identifier for the Flow.
24^[a-z0-9]{24}$Response
Returns the Flow Settings 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.
joint, main, attached disabled, full, system, lexicon Enable/Disable using default replies as training examples.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
yesNoIntents, yesNoIntentsWithRules, confirmationWords 24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/settings \
--header 'X-API-Key: <api-key>'{
"continueExecutionAfterAttachedFlow": true,
"continueExecutionAterDefaultReply": true,
"continueExecutionAfterNegativeConfirmation": true,
"passDefaultRepliesIntoFlow": true,
"flowIntentMappingOrder": "joint",
"useAttachedFlowThresholds": true,
"useAttachedFlowContinueAfterDefaultReply": true,
"useAttachedFlowPassDefaultRepliesIntoFlow": true,
"implicitSlotParsing": "disabled",
"useAttachedFlowImplicitSlotParsing": true,
"lexiconSlotsWithSubMatches": true,
"useIntentDefaultRepliesAsExamples": true,
"localeSettings": [
{
"type": {
"localeReference": "<string>",
"inheritFallbackLocaleModel": true
}
}
],
"intentThreshold": {
"lower": 0.4,
"upper": 0.5
},
"learnNewExampleSentences": true,
"learnNewExampleSentencesThreshold": 123,
"negativeConfirmationWords": [
"<string>"
],
"positiveConfirmationWords": [
"<string>"
],
"systemSlots": {
"useAgeSlots": true,
"useDateSlots": true,
"useDistanceSlots": true,
"useDurationSlots": true,
"useEmailSlots": true,
"useMoneySlots": true,
"useNumberSlots": true,
"usePercentageSlots": true,
"useTemperatureSlots": true,
"useURLSlots": true
},
"yesNoLogic": "yesNoIntents",
"yesNoIntentThreshold": 123,
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}