Skip to main content
GET
/
v2.0
/
flows
/
{flowId}
/
settings
Get the Settings of a Flow
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/settings \
  --header 'Authorization: Bearer <token>' \
  --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>"
}

Authorizations

X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Authorization
string
header
required

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

api_key
string
query
required

Supply the API Key in the Url-Query

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

Response

Returns the Settings of the Flow

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.

continueExecutionAfterAttachedFlow
boolean
continueExecutionAterDefaultReply
boolean
continueExecutionAfterNegativeConfirmation
boolean
passDefaultRepliesIntoFlow
boolean
flowIntentMappingOrder
enum<string>
Available options:
joint,
main,
attached
useAttachedFlowThresholds
boolean
useAttachedFlowContinueAfterDefaultReply
boolean
useAttachedFlowPassDefaultRepliesIntoFlow
boolean
implicitSlotParsing
enum<string>
Available options:
disabled,
full,
system,
lexicon
useAttachedFlowImplicitSlotParsing
boolean
lexiconSlotsWithSubMatches
boolean
useIntentDefaultRepliesAsExamples
boolean

Enable/Disable using default replies as training examples.

localeSettings
object[]
intentThreshold
object
learnNewExampleSentences
boolean
learnNewExampleSentencesThreshold
integer
negativeConfirmationWords
string[]
positiveConfirmationWords
string[]
systemSlots
object
yesNoLogic
enum<string>
Available options:
yesNoIntents,
yesNoIntentsWithRules,
confirmationWords
yesNoIntentThreshold
integer
_id
string
Required string length: 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
lastChangedBy
string
Required string length: 24
I