{ "info": { "title": "Cognigy.AI REST-ful-API Reference", "version": "2026.18.0", "description": "\n### Introduction\nThis 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.\n\n### Cross-Origin Resource Sharing\nThis 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.\n\n### Authentication\nCognigy.AI offers four forms of authentication:\n- API Key\n- CXone Token\n- OAuth2\n- BasicAuth\n\nAn 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.\n\nOAuth2 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).\n\nBasic Auth is only used for API calls regarding the Management-UI.\n\n### Error Handling\nThis 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).\n\nEvery error response contains a traceId, which should be provided to the Cognigy.AI Technical Support when reporting an error.\n", "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" } ], "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." } }, "parameters": { "logEntryIdPathParam": { "in": "path", "name": "logEntryId", "description": "The unique identifier for the log entry.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "acceptHeader": { "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" }, "logTypeParam": { "in": "query", "name": "type", "required": false, "description": "The log level to filter log entries by.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } }, "userIdParam": { "in": "query", "name": "userId", "required": false, "description": "The ID of the user to filter log entries by.", "schema": { "type": "string" } }, "flowNameParam": { "in": "query", "name": "flowName", "required": false, "description": "The name of the Flow to filter log entries by.", "schema": { "type": "string" } }, "startDateParam": { "description": "The start date for filtering log entries in ISO 8601 format.", "in": "query", "name": "startDate", "required": false, "schema": { "type": "string", "format": "date-time" } }, "endDateParam": { "description": "The end date for filtering log entries in ISO 8601 format.", "in": "query", "name": "endDate", "required": false, "schema": { "type": "string", "format": "date-time" } }, "resourceTypePathParam": { "in": "query", "name": "resourceType", "description": "The type of a resource", "required": true, "schema": { "type": "string", "enum": [ "flow", "nluconnector", "locale", "flowState" ] } }, "filterParam": { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "Filter records by specific field eg:name." }, "limitParam": { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. Use this parameter to control page size. The default value is 25, and the maximum permitted value is 100." }, "skipParam": { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip before returning the results. Use this parameter with `limit` for offset-based pagination. The default value is 0." }, "sortParam": { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order in which results are returned. Set a sorting rule in the format `field:direction`, where direction can be `asc` for ascending order or `desc` for descending order. For example, `name:asc` sorts by name in ascending order." }, "nextParam": { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "The cursor that points to the next page of results. Use the `nextCursor` value returned in a previous response to request the next set of items." }, "previousParam": { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "The cursor that points to the previous page of results. Use the `previousCursor` value returned in a previous response to request the previous set of items." }, "projectIdPathParam": { "in": "path", "name": "projectId", "description": "The unique identifier for the Project.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "schemas": { "ILogEntry_2_0": { "type": "object", "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" } } }, "ILogEntryIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "type": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] }, "meta": { "type": "object" }, "traceId": { "type": "string" } } }, "ILogEntryIndexItem_2_1": { "type": "object", "required": [ "_id", "timestamp", "metadata" ], "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" }, "metadata": { "type": "object", "required": [ "organizationId", "projectId", "type" ], "properties": { "organizationId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "type": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } } } }, "TCognigyColorName": { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] }, "TCSSColorHex": { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ff8a80" }, "TCSSColor": { "oneOf": [ { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ff8a80" }, { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] } ] }, "TCSSColorName": { "type": "string", "example": "none", "enum": [ "aliceBlue", "antiqueWhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedAlmond", "blue", "blueViolet", "brown", "burlyWood", "cadetBlue", "chartreuse", "chocolate", "coral", "cornflowerBlue", "cornsilk", "crimson", "cyan", "darkBlue", "darkCyan", "darkGoldenRod", "darkGray", "darkGrey", "darkGreen", "darkKhaki", "darkMagenta", "darkOliveGreen", "darkOrange", "darkOrchid", "darkRed", "darkSalmon", "darkSeaGreen", "darkSlateBlue", "darkSlateGray", "darkSlateGrey", "darkTurquoise", "darkViolet", "deepPink", "deepSkyBlue", "dimGray", "dimGrey", "dodgerBlue", "fireBrick", "floralWhite", "forestGreen", "fuchsia", "gainsboro", "ghostWhite", "gold", "goldenRod", "gray", "grey", "green", "greenYellow", "honeyDew", "hotPink", "indianRed", "indigo", "ivory", "khaki", "lavender", "lavenderBlush", "lawnGreen", "lemonChiffon", "lightBlue", "lightCoral", "lightCyan", "lightGoldenRodYellow", "lightGray", "lightGrey", "lightGreen", "lightPink", "lightSalmon", "lightSeaGreen", "lightSkyBlue", "lightSlateGray", "lightSlateGrey", "lightSteelBlue", "lightYellow", "lime", "limeGreen", "linen", "magenta", "maroon", "mediumAquaMarine", "mediumBlue", "mediumOrchid", "mediumPurple", "mediumSeaGreen", "mediumSlateBlue", "mediumSpringGreen", "mediumTurquoise", "mediumVioletRed", "midnightBlue", "mintCream", "mistyRose", "moccasin", "navajoWhite", "navy", "oldLace", "olive", "oliveDrab", "orange", "orangeRed", "orchid", "paleGoldenRod", "paleGreen", "paleTurquoise", "paleVioletRed", "papayaWhip", "peachPuff", "peru", "pink", "plum", "powderBlue", "purple", "rebeccaPurple", "red", "rosyBrown", "royalBlue", "saddleBrown", "salmon", "sandyBrown", "seaGreen", "seaShell", "sienna", "silver", "skyBlue", "slateBlue", "slateGray", "slateGrey", "snow", "springGreen", "steelBlue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whiteSmoke", "yellow", "yellowGreen", "none", "transparent" ] }, "TMongoId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "TExampleMongotId": { "type": "string", "example": "63c6c16a7e1ef09c81f6075d" }, "TTimestamp": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "TTimezone": { "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" ] }, "ICursorBasedPaginationReturnValue": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "responses": { "BadGatewayError": { "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": {} } } } } } }, "BadRequestError": { "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": {} } } } } } }, "ConflictError": { "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": {} } } } } } }, "ForbiddenError": { "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": {} } } } } } }, "GatewayTimeoutError": { "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": {} } } } } } }, "InternalServerError": { "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": {} } } } } } }, "MethodNotAllowedError": { "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": {} } } } } } }, "NotImplementedError": { "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": {} } } } } } }, "PayloadTooLargeError": { "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": {} } } } } } }, "PaymentRequiredError": { "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": {} } } } } } }, "NotFoundError": { "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" } } } } } }, "ServiceUnavailableError": { "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": {} } } } } } }, "TooManyRequestsError": { "description": "The server got too many requests than it is required to handle.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "TooManyRequestsError" }, "title": { "type": "string", "example": "Too Many Requests Error" }, "status": { "type": "number", "example": 429 }, "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": {} } } } } } }, "UnauthorizedError": { "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": {} } } } } } } } }, "security": [ { "APIKeyHeader": [] }, { "APIKeyQueryParam": [] }, { "CXoneTokenHeader": [] }, { "OAuth2": [] }, { "BasicAuth": [] } ], "externalDocs": { "description": "Cognigy.AI Documentation", "url": "https://docs.cognigy.com/docs/" }, "tags": [ { "name": "Cognigy.AI REST-ful API", "description": "The Cognigy.AI REST-ful API" } ], "openapi": "3.0.0", "paths": { "/v2.0/projects/{projectId}/logs": { "get": { "operationId": "indexLogEntries_2_0", "summary": "Get Log Entries", "deprecated": true, "description": "Gets [log entries](https://docs.cognigy.com/ai/agents/test/logs) in a Project. By default, 25 log entries are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. If you provide an invalid `cursor` value, a 400 error will be returned. This endpoint is deprecated, use `/v2.1/projects/{projectId}/logs` instead.", "tags": [ "Logs" ], "parameters": [ { "in": "path", "name": "projectId", "description": "The unique identifier for the Project.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "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": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The string to filter log entries by type, message, or trace ID." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. Use this parameter to control page size. The default value is 25, and the maximum permitted value is 100." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip before returning the results. Use this parameter with `limit` for offset-based pagination. The default value is 0." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order in which results are returned. Set a sorting rule in the format `field:direction`, where direction can be `asc` for ascending order or `desc` for descending order. For example, `name:asc` sorts by name in ascending order." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "The cursor that points to the next page of results. Use the `nextCursor` value returned in a previous response to request the next set of items." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "The cursor that points to the previous page of results. Use the `previousCursor` value returned in a previous response to request the previous set of items." }, { "in": "query", "name": "type", "required": false, "description": "The log level to filter log entries by.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } }, { "in": "query", "name": "userId", "required": false, "description": "The ID of the user to filter log entries by.", "schema": { "type": "string" } }, { "in": "query", "name": "flowName", "required": false, "description": "The name of the Flow to filter log entries by.", "schema": { "type": "string" } }, { "description": "The start date for filtering log entries in ISO 8601 format.", "in": "query", "name": "startDate", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end date for filtering log entries in ISO 8601 format.", "in": "query", "name": "endDate", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Paginated array of log entries retrieved.", "headers": { "Deprecation": { "description": "Indicates this endpoint is deprecated", "schema": { "type": "string", "example": "true" } }, "Sunset": { "description": "The date after which this endpoint will be removed", "schema": { "type": "string", "example": "Tue, 10 Nov 2026 00:00:00 GMT" } }, "Link": { "description": "Points to the successor endpoint", "schema": { "type": "string", "example": "; rel=\"successor-version\"" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "type": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] }, "meta": { "type": "object" }, "traceId": { "type": "string" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "400": { "description": "Server error. This can occur if an invalid cursor is provided. This error is thrown by the pagination plugin when the cursor value is not a valid ID for the field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "code": { "type": "integer" }, "type": { "type": "string" }, "detail": { "type": "string", "example": "The provided cursor value is invalid." } } } } } }, "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": [] } ] } }, "/v2.0/projects/{projectId}/logs/{logEntryId}": { "get": { "operationId": "readLogEntry_2_0", "summary": "Get a Log Entry", "deprecated": true, "description": "Gets a [log entry](https://docs.cognigy.com/ai/agents/test/logs) in a Project. This endpoint is deprecated, use `/v2.1/projects/{projectId}/logs/{logEntryId}` instead.", "tags": [ "Logs" ], "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", "description": "The unique identifier for the Project.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "logEntryId", "description": "The unique identifier for the log entry.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Log entry retrieved.", "headers": { "Deprecation": { "description": "Indicates that the endpoint is deprecated.", "schema": { "type": "string", "example": "true" } }, "Sunset": { "description": "The date after which the endpoint isn't available.", "schema": { "type": "string", "example": "Tue, 10 Nov 2026 00:00:00 GMT" } }, "Link": { "description": "Points to the endpoint to be used instead.", "schema": { "type": "string", "example": "; rel=\"successor-version\"" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" } } } } } }, "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": [] } ] } }, "/v2.0/projects/{projectId}/logs/tail": { "get": { "operationId": "tailLogEntries_2_0", "summary": "Get the Latest Log Entries", "deprecated": true, "description": "Gets the latest 100 [log entries](https://docs.cognigy.com/ai/agents/test/logs) in a Project. Uses aggregation to first get the latest rows by `_id`, then sorts by timestamp. Supports `cursor`-based pagination using the `_id` field. If you provide an invalid `cursor` value, a 400 error will be returned. This endpoint is deprecated, use `/v2.1/projects/{projectId}/logs/tail` instead.", "tags": [ "Logs" ], "parameters": [ { "in": "path", "name": "projectId", "description": "The unique identifier for the Project.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "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": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "The cursor that points to the next page of results. Use the `nextCursor` value returned in a previous response to request the next set of items." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "The cursor that points to the previous page of results. Use the `previousCursor` value returned in a previous response to request the previous set of items." }, { "in": "query", "name": "type", "required": false, "description": "The log level to filter log entries by.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } }, { "in": "query", "name": "userId", "required": false, "description": "The ID of the user to filter log entries by.", "schema": { "type": "string" } }, { "in": "query", "name": "flowName", "required": false, "description": "The name of the Flow to filter log entries by.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated array of the latest log entries retrieved.", "headers": { "Deprecation": { "description": "Indicates that the endpoint is deprecated.", "schema": { "type": "string", "example": "true" } }, "Sunset": { "description": "The date after which the endpoint isn't available.", "schema": { "type": "string", "example": "Tue, 10 Nov 2026 00:00:00 GMT" } }, "Link": { "description": "Points to the endpoint to be used instead.", "schema": { "type": "string", "example": "; rel=\"successor-version\"" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "type": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] }, "meta": { "type": "object" }, "traceId": { "type": "string" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "400": { "description": "Bad request. This can occur if an invalid cursor is provided. This error is thrown by the pagination plugin when the cursor value is not a valid ID for the field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "code": { "type": "integer" }, "type": { "type": "string" }, "detail": { "type": "string", "example": "The provided cursor value is invalid." } } } } } }, "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": [] } ] } }, "/v2.1/projects/{projectId}/logs": { "get": { "operationId": "indexLogEntries_2_1", "summary": "Get Log Entries", "description": "Gets [log entries](https://docs.cognigy.com/ai/agents/test/logs) in a Project. By default, 25 log entries are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. If you provide an invalid `cursor` value, a 400 error will be returned. When `startDate` or `endDate` are not provided, a default 1-hour time window is applied. When the request header `x-cognigy-log-model-version` is set to `v2`, `total` is only an accurate count on the first page (no `next`/`previous` cursor); subsequent cursor-paginated pages return `-1` for `total`, so callers must not rely on it there.", "tags": [ "Logs v2.1" ], "parameters": [ { "in": "path", "name": "projectId", "description": "The unique identifier for the Project.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "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": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The string to filter log entries by type, message, or trace ID." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. Use this parameter to control page size. The default value is 25, and the maximum permitted value is 100." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip before returning the results. Use this parameter with `limit` for offset-based pagination. The default value is 0." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order in which results are returned. Set a sorting rule in the format `field:direction`, where direction can be `asc` for ascending order or `desc` for descending order. For example, `name:asc` sorts by name in ascending order." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "The cursor that points to the next page of results. Use the `nextCursor` value returned in a previous response to request the next set of items." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "The cursor that points to the previous page of results. Use the `previousCursor` value returned in a previous response to request the previous set of items." }, { "in": "query", "name": "type", "required": false, "description": "The log level to filter log entries by.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } }, { "in": "query", "name": "userId", "required": false, "description": "The ID of the user to filter log entries by.", "schema": { "type": "string" } }, { "in": "query", "name": "flowName", "required": false, "description": "The name of the Flow to filter log entries by.", "schema": { "type": "string" } }, { "in": "query", "name": "startDate", "required": true, "schema": { "type": "string", "format": "date-time", "example": "2025-08-11T10:00:00.000Z" }, "description": "The start date for filtering log entries in ISO 8601 format. The default is 1 hour before the end date." }, { "in": "query", "name": "endDate", "required": true, "schema": { "type": "string", "format": "date-time", "example": "2025-08-11T10:00:00.000Z" }, "description": "The end date for filtering log entries in ISO 8601 format. The default is the current time." } ], "responses": { "200": { "description": "Paginated array of log entries retrieved.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "type": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] }, "meta": { "type": "object" }, "traceId": { "type": "string" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "400": { "description": "Bad request. This can occur if an invalid cursor is provided. This error is thrown by the pagination plugin when the cursor value is not a valid ID for the field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "code": { "type": "integer" }, "type": { "type": "string" }, "detail": { "type": "string", "example": "The provided cursor value is invalid." } } } } } }, "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": [] } ] } }, "/v2.1/projects/{projectId}/logs/{logEntryId}": { "get": { "operationId": "readLogEntry_2_1", "summary": "Get a Log Entry", "description": "Gets a [log entry](https://docs.cognigy.com/ai/agents/test/logs) in a Project. When the request header `x-cognigy-log-model-version` is set to `v2`, the response uses the V2 shape with a nested `metadata` object containing `organizationId`, `projectId`, and `type` instead of a top-level `type` field.", "tags": [ "Logs v2.1" ], "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", "description": "The unique identifier for the Project.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "logEntryId", "description": "The unique identifier for the log entry.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "header", "name": "x-cognigy-log-model-version", "required": false, "schema": { "type": "string", "enum": [ "v1", "v2" ] }, "description": "When set to \"v2\", the response includes the full V2 model with a nested `metadata` object containing `organizationId`, `projectId`, and `type`." } ], "responses": { "200": { "description": "Returns LogEntry Object", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" } } }, { "type": "object", "required": [ "_id", "timestamp", "metadata" ], "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" }, "metadata": { "type": "object", "required": [ "organizationId", "projectId", "type" ], "properties": { "organizationId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "type": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } } } } ] } } } }, "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": [] } ] } }, "/v2.1/projects/{projectId}/logs/package": { "post": { "operationId": "packageLogEntries_2_1", "summary": "Package Log Entries into a downloadable file", "description": "Starts packaging all [log entries](https://docs.cognigy.com/ai/agents/test/logs) matching the given filters into a file on disk and returns immediately with the `logsFileId` of that file. Download the file via `/v2.1/projects/{projectId}/logs/package/{logsFileId}/download` once packaging has finished. Time ranges larger than one hour are queried in one-hour windows to keep the database load low. If an identical packaging request (same filters) is already in progress, the `logsFileId` of that packaging is returned instead of starting a new one. Packaged files expire after a configured retention time.", "tags": [ "Logs v2.1" ], "parameters": [ { "in": "path", "name": "projectId", "description": "The unique identifier for the Project.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "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" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "array", "items": { "type": "string" }, "description": "Log levels to include (e.g. info, warning, error)" }, "userId": { "type": "string", "description": "Filter by the user Id of the log entry" }, "flowName": { "type": "string", "description": "Filter by the Flow name of the log entry" }, "startDate": { "type": "string", "format": "date-time", "example": "2025-08-11T10:00:00.000Z", "description": "The start date for filtering log entries (ISO 8601 format). If not provided, defaults to 1 hour before endDate." }, "endDate": { "type": "string", "format": "date-time", "example": "2025-08-11T11:00:00.000Z", "description": "The end date for filtering log entries (ISO 8601 format). If not provided, defaults to the current time." } } } } } }, "responses": { "202": { "description": "Packaging accepted. Returns the Id of the logs file being written and the Id of the Task tracking the packaging progress. Poll the task via `/v2.0/tasks/{taskId}` — it turns `done` when the file is ready for download, `error` if packaging failed.", "headers": { "Location": { "description": "URL to download the packaged logs file once ready", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "logsFileId": { "type": "string" }, "taskId": { "type": "string" } } } } } }, "400": { "description": "Invalid time range (startDate not before endDate, or range too large)." }, "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": {} } } } } } }, "429": { "description": "Too many requests. The log query rate limit for this project was exceeded." }, "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": [] } ] } }, "/v2.1/projects/{projectId}/logs/package/{logsFileId}/download": { "get": { "operationId": "downloadPackagedLogs_2_1", "summary": "Download a packaged Logs file", "description": "Downloads the logs file previously created via `/v2.1/projects/{projectId}/logs/package`. The file contains one log entry per line (JSON Lines). While the file is still being packaged, a 409 error is returned — retry later. Packaged files expire after a configured retention time; after expiry a 404 is returned and the logs have to be packaged again.", "tags": [ "Logs v2.1" ], "parameters": [ { "in": "path", "name": "projectId", "description": "The unique identifier for the Project.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "logsFileId", "description": "The Id of the logs file returned by the package endpoint", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "The packaged logs file (JSON Lines).", "content": { "application/x-ndjson": { "schema": { "type": "string", "format": "binary" } } } }, "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": "No logs file exists for this Id — it expired or was never created." }, "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 logs file is still being packaged. Retry later." }, "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": [] } ] } }, "/v2.1/projects/{projectId}/logs/tail": { "get": { "operationId": "tailLogEntries_2_1", "summary": "Get the Latest Log Entries", "description": "Gets the latest 100 [log entries](https://docs.cognigy.com/ai/agents/test/logs) in a Project. Results are sorted descending by timestamp and `_id`. Supports cursor-based pagination via opaque base64url tokens returned in `nextCursor` and `previousCursor`. The `total` field is always `-1` because counting rows in this collection is intentionally skipped for performance reasons. If you provide an invalid `cursor` value, a 400 error will be returned. When the request header `x-cognigy-log-model-version` is set to `v2`, the response items use the V2 shape with a nested `metadata` object instead of a top-level `type` field.", "tags": [ "Logs v2.1" ], "parameters": [ { "in": "path", "name": "projectId", "description": "The unique identifier for the Project.", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "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": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "The cursor that points to the next page of results. Use the `nextCursor` value returned in a previous response to request the next set of items." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "The cursor that points to the previous page of results. Use the `previousCursor` value returned in a previous response to request the previous set of items." }, { "in": "query", "name": "type", "required": false, "description": "The log level to filter log entries by.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } }, { "in": "query", "name": "userId", "required": false, "description": "The ID of the user to filter log entries by.", "schema": { "type": "string" } }, { "in": "query", "name": "flowName", "required": false, "description": "The name of the Flow to filter log entries by.", "schema": { "type": "string" } }, { "in": "header", "name": "x-cognigy-log-model-version", "required": false, "schema": { "type": "string", "enum": [ "v1", "v2" ] }, "description": "When set to \"v2\", response items include the full V2 model with a nested `metadata` object containing `organizationId`, `projectId`, and `type`." } ], "responses": { "200": { "description": "Returns array of the latest Log Entries", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "type": "object", "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "type": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] }, "meta": { "type": "object" }, "traceId": { "type": "string" } } }, { "type": "object", "required": [ "_id", "timestamp", "metadata" ], "properties": { "_id": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" }, "metadata": { "type": "object", "required": [ "organizationId", "projectId", "type" ], "properties": { "organizationId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectId": { "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "type": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } } } } ] } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "400": { "description": "Bad request. This can occur if an invalid cursor is provided. This error is thrown by the pagination plugin when the cursor value is not a valid ID for the field.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "code": { "type": "integer" }, "type": { "type": "string" }, "detail": { "type": "string", "example": "The provided cursor value is invalid." } } } } } }, "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": [] } ] } } } }