> ## 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. # Get Project Settings > Gets the settings of a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects). ## OpenAPI ````yaml https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/settings openapi: 3.0.0 info: title: Cognigy.AI REST-ful-API Reference version: 2026.9.2 description: > ### Introduction This is the [OpenAPI 3.0](https://swagger.io/specification/) documentation of the [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)-ful Cognigy.AI API. ### Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/), which allows cross-domain communication from the browser. All responses include a wildcard same-origin header, making the API fully accessible. ### Authentication Cognigy.AI offers four forms of authentication: - API Key - CXone Token - OAuth2 - BasicAuth An API Key is a security token. You can use API Keys in your path or HTTP header. Never expose your API Key and keep it safe and secure. Revoke the API Key if it got exposed or stolen. OAuth2 is an open protocol to allow secure authorization by web, mobile and desktop applications. For further information see [RFC 6749 - "The OAuth 2.0 Authorization Framework"](https://tools.ietf.org/html/rfc6749) and [RFC 6750 - "The OAuth 2.0 Authorization Framework: Bearer Token Usage"](https://tools.ietf.org/html/rfc6750). Basic Auth is only used for API calls regarding the Management-UI. ### Error Handling This API uses HTTP status codes equal or above 400 to indicate errors. Error details are generated in compliance with [RFC 7807 - "Problem Details for HTTP APIs"](https://tools.ietf.org/html/rfc7807). Every error response contains a traceId, which should be provided to the Cognigy.AI Technical Support when reporting an error. contact: name: Cognigy Technical Support url: https://www.cognigy.com email: support@cognigy.com servers: - url: https://api-trial.cognigy.ai/new/ description: Cognigy.AI API security: - APIKeyHeader: [] - APIKeyQueryParam: [] - CXoneTokenHeader: [] - OAuth2: [] - BasicAuth: [] tags: - name: Cognigy.AI REST-ful API description: The Cognigy.AI REST-ful API externalDocs: description: Cognigy.AI Documentation url: https://docs.cognigy.com/docs/ paths: /v2.0/projects/{projectId}/settings: get: tags: - Projects summary: Get Project Settings description: >- Gets the settings of a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects). operationId: readAgentSettings_2_0 parameters: - in: header name: Accept description: >- 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`. required: false schema: type: string enum: - application/json - application/hal+json - application/xml - text/xml - text/csv example: application/json - in: path name: projectId required: true schema: type: string pattern: ^[a-z0-9]{24}$ minLength: 24 maxLength: 24 responses: '200': description: Returns the Settings of the Project content: application/json: schema: type: object properties: timezone: type: string description: Timezone according to IANA Timezone Database (2020a) example: Europe/Berlin enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Pacific-New - US/Samoa - UTC - Universal - W-SU - WET - Zulu useCaseSensitiveIntentMapping: type: boolean collectAnalytics: type: boolean trackDataOnlyInputs: type: boolean translationSettings: type: object properties: provider: type: string description: Supported Translation Providers enum: - none - microsoft - google - deepl connections: type: object properties: microsoft: type: object properties: connecionId: type: string description: ReferenceId to the connection provider retries: type: string description: Number of retries default: 1 timeout: type: string description: Timeout in milliseconds default: 3000 cacheExpiry: type: string description: Cache expiry in milliseconds default: 0 customBaseUrl: type: string description: Custom base url default: '' deepl: type: object properties: connecionId: type: string description: ReferenceId to the connection provider retries: type: string description: Number of retries default: 1 timeout: type: string description: Timeout in milliseconds default: 3000 cacheExpiry: type: string description: Cache expiry in milliseconds default: 0 customBaseUrl: type: string description: Custom base url default: '' google: type: object properties: connecionId: type: string description: ReferenceId to the connection provider retries: type: string description: Number of retries default: 1 timeout: type: string description: Timeout in milliseconds default: 3000 cacheExpiry: type: string description: Cache expiry in milliseconds default: 0 customBaseUrl: type: string description: Custom base url default: '' audioPreviewSettings: type: object properties: provider: type: string description: Supported AudioPreview Providers enum: - null - microsoft - google - aws connections: type: object properties: microsoft: type: object properties: connecionId: type: string description: ReferenceId to the connection provider aws: type: object properties: connecionId: type: string description: ReferenceId to the connection provider google: type: object properties: connecionId: type: string description: ReferenceId to the connection provider generativeAISettings: type: object properties: enabled: type: boolean useCasesSettings: type: object properties: designTimeGeneration: type: object properties: enabled: type: boolean description: Enable/Disable the usecase. largeLanguageModelId: type: string description: reference Id to the LargeLanguageModel object temperature: type: integer minimum: 0 maximum: 1 description: Defines the creativity of the model aiEnhancedOutputs: type: object properties: enabled: type: boolean description: Enable/Disable the usecase. largeLanguageModelId: type: string description: reference Id to the LargeLanguageModel object temperature: type: integer minimum: 0 maximum: 1 description: Defines the creativity of the model gptConversation: type: object properties: enabled: type: boolean description: Enable/Disable the usecase. largeLanguageModelId: type: string description: reference Id to the LargeLanguageModel object temperature: type: integer minimum: 0 maximum: 1 description: Defines the creativity of the model gptPromptNode: type: object properties: enabled: type: boolean description: Enable/Disable the usecase. largeLanguageModelId: type: string description: reference Id to the LargeLanguageModel object temperature: type: integer minimum: 0 maximum: 1 description: Defines the creativity of the model knowledgeSearch: type: object properties: enabled: type: boolean description: Enable/Disable the usecase. largeLanguageModelId: type: string description: reference Id to the LargeLanguageModel object temperature: type: integer minimum: 0 maximum: 1 description: Defines the creativity of the model currencySettings: type: object properties: currency: type: string example: USD knowledgeAISettings: type: object properties: fileExtractor: type: string description: Options for the Knowledge AI File Extractor enum: - default - legacy - azure azureDIConnectionId: type: string description: >- ReferenceId of the Azure AI Document Intelligence Connection example: f66e99eb-db8f-433c-977f-69160d9a6bdb piiDataRedactionSettings: type: object properties: emailAddress: type: object properties: enabled: type: boolean description: >- Whether PII redaction is enabled for this field type behavior: oneOf: - type: object properties: type: type: string enum: - predefined-alias customAlias: type: string nullable: true required: - type - customAlias - type: object properties: type: type: string enum: - custom-alias customAlias: type: string description: Custom alias to replace PII data with required: - type - customAlias scope: type: object properties: logs: type: boolean description: Whether to redact PII in logs analytics: type: boolean description: Whether to redact PII in analytics required: - logs - analytics name: type: string description: Display name for the PII field type required: - enabled - behavior - scope - name phoneNumber: type: object properties: enabled: type: boolean description: >- Whether PII redaction is enabled for this field type behavior: oneOf: - type: object properties: type: type: string enum: - predefined-alias customAlias: type: string nullable: true required: - type - customAlias - type: object properties: type: type: string enum: - custom-alias customAlias: type: string description: Custom alias to replace PII data with required: - type - customAlias scope: type: object properties: logs: type: boolean description: Whether to redact PII in logs analytics: type: boolean description: Whether to redact PII in analytics required: - logs - analytics name: type: string description: Display name for the PII field type required: - enabled - behavior - scope - name creditCard: type: object properties: enabled: type: boolean description: >- Whether PII redaction is enabled for this field type behavior: oneOf: - type: object properties: type: type: string enum: - predefined-alias customAlias: type: string nullable: true required: - type - customAlias - type: object properties: type: type: string enum: - custom-alias customAlias: type: string description: Custom alias to replace PII data with required: - type - customAlias scope: type: object properties: logs: type: boolean description: Whether to redact PII in logs analytics: type: boolean description: Whether to redact PII in analytics required: - logs - analytics name: type: string description: Display name for the PII field type required: - enabled - behavior - scope - name ssn: type: object properties: enabled: type: boolean description: >- Whether PII redaction is enabled for this field type behavior: oneOf: - type: object properties: type: type: string enum: - predefined-alias customAlias: type: string nullable: true required: - type - customAlias - type: object properties: type: type: string enum: - custom-alias customAlias: type: string description: Custom alias to replace PII data with required: - type - customAlias scope: type: object properties: logs: type: boolean description: Whether to redact PII in logs analytics: type: boolean description: Whether to redact PII in analytics required: - logs - analytics name: type: string description: Display name for the PII field type required: - enabled - behavior - scope - name ipAddressV4: type: object properties: enabled: type: boolean description: >- Whether PII redaction is enabled for this field type behavior: oneOf: - type: object properties: type: type: string enum: - predefined-alias customAlias: type: string nullable: true required: - type - customAlias - type: object properties: type: type: string enum: - custom-alias customAlias: type: string description: Custom alias to replace PII data with required: - type - customAlias scope: type: object properties: logs: type: boolean description: Whether to redact PII in logs analytics: type: boolean description: Whether to redact PII in analytics required: - logs - analytics name: type: string description: Display name for the PII field type required: - enabled - behavior - scope - name ipAddressV6: type: object properties: enabled: type: boolean description: >- Whether PII redaction is enabled for this field type behavior: oneOf: - type: object properties: type: type: string enum: - predefined-alias customAlias: type: string nullable: true required: - type - customAlias - type: object properties: type: type: string enum: - custom-alias customAlias: type: string description: Custom alias to replace PII data with required: - type - customAlias scope: type: object properties: logs: type: boolean description: Whether to redact PII in logs analytics: type: boolean description: Whether to redact PII in analytics required: - logs - analytics name: type: string description: Display name for the PII field type required: - enabled - behavior - scope - name customTypes: type: object additionalProperties: type: object properties: behavior: oneOf: - type: object properties: type: type: string enum: - predefined-alias customAlias: type: string nullable: true required: - type - customAlias - type: object properties: type: type: string enum: - custom-alias customAlias: type: string description: Custom alias to replace PII data with required: - type - customAlias scope: type: object properties: logs: type: boolean description: Whether to redact PII in logs analytics: type: boolean description: Whether to redact PII in analytics required: - logs - analytics name: type: string description: Display name for the custom PII field type regex: type: string description: >- Regular expression pattern to match custom PII data (RE2 syntax) minLength: 1 maxLength: 2000 required: - behavior - scope - name - regex description: User-defined custom PII patterns with regex matching required: - emailAddress - phoneNumber - creditCard - ssn - ipAddressV4 - ipAddressV6 intentThreshold: type: object properties: lower: type: number example: 0.4 upper: type: number example: 0.5 learnNewExampleSentences: type: boolean learnNewExampleSentencesThreshold: type: integer negativeConfirmationWords: type: array items: type: string positiveConfirmationWords: type: array items: type: string systemSlots: type: object properties: useAgeSlots: type: boolean useDateSlots: type: boolean useDistanceSlots: type: boolean useDurationSlots: type: boolean useEmailSlots: type: boolean useMoneySlots: type: boolean useNumberSlots: type: boolean usePercentageSlots: type: boolean useTemperatureSlots: type: boolean useURLSlots: type: boolean yesNoLogic: type: string enum: - yesNoIntents - yesNoIntentsWithRules - confirmationWords yesNoIntentThreshold: type: integer _id: type: string pattern: ^[a-z0-9]{24}$ minLength: 24 maxLength: 24 createdAt: type: integer description: Unix-timestamp example: 1694518620 minimum: 0 maximum: 2147483647 lastChanged: type: integer description: Unix-timestamp example: 1694518620 minimum: 0 maximum: 2147483647 createdBy: type: string pattern: ^[a-z0-9]{24}$ minLength: 24 maxLength: 24 lastChangedBy: type: string pattern: ^[a-z0-9]{24}$ minLength: 24 maxLength: 24 description: > 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. '400': description: >- The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing) content: application/json: schema: type: object properties: type: type: string example: Bad Request title: type: string example: Bad Request Error status: type: number example: 400 detail: type: string example: Validation failed. Missing payload. instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '401': description: >- The request has not been applied because it lacks valid authentication credentials for the target resource. content: application/json: schema: type: object properties: type: type: string example: Unauthorized title: type: string example: Unauthorized Error status: type: number example: 401 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 401 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '402': description: Upgrade your Plan to increase your Quota. content: application/json: schema: type: object properties: type: type: string example: Payment Required title: type: string example: Payment Required Error status: type: number example: 402 detail: type: string example: Validation failed. Missing payload. instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 402 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '403': description: The server understood the request but refuses to authorize it. content: application/json: schema: type: object properties: type: type: string example: Forbidden title: type: string example: Forbidden Error status: type: number example: 403 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '404': description: >- The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. content: application/json: schema: type: object properties: type: type: string example: Not Found title: type: string example: Not Found Error status: type: number example: 404 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} logLevel: type: string example: error '405': description: >- The method received in the request-line is known by the origin server but not supported by the target resource. content: application/json: schema: type: object properties: type: type: string example: Method Not Allowed title: type: string example: Method Not Allowed Error status: type: number example: 405 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '409': description: The request conflicts with current state of the server. content: application/json: schema: type: object properties: type: type: string example: Conflict title: type: string example: Conflict Error status: type: number example: 409 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1004 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '413': description: The request entity is larger than limits defined by server. content: application/json: schema: type: object properties: type: type: string example: Payload Too Large title: type: string example: Payload Too Large Error status: type: number example: 413 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '500': description: >- The server encountered an unexpected condition that prevented it from fulfilling the request. content: application/json: schema: type: object properties: type: type: string example: Internal Server Error title: type: string example: Internal Server Error status: type: number example: 500 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '501': description: >- The server does not support the functionality required to fulfill the request. content: application/json: schema: type: object properties: type: type: string example: Not Implemented title: type: string example: Not Implemented Error status: type: number example: 501 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1009 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '502': description: >- The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request. content: application/json: schema: type: object properties: type: type: string example: Bad Gateway title: type: string example: Bad Gateway Error status: type: number example: 502 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '503': description: The server is not ready to handle the request. content: application/json: schema: type: object properties: type: type: string example: Service Unavailable title: type: string example: Service Unavailable Error status: type: number example: 503 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 503 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} '504': description: >- The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request. content: application/json: schema: type: object properties: type: type: string example: Gateway Timeout title: type: string example: Gateway Timeout Error status: type: number example: 504 detail: type: string instance: type: string example: /v2.0/flows/5ce7c2d833ea1e04d7e6c432 code: type: string example: 1000 traceId: type: string example: api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f details: type: object example: {} security: - APIKeyHeader: [] - APIKeyQueryParam: [] - CXoneTokenHeader: [] - OAuth2: [] components: securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key description: Supply the API Key in the HTTP-Header APIKeyQueryParam: type: apiKey in: query name: api_key description: Supply the API Key in the Url-Query CXoneTokenHeader: type: apiKey in: header name: x-cxone-authorization description: >- Supply the CXone Token in the HTTP-Header containing the word "Bearer" followed by a space and a Token String. Applicable only in CXone integrated environments. OAuth2: type: oauth2 flows: password: tokenUrl: /auth/oauth2/token refreshUrl: /auth/oauth2/token scopes: {} authorizationCode: authorizationUrl: /auth/oauth2/authorize tokenUrl: /auth/oauth2/token scopes: {} BasicAuth: type: http scheme: basic description: Basic Authentication used by routes designed for the Management-UI. ````