{ "info": { "title": "Cognigy.AI REST-ful-API Reference", "version": "2026.6.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 have a wildcard same-origin header which makes the API completely 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-dev.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": { "acceptHeader": { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, "userIdPathParam": { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "apiKeyIdPathParam": { "in": "path", "name": "apiKeyId", "description": "The Id of an Api Key", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "skillIdPathParam": { "in": "path", "name": "skillId", "description": "The Id of the Alexa-Skill", "required": true, "schema": { "type": "string" } }, "organisationIdPathParam": { "in": "path", "name": "organisationId", "description": "The Id of the Organisation", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "yearQueryParam": { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, "monthQueryParam": { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } }, "nonConversationalQueryParam": { "in": "query", "name": "nonConversational", "required": false, "description": "Deprecated. Please no longer use this parameter. Use channel=nonConversational instead.", "schema": { "type": "boolean" } }, "channelQueryParam": { "in": "query", "name": "channel", "required": false, "description": "As of release 4.96, conversations can be filtered by specific channels like \"webchat2\". Previously, \"webchat2\" conversations were aggregated under \"realtime\" and could not be individually filtered.", "schema": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] } }, "sessionIdPathParam": { "in": "path", "name": "sessionId", "description": "The Id of the Session", "required": true, "schema": { "type": "string" } }, "logEntryIdPathParam": { "in": "path", "name": "logEntryId", "description": "The Id of the Log Entry", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "profileIdPathParam": { "in": "path", "name": "profileId", "description": "The Id of the Profile", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "taskIdPathParam": { "in": "path", "name": "taskId", "description": "The Id of the Task", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "recordIdPathParam": { "in": "path", "name": "recordId", "description": "The Id of the Record", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "fileTokenPathParam": { "in": "path", "name": "fileToken", "description": "The token of the File", "required": true, "schema": { "type": "string", "pattern": "/[a-fA-F0-9]{64}/" } }, "configIdPathParam": { "in": "path", "name": "configId", "description": "The Id of the Ai Copilot config", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "aiAgentIdPathParam": { "in": "path", "name": "aiAgentId", "description": "The Id of the Ai Agent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "connectionIdPathParam": { "in": "path", "name": "connectionId", "description": "The Id of the Connection", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "connectionFieldNamePathParam": { "in": "path", "name": "fieldName", "description": "The name of the Connection field", "required": true, "schema": { "type": "string" } }, "endpointIdPathParam": { "in": "path", "name": "endpointId", "description": "The Id of the Endpoint", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "extensionIdPathParam": { "in": "path", "name": "extensionId", "description": "The Id of the Extension", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "fileIdPathParam": { "in": "path", "name": "fileId", "description": "The Id of the File", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "flowIdPathParam": { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "nodeIdPathParam": { "in": "path", "name": "nodeId", "description": "The Id of the Node", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "intentIdPathParam": { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "learningSentenceIdPathParam": { "in": "path", "name": "learningSentenceId", "description": "The Id of the LearningSentence", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "slotFillerIdPathParam": { "in": "path", "name": "slotFillerId", "description": "The Id of the SlotFiller", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "sentenceIdPathParam": { "in": "path", "name": "sentenceId", "description": "The Id of the Sentence", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "stateIdPathParam": { "in": "path", "name": "stateId", "description": "The Id of the State", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "preferredLocaleIdQueryParam": { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "functionIdPathParam": { "in": "path", "name": "functionId", "description": "The Id of the Function", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "functionInstanceIdPathParam": { "in": "path", "name": "functionInstanceId", "description": "The Id of the Function Instance", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "goalIdPathParam": { "in": "path", "name": "goalId", "description": "The Id of the Goal", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "goalStepIdPathParam": { "in": "path", "name": "stepId", "description": "The Id of the Goal Step", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "goalStepMetricIdPathParam": { "in": "path", "name": "metricId", "description": "The Id of the Goal Step Metric", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "providerIdPathParam": { "in": "path", "name": "providerId", "description": "The Id of handover providers", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "serviceIdPathParam": { "in": "path", "name": "serviceId", "description": "The Id of handover services", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "handoverProviderIdPathParam": { "in": "path", "name": "providerId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "handoverServiceIdPathParam": { "in": "path", "name": "serviceId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "knowledgeStoreIdPathParam": { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "sourceIdPathParam": { "in": "path", "name": "sourceId", "description": "The Id of the KnowledgeSource", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "chunkIdPathParam": { "in": "path", "name": "chunkId", "description": "The Id of the KnowledgeChunk", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "connectorIdPathParam": { "in": "path", "name": "connectorId", "description": "The Id of the KnowledgeConnector", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "documentUrlParam": { "in": "query", "name": "documentUrl", "required": false, "schema": { "type": "string" } }, "projectIdParam": { "in": "query", "name": "projectId", "required": false, "schema": { "type": "string" } }, "languageParam": { "in": "query", "name": "language", "required": false, "schema": { "type": "string", "example": "en-US" } }, "largeLanguageModelIdPathParam": { "in": "path", "name": "largeLanguageModelId", "description": "Id for the LargeLanguageModel", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "connectionRefIdPathParam": { "in": "query", "name": "connectionRefId", "required": true, "schema": { "type": "string" }, "description": "Connection reference id." }, "lexiconIdPathParam": { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "entryIdPathParam": { "in": "path", "name": "entryId", "description": "The id of an entry in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "keyphraseIdPathParam": { "in": "path", "name": "keyphraseId", "description": "The id of a keyphrase in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "slotIdPathParam": { "in": "path", "name": "slotId", "description": "The id of a slot in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "metaOnlyQueryParam": { "in": "query", "name": "metaOnly", "description": "Return only the lexicon meta data if set to true", "required": false, "schema": { "type": "boolean", "enum": [ true, false ] } }, "localeIdPathParam": { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "nluConnectorIdPathParam": { "in": "path", "name": "nluConnectorId", "description": "The Id of the NLUConnector", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "packageIdPathParam": { "in": "path", "name": "packageId", "description": "The Id of the Package", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "playbookIdPathParam": { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "playbookRunIdPathParam": { "in": "path", "name": "playbookRunId", "description": "The Id of the Playbook Run", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "playbookStepIdPathParam": { "in": "path", "name": "stepId", "description": "The Id of the Playbook Step", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "playbookStepAssertIdPathParam": { "in": "path", "name": "assertId", "description": "The Id of the Playbook Step Assert", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "projectIdPathParam": { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "projectIdQueryParam": { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "snapshotIdPathParam": { "in": "path", "name": "snapshotId", "description": "The Id of the Snapshot", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "copyResourceIdQueryParam": { "in": "query", "name": "resourceId", "description": "An Id of a resource within the corresponding project to copy from", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "globalResourceQueryParam": { "in": "query", "name": "resourceLevel", "description": "Scope of the resource (global \"organisation\" or project).", "required": false, "schema": { "type": "string", "enum": [ "organisation", "project" ], "description": "General scope of the resource.", "default": "project" } }, "filterUserParam": { "in": "query", "name": "user", "required": false, "schema": { "type": "string" } }, "filterTypeParam": { "in": "query", "name": "type", "required": false, "schema": { "type": "string", "enum": [ "action", "create", "replace", "patch", "delete", "authentication", "authorization" ] } }, "organisationIdParam": { "in": "query", "name": "organisationId", "required": false, "schema": { "type": "string" } }, "webfingerResourceQueryParam": { "in": "query", "name": "resource", "required": true, "schema": { "type": "string", "format": "uri" } }, "webfingerRelQueryParam": { "in": "query", "name": "rel", "schema": { "type": "array", "items": { "type": "array", "items": { "type": "string", "enum": [ "idp" ] } } } }, "searchParam": { "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, "messageTypeSearchParam": { "in": "query", "name": "messageType", "required": true, "schema": { "type": "string", "enum": [ "current", "next", "previous" ] } }, "organisationDeletionTokenParam": { "in": "query", "name": "verificationToken", "required": true, "schema": { "type": "string" } }, "logTypeParam": { "in": "query", "name": "type", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } }, "userIdParam": { "in": "query", "name": "userId", "required": false, "schema": { "type": "string" } }, "flowNameParam": { "in": "query", "name": "flowName", "required": false, "schema": { "type": "string" } }, "startDateParam": { "description": "The start date for filtering log entries", "in": "query", "name": "startDate", "required": false, "schema": { "type": "string" } }, "endDateParam": { "description": "The end date for filtering log entries", "in": "query", "name": "endDate", "required": false, "schema": { "type": "string" } }, "understoodParam": { "in": "query", "name": "understood", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, "intentFoundParam": { "in": "query", "name": "intentFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, "slotFoundParam": { "in": "query", "name": "slotFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, "userSlotsFoundParam": { "in": "query", "name": "userSlotsFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, "systemSlotsFoundParam": { "in": "query", "name": "systemSlotsFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, "typeParam": { "in": "query", "name": "type", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "Greeting", "pAnswer", "nAnswer", "BGreeting" ] } } }, "scoreRangeParam": { "in": "query", "name": "scoreRange", "required": false, "description": "A minimum and maximum range to filter with intent score. Example [0.3,0.6]", "schema": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 } }, "shouldGenerateSentencesParam": { "in": "query", "name": "shouldGenerateSentences", "required": false, "schema": { "type": "boolean" } }, "generateSentenceLimitParam": { "in": "query", "name": "generateSentenceLimit", "required": false, "schema": { "type": "integer", "minimum": 5, "maximum": 20 } }, "localeIdParam": { "in": "query", "name": "localeId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "limitSentencesParam": { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 5, "maximum": 20 } }, "shouldGenerateLexiconEntriesParams": { "in": "query", "name": "shouldGenerateLexiconEntries", "description": "Flag to allow the Lexicon creation to use the generative AI to generate entries.", "example": true, "required": false, "schema": { "type": "boolean" } }, "shouldGenerateSynonymsParams": { "in": "query", "name": "shouldGenerateSynonyms", "description": "Flag to allow the Lexicon creation to use the generative AI to generate synonyms.", "example": false, "required": false, "schema": { "type": "boolean" } }, "generateLexiconEntriesLimitParam": { "in": "query", "name": "generateLexiconEntriesLimit", "description": "Number of entries to be generated by the Generative AI.", "example": 8, "required": false, "schema": { "type": "integer" } }, "defaultSlotParam": { "in": "query", "name": "defaultSlot", "description": "Default Slot where to associate the generated Lexicon entries.", "example": "testSlot", "required": false, "schema": { "type": "string" } }, "languageCode": { "in": "query", "name": "languageCode", "description": "Language code.", "required": false, "schema": { "type": "string", "example": "en-US" } }, "projectQueryParam": { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "sessionIdParam": { "in": "query", "name": "sessionId", "description": "Filter by sessionId", "required": true, "schema": { "type": "string", "format": "mongo-id" } }, "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. The default is 25." }, "skipParam": { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, "sortParam": { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, "nextParam": { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, "previousParam": { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } }, "schemas": { "intentDownload": { "type": "string", "description": "Stringified CSV or JSON.", "example": "" }, "globalResource": { "allOf": [ { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } } } }, { "type": "object", "properties": { "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] } }, "required": [ "resourceLevel" ] } ] }, "projectResource": { "allOf": [ { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } } } }, { "type": "object", "properties": { "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." } } }, { "type": "object", "properties": { "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "fallbacks": { "type": "array", "description": "(alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.", "items": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" } } } } ], "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." } } }, "IBatchCreateOperation": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] } } }, "IBatchUpdateOperation": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object" } } }, "IBatchActionOperation": { "type": "object", "properties": { "op": { "type": "string" }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object" } } }, "IBatchDeleteOperation": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "TGenerativeAIModels": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "TGenerativeAIProviders": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "TModelGroups": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "TLicenseState": { "type": "string", "description": "The state of the license", "example": "valid", "enum": [ "invalid", "valid", "valid3MonthsLeft", "willExpireSoon", "expiredRenewRequired", "expired" ] }, "systemCapabilities": { "type": "object", "properties": { "aiOpsCenterEnabled": { "type": "boolean" }, "quotaMaxKnowledgeChunks": { "type": "number" } } }, "TChannelType": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "IMediaAttachment": { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "url", "type" ] }, "IFileAttachment": { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "file", "document" ] } }, "required": [ "name", "url", "type" ] }, "IImageAttachment": { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "image" ] } }, "required": [ "name", "url", "type" ] }, "IStickerAttachment": { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "sticker" ] } }, "required": [ "name", "url", "type" ] }, "IVideoAttachment": { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "video" ] } }, "required": [ "name", "url", "type" ] }, "IAudioAttachment": { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "audio" ] } }, "required": [ "name", "url", "type" ] }, "IContactAttachment": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "contact" ] }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "countryCode": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "type": { "type": "string", "enum": [ "HOME", "WORK" ] }, "zip": { "type": "string" }, "postOfficeBox": { "type": "string" }, "extendedAddress": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" } } } }, "birthday": { "type": "string" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "HOME", "WORK" ] } } } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string", "enum": [ "HOME", "WORK" ] } } } }, "photos": { "type": "array", "items": { "type": "string" } }, "gender": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string" } }, "timeZone": { "type": "string" }, "notes": { "type": "array", "items": { "type": "string" } } }, "required": [ "type" ] }, "ILocationAttachment": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "location" ] }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "name": { "type": "string" }, "title": { "type": "string" }, "address": { "type": "string" } }, "required": [ "type", "latitude", "longitude" ] }, "TAttachments": { "oneOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "file", "document" ] } }, "required": [ "name", "url", "type" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "image" ] } }, "required": [ "name", "url", "type" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "video" ] } }, "required": [ "name", "url", "type" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "audio" ] } }, "required": [ "name", "url", "type" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "sticker" ] } }, "required": [ "name", "url", "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "contact" ] }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "countryCode": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "type": { "type": "string", "enum": [ "HOME", "WORK" ] }, "zip": { "type": "string" }, "postOfficeBox": { "type": "string" }, "extendedAddress": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" } } } }, "birthday": { "type": "string" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "HOME", "WORK" ] } } } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string", "enum": [ "HOME", "WORK" ] } } } }, "photos": { "type": "array", "items": { "type": "string" } }, "gender": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string" } }, "timeZone": { "type": "string" }, "notes": { "type": "array", "items": { "type": "string" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "location" ] }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "name": { "type": "string" }, "title": { "type": "string" }, "address": { "type": "string" } }, "required": [ "type", "latitude", "longitude" ] } ] }, "TAuditEventType": { "type": "string", "description": "The type of operation that was performed", "example": "create", "enum": [ "action", "create", "replace", "patch", "delete", "authentication", "authorization" ] }, "TResourceTypeAdditional": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "aicopilotconfig", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "flowState", "functionInstance", "intent", "keyphrase", "learningsentence", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "slotFiller", "snippet", "synonym", "tag", "task", "trainerRecord", "user", "yesNoIntent", "aiAgent" ] }, "TAuditEventChainElementType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "aiAgent", "agentassistconfig", "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "handoverProvider", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "knowledgeStore", "largeLanguageModel", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "goal", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "simulation", "aicopilotconfig", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "trainerRecord", "user", "yesNoIntent" ] }, "IAuditEventModificationChainElement": { "type": "object", "properties": { "elementId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "elementType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "aiAgent", "agentassistconfig", "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "handoverProvider", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "knowledgeStore", "largeLanguageModel", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "goal", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "simulation", "aicopilotconfig", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "trainerRecord", "user", "yesNoIntent" ] } } }, "IEntityMeta": { "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "ResourceLevel": { "type": "string", "enum": [ "organisation", "project" ], "description": "General scope of the resource.", "default": "project" }, "ProjectScopedResource": { "type": "object", "properties": { "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." } } }, "GlobalScopedResource": { "type": "object", "properties": { "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." } }, "required": [ "resourceLevel" ] }, "AssignedToProjects": { "type": "object", "properties": { "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] } } }, "IGlobalResourceFields_2_0": { "type": "object", "properties": { "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] } }, "required": [ "resourceLevel" ] }, "IProjectResourceFields_2_0": { "type": "object", "properties": { "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." } } }, "IGlobalResourceData": { "type": "object", "properties": { "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] }, "id": { "type": "string", "description": "The unique identifier for the resource.", "example": "507f191e810c19729de860eb" } }, "required": [ "resourceLevel" ] }, "IGlobalResource": { "type": "object", "properties": { "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] }, "id": { "type": "string", "description": "The unique identifier for the resource.", "example": "507f191e810c19729de860eb" } }, "required": [ "resourceLevel" ] }, "IKnowledgeDescriptor": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Knowledge of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Knowledge of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Knowledge is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule", "json", "checkbox", "time", "date", "datetime", "select", "xml", "textArray", "chipInput", "toggle", "slider", "number", "daterange", "connection", "condition", "description" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "IKnowledgeDescriptorAggregatedItem": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Knowledge of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Knowledge of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Knowledge is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule", "json", "checkbox", "time", "date", "datetime", "select", "xml", "textArray", "chipInput", "toggle", "slider", "number", "daterange", "connection", "condition", "description" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } }, "extension": { "type": "string", "description": "The extension name that this knowledge descriptor belongs to" }, "version": { "type": "string", "description": "The version of the extension that this knowledge descriptor belongs to" }, "extensionImg": { "type": "string", "description": "The image URL of the extension that this knowledge descriptor belongs to" } } }, "IGenerativeAIUseCase": { "type": "object", "properties": { "useCase": { "enum": [ "designTimeGeneration", "intentSentenceGeneration", "aiEnhancedOutputs", "lexiconGeneration", "flowGeneration", "gptConversation", "gptPromptNode", "generateNodeOutput", "knowledgeSearch", "sentimentAnalysis" ] } } }, "TResourceType": { "type": "string", "description": "The type of a resource", "example": "flow", "enum": [ "aiAgent", "agentassistconfig", "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "handoverProvider", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "knowledgeStore", "largeLanguageModel", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "goal", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "simulation" ] }, "TSearchableResourceType": { "type": "string", "description": "The type of a resource", "example": "endpoint", "enum": [ "endpoint", "extension", "flow", "function", "lexicon", "goal", "handoverProvider", "nluconnector", "playbook", "project", "snapshot" ] }, "TPinnableResourceType": { "type": "string", "description": "The type of a pinnable resource", "example": "project", "enum": [ "project" ] }, "TSlotFillerType": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "IAuditEvent_2_0": { "type": "object", "properties": { "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "description": "The timestamp when the action happened", "example": "2020-04-27T14:22:11.000Z" }, "type": { "type": "string", "description": "The type of operation that was performed", "example": "create", "enum": [ "action", "create", "replace", "patch", "delete", "authentication", "authorization" ] }, "user": { "type": "string", "description": "The email of the user who performed the operation", "example": "hans.mustermann@xyz.com" }, "modifiedResources": { "type": "array", "description": "An list of resources in the chain of the modification", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "The id of the resource in the modification chain", "example": "5e997f0cdcfc57730cf32941" }, "resourceType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "aiAgent", "agentassistconfig", "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "handoverProvider", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "knowledgeStore", "largeLanguageModel", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "goal", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "simulation", "aicopilotconfig", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "trainerRecord", "user", "yesNoIntent" ] } } } }, "payload": { "type": "object", "description": "The raw payload of the operation in case it was tracked", "example": { "name": "new resource name" } } } }, "IAuditEventIndexItem_2_0": { "type": "object", "properties": { "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp when the action happened", "example": "2020-04-27T14:22:11.000Z" }, "type": { "type": "string", "description": "The type of operation that was performed", "example": "create", "enum": [ "action", "create", "replace", "patch", "delete", "authentication", "authorization" ] }, "user": { "type": "string", "description": "The email of the user who performed the operation", "example": "hans.mustermann@xyz.com" }, "modifiedResources": { "type": "array", "description": "A list of resources in the chain of the modification", "items": { "type": "object", "properties": { "elementId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "elementType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "aiAgent", "agentassistconfig", "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "handoverProvider", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "knowledgeStore", "largeLanguageModel", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "goal", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "simulation", "aicopilotconfig", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "trainerRecord", "user", "yesNoIntent" ] } } } } } }, "IApiKeyData_2_0": { "type": "object", "properties": { "name": { "type": "string" } } }, "IApiKey_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 }, "apiKey": { "type": "string" } } }, "IApiKeyIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "apiKey": { "type": "string" }, "createdAt": { "type": "number" } } }, "IExchangeCXoneTokenRestReturnValue_2_0": { "type": "object", "properties": { "refreshToken": { "type": "string" } } }, "IExchangeOneTimeTokenForRefreshTokenRestReturnValue_2_0": { "type": "object", "properties": { "refreshToken": { "type": "string" } } }, "IGetPinnedResourcesRestReturnValue_2_0": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of a pinnable resource", "example": "project", "enum": [ "project" ] }, "pinnedIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "ILoginAttempt_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "failed" ] }, "timestamp": { "type": "number" }, "location": { "type": "string" } } }, "ILoginAttemptIndexItem_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "failed" ] }, "timestamp": { "type": "number" }, "location": { "type": "string" } } }, "IPinResourceRestDataBody_2_0": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "The type of a pinnable resource", "example": "project", "enum": [ "project" ] }, "resourceId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "pin": { "type": "boolean" } } }, "IProjectMemberData_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "agentAssistConfigAdmin", "agentAssistConfigViewer", "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "followUser", "handoverProviderAdmin", "intents", "data_privacy_admin", "data_privacy_editor", "data_privacy_viewer", "knowledgeAdmin", "large_language_model_admin,", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "simulator_admin", "admin" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "acl": { "type": "object" }, "allowedLocales": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "IProjectMember_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "agentAssistConfigAdmin", "agentAssistConfigViewer", "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "followUser", "handoverProviderAdmin", "intents", "data_privacy_admin", "data_privacy_editor", "data_privacy_viewer", "knowledgeAdmin", "large_language_model_admin,", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "simulator_admin", "admin" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "acl": { "type": "object" }, "allowedLocales": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IProjectMemberIndexItem_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IUserData_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" } } }, "IUserDataCreate_2_0": { "type": "object", "required": [ "id", "name", "password" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "password": { "type": "string", "description": "Enter password in case of non-sso user" } } }, "IUser_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IUserAcl_2_0": { "type": "object", "properties": { "organisationWide": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "auditEvents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentAccount": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "knowledgeStores": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentInbox": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "goals": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "voiceGatewayAccount": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } } } }, "projectWide": { "type": "object", "additionalProperties": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "agentAssistConfigs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analytics": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensionsTrust": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "handoverProviders": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "largeLanguageModels": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "knowledgeStores": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentInbox": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "goals": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "simulator": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "additionalProperties": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "agentAssistConfigAdmin", "agentAssistConfigViewer", "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "followUser", "handoverProviderAdmin", "intents", "data_privacy_admin", "data_privacy_editor", "data_privacy_viewer", "knowledgeAdmin", "large_language_model_admin,", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "simulator_admin" ] } }, "allowedLocales": { "type": "array", "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "primary": { "type": "boolean" } } } } } } } } }, "IUserIndexItem_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "lastActive": { "type": "number" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IUserAdditional_2_0": { "type": "object", "properties": { "newPassword": { "type": "string" } } }, "IUserMeAdditional_2_0": { "type": "object", "properties": { "oldPassword": { "type": "string" }, "newPassword": { "type": "string" } } }, "IUserUpdate_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "newPassword": { "type": "string" } } }, "IUserUpdateMe_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "oldPassword": { "type": "string" }, "newPassword": { "type": "string" } } }, "IApiKeyData_2_1": { "type": "object", "properties": { "name": { "type": "string" } } }, "IApiKey_2_1": { "type": "object", "properties": { "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 }, "apiKey": { "type": "string" } } }, "IApiKeyIndexItem_2_1": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "createdAt": { "type": "number" } } }, "IDeleteAnalyticsRecordsRestDataBody_2_0": { "type": "object", "properties": { "contactIds": { "type": "array", "nullable": true, "items": { "type": "string" } }, "timestampStart": { "type": "string", "example": "2020-01-01T00:00:00Z" }, "timestampEnd": { "type": "string", "example": "2020-01-31T23:59:00Z" } } }, "IUpdateAnalyticsRecordProperties_2_0": { "type": "object", "properties": { "state": { "type": "string" }, "mode": { "type": "string" }, "userType": { "type": "string" }, "channel": { "type": "string" }, "flowLanguage": { "type": "string" }, "intent": { "type": "string" }, "intentScore": { "type": "number" }, "intentFlow": { "type": "string" }, "flowName": { "type": "string" }, "inHandoverRequest": { "type": "boolean" }, "inHandoverConversation": { "type": "boolean" }, "localeName": { "type": "string" }, "rating": { "type": "number" }, "ratingComment": { "type": "string" }, "entrypointType": { "type": "string" }, "trackedGoals": { "type": "array", "items": { "type": "string" } }, "endpointName": { "type": "string" }, "endpointUrlToken": { "type": "string" }, "handoverEscalations": { "type": "number" }, "snapshotName": { "type": "string" }, "slots": { "type": "object" }, "custom1": { "type": "string" }, "custom2": { "type": "string" }, "custom3": { "type": "string" }, "custom4": { "type": "string" }, "custom5": { "type": "string" }, "custom6": { "type": "string" }, "custom7": { "type": "string" }, "custom8": { "type": "string" }, "custom9": { "type": "string" }, "custom10": { "type": "string" } } }, "IAudioPreviewLanguages_2_0": { "type": "object", "properties": { "audioPreviewLanguages": { "type": "array", "items": { "type": "object", "properties": { "voiceId": { "type": "string", "maxLength": 50, "description": "Audio preview provided voice Id. This is the ID that you specify when calling the SynthesizeSpeech operation." }, "languageCode": { "type": "string", "maxLength": 10, "description": "Language code of the voice." } } } } } }, "ITestVoiceProvider_2_0": { "type": "object", "properties": { "voiceProvider": { "type": "string" }, "isCredentialsValid": { "type": "boolean" }, "msg": { "type": "string" }, "msgErr": { "type": "string" } } }, "IVGCallSettings_2_0": { "type": "object", "properties": { "sipRealm": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "userId": { "description": "temporary user id", "type": "string" } } }, "IVoicePrepareCall_2_0": { "type": "object", "properties": { "entrypoint": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "nluConnectorId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "language": { "type": "string" }, "voice": { "type": "string" } } }, "TRelType": { "type": "array", "items": { "type": "string", "enum": [ "idp" ] } }, "IWebfingerRestReturnValue": { "type": "object", "properties": { "subject": { "type": "string", "example": "org:5ce7c2d833ea1e04d7e6c432" }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "enum": [ "idp" ] }, "properties": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } } ] } } } } } }, "TRel": { "type": "object", "properties": { "rel": { "type": "string", "enum": [ "idp" ] }, "properties": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } } ] } } }, "IIdpRel": { "type": "object", "properties": { "rel": { "type": "string", "enum": [ "idp" ] }, "properties": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } } ] } } }, "TIdpWebfingerProperties": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } } ] }, "INoneIdpWebfingerProperties": { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, "IOidcIdpWebfingerProperties": { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, "ISamlIdpWebfingerProperties": { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } }, "IAlexaSkill_2_0": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } }, "IAmazonUser_2_0": { "type": "object", "properties": { "userId": { "type": "string", "description": "The userId of the amazon user in the platform." }, "accessToken": { "type": "string", "description": "The user's access token that allows platform to make requests to Amazon." }, "refreshToken": { "type": "string", "description": "A refresh token that is used to generate a new access token refresh token pair." } } }, "IAnalyticsQueryFilter_2_0": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "notEquals", "gt", "gte", "lt", "lte" ] }, "values": { "type": "array", "items": { "type": "string" } } } } } } }, "ILoadMessagesReportByQueryHashResponse_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "done", "error" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string" } }, "example": { "message": "I want pizza", "count": 12345, "source": "bot" } } } }, "example": { "status": "done", "data": [ { "message": "I want pizza", "count": 12345, "source": "bot" } ] } }, "ITopNMessages_2_0": { "type": "object", "properties": { "message": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string" } }, "example": { "message": "I want pizza", "count": 12345, "source": "bot" } }, "IGenerateReportResponse_2_0": { "type": "object", "properties": { "queryHash": { "type": "string" } } }, "ILoadReportByQueryHashResponse_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "done", "error" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "dimension": { "type": "string" }, "measure": { "type": "number" }, "value": { "type": "string" } } } } }, "example": { "status": "done", "data": [ { "dimension": "2021-01", "measure": 0 }, { "dimension": "2021-02", "measure": 1 }, { "dimension": "2021-03", "measure": 0 }, { "dimension": "2021-04", "measure": 1 } ] } }, "ILoadStepReportByQueryHashResponse_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "done", "error" ] }, "data": { "type": "object", "properties": { "_id": { "type": "string" }, "step": { "type": "string" }, "type": { "type": "string", "enum": [ "intent", "node" ] }, "count": { "type": "number" }, "flowReferenceId": { "type": "string" }, "flowName": { "type": "string" }, "entityReferenceId": { "type": "string" }, "children": { "type": "array", "items": { "type": "object" } } }, "example": { "step": "Collect Email", "type": "node", "count": 10, "flowReferenceId": "5dcf4edd-e5da-4bdc-837f-f482f8b90f47", "flowName": "Main", "entityReferenceId": "9f5078b4-2c0e-4e62-a1a3-9f5c1db89ee9", "children": [ { "step": "Find Bookings", "type": "node", "count": 8, "flowReferenceId": "5dcf4edd-e5da-4bdc-837f-f482f8b90f47", "flowName": "Main", "entityReferenceId": "d623f450-ce35-4872-9842-3071ade1430f" }, { "step": "Help", "type": "intent", "count": 2, "flowReferenceId": "5dcf4edd-e5da-4bdc-837f-f482f8b90f47", "flowName": "Main", "entityReferenceId": "bfdb0179-32c2-4d5c-bf42-8882f14824a2" } ] } } } }, "IStep_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "intent", "node" ] }, "entityReferenceId": { "type": "string" }, "flowReferenceId": { "type": "string" }, "flowName": { "type": "string" }, "projectName": { "type": "string" }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "organisationId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "snapshotName": { "type": "string" }, "snapshotId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IStepIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "intent", "node" ] }, "entityReferenceId": { "type": "string" }, "flowReferenceId": { "type": "string" }, "flowName": { "type": "string" }, "snapshotName": { "type": "string" }, "snapshotId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IStepReport_2_0": { "type": "object", "properties": { "_id": { "type": "string" }, "step": { "type": "string" }, "type": { "type": "string", "enum": [ "intent", "node" ] }, "count": { "type": "number" }, "flowReferenceId": { "type": "string" }, "flowName": { "type": "string" }, "entityReferenceId": { "type": "string" }, "children": { "type": "array", "items": { "type": "object" } } }, "example": { "step": "Collect Email", "type": "node", "count": 10, "flowReferenceId": "5dcf4edd-e5da-4bdc-837f-f482f8b90f47", "flowName": "Main", "entityReferenceId": "9f5078b4-2c0e-4e62-a1a3-9f5c1db89ee9", "children": [ { "step": "Find Bookings", "type": "node", "count": 8, "flowReferenceId": "5dcf4edd-e5da-4bdc-837f-f482f8b90f47", "flowName": "Main", "entityReferenceId": "d623f450-ce35-4872-9842-3071ade1430f" }, { "step": "Help", "type": "intent", "count": 2, "flowReferenceId": "5dcf4edd-e5da-4bdc-837f-f482f8b90f47", "flowName": "Main", "entityReferenceId": "bfdb0179-32c2-4d5c-bf42-8882f14824a2" } ] } }, "TAnalyticsQueryFilterOperator_2_0": { "type": "string", "enum": [ "equals", "notEquals", "gt", "gte", "lt", "lte" ] }, "ILoadTranscriptsReportByQueryHashResponse_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "done", "error" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "contactId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectName": { "type": "string" }, "flowName": { "type": "string" }, "messages": { "type": "integer" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "ratings": { "type": "array", "items": { "type": "number" } }, "ratingComments": { "type": "array", "items": { "type": "string" } }, "endpointName": { "type": "string" } } } } } }, "IStepPath_2_0": { "type": "object", "properties": { "value": { "type": "string" }, "match": { "type": "string" } } }, "IOrganisationData_2_0": { "type": "object", "properties": { "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "quotaMaxKnowledgeChunks": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "billingTimezone": { "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" ] }, "dataPrivacySettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "voiceConfigurations": { "type": "object", "properties": { "enableNiceSharedProviders": { "type": "boolean", "description": "[Deprecated] Derived from niceProvidedSpeechEntitlements" }, "orgVoiceGatewayEnabled": { "type": "boolean", "description": "Whether Voice Gateway is enabled for this organisation" }, "niceProvidedSpeechEntitlements": { "type": "array", "items": { "type": "object", "required": [ "vendor", "stt", "tts" ], "properties": { "vendor": { "type": "string", "description": "Speech vendor identifier (e.g. 'nice-stt', 'microsoft', 'deepgram')" }, "stt": { "type": "boolean", "description": "Whether STT is enabled for this vendor" }, "tts": { "type": "boolean", "description": "Whether TTS is enabled for this vendor" } } }, "description": "Per-vendor, per-capability entitlements for NiCE-provided speech providers" } } }, "aiOpsCenterEnabled": { "type": "boolean" }, "businessUnitId": { "type": "string", "description": "The business unit ID" }, "tenantId": { "type": "string", "description": "The tenant ID" } } }, "IOrganisation_2_0": { "properties": { "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "quotaMaxKnowledgeChunks": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "billingTimezone": { "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" ] }, "dataPrivacySettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "voiceConfigurations": { "type": "object", "properties": { "enableNiceSharedProviders": { "type": "boolean", "description": "[Deprecated] Derived from niceProvidedSpeechEntitlements" }, "orgVoiceGatewayEnabled": { "type": "boolean", "description": "Whether Voice Gateway is enabled for this organisation" }, "niceProvidedSpeechEntitlements": { "type": "array", "items": { "type": "object", "required": [ "vendor", "stt", "tts" ], "properties": { "vendor": { "type": "string", "description": "Speech vendor identifier (e.g. 'nice-stt', 'microsoft', 'deepgram')" }, "stt": { "type": "boolean", "description": "Whether STT is enabled for this vendor" }, "tts": { "type": "boolean", "description": "Whether TTS is enabled for this vendor" } } }, "description": "Per-vendor, per-capability entitlements for NiCE-provided speech providers" } } }, "aiOpsCenterEnabled": { "type": "boolean" }, "businessUnitId": { "type": "string", "description": "The business unit ID" }, "tenantId": { "type": "string", "description": "The tenant ID" } }, "required": [ "name" ], "type": "object" }, "IUpdateOrganisation_2_0": { "properties": { "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "quotaMaxKnowledgeChunks": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "billingTimezone": { "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" ] }, "dataPrivacySettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "voiceConfigurations": { "type": "object", "properties": { "enableNiceSharedProviders": { "type": "boolean", "description": "[Deprecated] Derived from niceProvidedSpeechEntitlements" }, "orgVoiceGatewayEnabled": { "type": "boolean", "description": "Whether Voice Gateway is enabled for this organisation" }, "niceProvidedSpeechEntitlements": { "type": "array", "items": { "type": "object", "required": [ "vendor", "stt", "tts" ], "properties": { "vendor": { "type": "string", "description": "Speech vendor identifier (e.g. 'nice-stt', 'microsoft', 'deepgram')" }, "stt": { "type": "boolean", "description": "Whether STT is enabled for this vendor" }, "tts": { "type": "boolean", "description": "Whether TTS is enabled for this vendor" } } }, "description": "Per-vendor, per-capability entitlements for NiCE-provided speech providers" } } }, "aiOpsCenterEnabled": { "type": "boolean" }, "businessUnitId": { "type": "string", "description": "The business unit ID" }, "tenantId": { "type": "string", "description": "The tenant ID" } }, "type": "object" }, "IOrganisationPasswordPolicy_2_0": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "IOrganisationDataPrivacySettings_2_0": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "INiceProvidedSpeechEntitlement_2_0": { "type": "object", "required": [ "vendor", "stt", "tts" ], "properties": { "vendor": { "type": "string", "description": "Speech vendor identifier (e.g. 'nice-stt', 'microsoft', 'deepgram')" }, "stt": { "type": "boolean", "description": "Whether STT is enabled for this vendor" }, "tts": { "type": "boolean", "description": "Whether TTS is enabled for this vendor" } } }, "IOrganisationVoiceConfiguration_2_0": { "type": "object", "properties": { "enableNiceSharedProviders": { "type": "boolean", "description": "[Deprecated] Derived from niceProvidedSpeechEntitlements" }, "orgVoiceGatewayEnabled": { "type": "boolean", "description": "Whether Voice Gateway is enabled for this organisation" }, "niceProvidedSpeechEntitlements": { "type": "array", "items": { "type": "object", "required": [ "vendor", "stt", "tts" ], "properties": { "vendor": { "type": "string", "description": "Speech vendor identifier (e.g. 'nice-stt', 'microsoft', 'deepgram')" }, "stt": { "type": "boolean", "description": "Whether STT is enabled for this vendor" }, "tts": { "type": "boolean", "description": "Whether TTS is enabled for this vendor" } } }, "description": "Per-vendor, per-capability entitlements for NiCE-provided speech providers" } } }, "IOrganisationIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "businessUnitId": { "type": "string", "description": "The business unit ID" }, "tenantId": { "type": "string", "description": "The tenant ID" }, "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "quotaMaxKnowledgeChunks": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "liveAgentAccount": { "type": "number" }, "billingTimezone": { "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" ] }, "dataPrivacySettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "aiOpsCenterEnabled": { "type": "boolean" } } }, "IUserDataManagement_2_0": { "type": "object", "required": [ "id", "name", "password", "organisation" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "cxoneEmail": { "type": "string", "description": "The email address of the CXOne user, only required for NiCE CXOne users" }, "cxoneId": { "type": "string", "description": "The CXOne ID of the user, only required for NiCE CXOne users" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" } } }, "IUserUpdateDataManagement_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "cxoneEmail": { "type": "string", "description": "The email address of the CXOne user, only required for NiCE CXOne users" }, "cxoneId": { "type": "string", "description": "The CXOne ID of the user, only required for NiCE CXOne users" } } }, "IManagementUserAdditional_2_0": { "type": "object", "properties": { "newPassword": { "type": "string" } } }, "IManagementUserUpdate_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "cxoneEmail": { "type": "string", "description": "The email address of the CXOne user, only required for NiCE CXOne users" }, "cxoneId": { "type": "string", "description": "The CXOne ID of the user, only required for NiCE CXOne users" }, "newPassword": { "type": "string" } } }, "IUserManagement_2_0": { "type": "object", "required": [ "id", "name", "password", "organisation" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "cxoneEmail": { "type": "string", "description": "The email address of the CXOne user, only required for NiCE CXOne users" }, "cxoneId": { "type": "string", "description": "The CXOne ID of the user, only required for NiCE CXOne users" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IUserManagementIndexItem_2_0": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "cxoneEmail": { "type": "string", "description": "The email address of the CXOne user, only required for NiCE CXOne users" }, "cxoneId": { "type": "string", "description": "The CXOne ID of the user, only required for NiCE CXOne users" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IVendor_2_0": { "type": "object", "properties": { "version": { "type": "string", "description": "The product version we are running" }, "frontendBaseUrl": { "type": "string", "description": "Base URL to the frontend UI" }, "hasLicenseAgreement": { "type": "string", "description": "Flag whether users need to agree the license agreement within this env" }, "maxContactProfileTTL": { "type": "number" }, "maxConversationTTL": { "type": "number" }, "maxSessionStateTTL": { "type": "number" } } }, "ICallCounterAggregatedValue_2_0": { "type": "object", "properties": { "calls": { "type": "number" }, "duration": { "type": "number" }, "concurrentCalls": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" } } }, "ICallCounterAggregatedValue_3_0": { "type": "object", "properties": { "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "maxConcurrency": { "type": "number" }, "callMinutes": { "type": "number" }, "processedCalls": { "type": "number" }, "billableCalls": { "type": "number" } } }, "IConversationCounterAggregatedValue_2_0": { "type": "object", "properties": { "conversations": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "channel": { "type": "string" } } }, "IConversationCounterAggregatedValue_3_0": { "type": "object", "properties": { "conversations": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "perChannel": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string" }, "conversations": { "type": "number" } } } } } }, "IConversationData_2_0": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectName": { "type": "string" }, "inputId": { "type": "string" }, "sessionId": { "type": "string" }, "contactId": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inputText": { "type": "string" }, "inputData": { "type": "object" }, "type": { "type": "string", "example": "user", "enum": [ "input", "output" ] }, "source": { "type": "string", "example": "user", "enum": [ "user", "bot", "agent", "suggestion" ] }, "flowName": { "type": "string" }, "flowReferenceId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "timestamp": { "type": "object" }, "inHandoverRequest": { "type": "boolean" }, "inHandoverConversation": { "type": "boolean" }, "outputId": { "type": "string" }, "expiresAt": { "type": "object" }, "endpointUrlToken": { "type": "string" }, "endpointName": { "type": "string" }, "localeReferenceId": { "type": "string" }, "localeName": { "type": "string" }, "snapshotId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "snapshotName": { "type": "string" }, "rating": { "type": "number" }, "ratingComment": { "type": "string" } } }, "IConversationSession_2_0": { "type": "object", "properties": { "_id": { "type": "string" }, "contactId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectName": { "type": "string" }, "flowName": { "type": "string" }, "messages": { "type": "integer" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "ratings": { "type": "array", "items": { "type": "number" } }, "ratingComments": { "type": "array", "items": { "type": "string" } }, "endpointName": { "type": "string" } } }, "TAnalyticsSource_2_0": { "type": "string", "example": "user", "enum": [ "user", "bot", "agent", "suggestion" ] }, "TAnalyticsType_2_0": { "type": "string", "example": "user", "enum": [ "input", "output" ] }, "IKnowledgeQueryCounterAggregatedValue_2_0": { "type": "object", "properties": { "queries": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" } } }, "ILogEntry_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "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", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" } } }, "IProfileData_2_0": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } } } }, "IProfile_2_0": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IMemory": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "IFlattenedProfile_2_0": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "IProfileIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "type": { "type": "string", "enum": [ "simulator" ] }, "contactIds": { "type": "array", "items": { "type": "string" } }, "lastChanged": { "type": "number" }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IProfileSchemaData_2_0": { "type": "object", "properties": { "schema": { "type": "object" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "internal": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "object", "number", "boolean" ] } } } } } }, "IProfileSchema_2_0": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } } } }, "IProfileSchemaEntry_2_0": { "type": "object", "properties": { "field": { "type": "string" }, "internal": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "object", "number", "boolean" ] } } }, "ITaskData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "currentStep": { "type": "integer" }, "totalStep": { "type": "integer" }, "failReason": { "type": "string" }, "lastRunAt": { "type": "string", "format": "date-time" }, "lastFinishedAt": { "type": "string", "format": "date-time" } } }, "ITask_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "currentStep": { "type": "integer" }, "totalStep": { "type": "integer" }, "failReason": { "type": "string" }, "lastRunAt": { "type": "string", "format": "date-time" }, "lastFinishedAt": { "type": "string", "format": "date-time" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "TTaskStatus_2_0": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "ICreatedTask_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } }, "ITaskIndexItemData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "currentStep": { "type": "integer" }, "lastRunAt": { "type": "string", "format": "date-time" }, "lastFinishedAt": { "type": "string", "format": "date-time" }, "totalStep": { "type": "integer" }, "failReason": { "type": "string" } } }, "ITaskIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "currentStep": { "type": "integer" }, "totalStep": { "type": "integer" }, "failReason": { "type": "string" }, "lastRunAt": { "type": "string", "format": "date-time" }, "lastFinishedAt": { "type": "string", "format": "date-time" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ITaskData_2_1": { "type": "object", "properties": { "type": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "runAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" }, "failReason": { "type": "string" }, "failedAt": { "type": "string", "format": "date-time" } } }, "ITask_2_1": { "type": "object", "properties": { "type": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "runAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" }, "failReason": { "type": "string" }, "failedAt": { "type": "string", "format": "date-time" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "TTaskStatus_2_1": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "ICreatedTask_2_1": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "progress": { "type": "integer", "example": 0 } } }, "ITaskIndexItemData_2_1": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "runAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" }, "failReason": { "type": "string" }, "failedAt": { "type": "string", "format": "date-time" } } }, "ITaskIndexItem_2_1": { "type": "object", "properties": { "type": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "runAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" }, "failReason": { "type": "string" }, "failedAt": { "type": "string", "format": "date-time" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ITrainerRecordData_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the user", "example": "I want a Pizza" }, "count": { "type": "number", "description": "How often the text was used as an input", "example": 2 }, "flowReferenceId": { "type": "string", "format": "uuid" }, "handled": { "type": "boolean" }, "handleAction": { "type": "string", "enum": [ "addedToIntent", "skip", "ignored" ] }, "nlu": { "type": "object", "description": "The last NLU object that was created (from InputObject) based on the message" }, "meta": { "type": "object" }, "snapshotReference": { "type": "string", "description": "Reference to a snapshot in case this record was created because a user talked to a snapshot" } } }, "ITrainerRecord_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the user", "example": "I want a Pizza" }, "count": { "type": "number", "description": "How often the text was used as an input", "example": 2 }, "flowReferenceId": { "type": "string", "format": "uuid" }, "handled": { "type": "boolean" }, "handleAction": { "type": "string", "enum": [ "addedToIntent", "skip", "ignored" ] }, "nlu": { "type": "object", "description": "The last NLU object that was created (from InputObject) based on the message" }, "meta": { "type": "object" }, "snapshotReference": { "type": "string", "description": "Reference to a snapshot in case this record was created because a user talked to a snapshot" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ITrainerRecordIndexItem_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the user", "example": "I want a Pizza" }, "count": { "type": "number", "description": "How often the text was used as an input", "example": 2 }, "flowReferenceId": { "type": "string", "format": "uuid" }, "handled": { "type": "boolean" }, "handleAction": { "type": "string", "enum": [ "addedToIntent", "skip", "ignored" ] }, "nlu": { "type": "object", "description": "The last NLU object that was created (from InputObject) based on the message" }, "meta": { "type": "object" }, "snapshotReference": { "type": "string", "description": "Reference to a snapshot in case this record was created because a user talked to a snapshot" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IGenerateNluScoreData_2_0": { "type": "object", "required": [ "flowReferenceId", "localeReferenceId", "sentence" ], "properties": { "flowReferenceId": { "type": "string", "format": "uuid", "description": "UUID of the flow reference." }, "localeReferenceId": { "type": "string", "format": "uuid", "description": "UUID of the locale reference." }, "sentence": { "type": "string", "description": "Sentence to analyze for NLU scoring." } } }, "IGeneratedNluScore_2_0": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the score." }, "name": { "type": "string", "description": "Name of the score type." }, "score": { "type": "number", "description": "Numerical value of the score." }, "negated": { "type": "boolean", "description": "Indicates if the score is negated." }, "confirmationSentence": { "type": "string", "description": "Sentence used to confirm the score." }, "confirmationSentences": { "type": "array", "items": { "type": "string" }, "description": "Multiple sentences for confirmation if applicable." }, "disambiguationSentence": { "type": "string", "description": "Sentence used for disambiguation." }, "flow": { "type": "string", "description": "UUID of the flow associated with the score." } } }, "IAgentAssistGridConfig_2_0": { "type": "object", "properties": { "grid": { "type": "object", "properties": { "columns": { "type": "number", "description": "Number of columns in the grid." }, "rows": { "type": "number", "description": "Number of rows in the grid." }, "gap": { "type": "number", "description": "Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used." } } }, "tiles": { "type": "object", "properties": { "tile-id": { "type": "object", "description": "The Tile ID is used in the Flow Nodes to fill in this specific tile.", "properties": { "x": { "type": "number", "description": "The row number where the tile is located, starting from 1." }, "y": { "type": "number", "description": "The column number where the tile is located, starting from 1." }, "columns": { "type": "number", "description": "The number of columns the tile should occupy. The default value is 1." }, "rows": { "type": "number", "description": "The number of rows the tile should occupy. The default value is 1." } } } } } } }, "IAgentAssistConfigData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The human readable name of the config." }, "description": { "type": "string", "description": "The description which can be used to understand what the agent assist config contains in terms of tiles." }, "config": { "type": "object", "description": "The actual grid-config.", "properties": { "grid": { "type": "object", "properties": { "columns": { "type": "number", "description": "Number of columns in the grid." }, "rows": { "type": "number", "description": "Number of rows in the grid." }, "gap": { "type": "number", "description": "Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used." } } }, "tiles": { "type": "object", "properties": { "tile-id": { "type": "object", "description": "The Tile ID is used in the Flow Nodes to fill in this specific tile.", "properties": { "x": { "type": "number", "description": "The row number where the tile is located, starting from 1." }, "y": { "type": "number", "description": "The column number where the tile is located, starting from 1." }, "columns": { "type": "number", "description": "The number of columns the tile should occupy. The default value is 1." }, "rows": { "type": "number", "description": "The number of rows the tile should occupy. The default value is 1." } } } } } } } } }, "IAgentAssistConfigGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" } } }, "IAgentAssistConfig_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The human readable name of the config." }, "description": { "type": "string", "description": "The description which can be used to understand what the agent assist config contains in terms of tiles." }, "config": { "type": "object", "description": "The actual grid-config.", "properties": { "grid": { "type": "object", "properties": { "columns": { "type": "number", "description": "Number of columns in the grid." }, "rows": { "type": "number", "description": "Number of rows in the grid." }, "gap": { "type": "number", "description": "Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used." } } }, "tiles": { "type": "object", "properties": { "tile-id": { "type": "object", "description": "The Tile ID is used in the Flow Nodes to fill in this specific tile.", "properties": { "x": { "type": "number", "description": "The row number where the tile is located, starting from 1." }, "y": { "type": "number", "description": "The column number where the tile is located, starting from 1." }, "columns": { "type": "number", "description": "The number of columns the tile should occupy. The default value is 1." }, "rows": { "type": "number", "description": "The number of rows the tile should occupy. The default value is 1." } } } } } } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IAiAgentData_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "Cognigy AI Agent" }, "image": { "type": "string", "description": "Avatar of the AI Agent.", "example": "https://cognigy.com/ai-agent.png" }, "imageOptimizedFormat": { "type": "boolean", "description": "Whether the optimized image format defined by Cognigy is used.", "example": true }, "knowledgeReferenceId": { "type": "string", "nullable": true, "format": "uuid", "description": "A referenceId of a Knowledge Store this Agent will use as base knowledge or null.", "example": "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b" }, "description": { "type": "string", "maxLength": 1000, "description": "A short description of the AI Agent, up to 1000 characters.", "example": "I am a virtual assistant that can help you with your questions." }, "speakingStyle": { "type": "object", "properties": { "completeness": { "type": "string" }, "formality": { "type": "string" } }, "example": { "completeness": "concise", "formality": "formal" } }, "voiceConfigs": { "type": "object", "properties": { "ttsVoice": { "type": "string" }, "ttsLanguage": { "type": "string" }, "ttsVendor": { "enum": [ "aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none" ], "type": "string" }, "ttsModel": { "type": "string" }, "ttsLabel": { "type": "string" }, "ttsDisableCache": { "type": "boolean" } }, "example": { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false } }, "enableVoiceConfigs": { "type": "boolean", "description": "Enables the use of voice configuration.", "example": false }, "enableAutoLanguageDetection": { "type": "boolean", "description": "Whether the AI Agent should automatically detect and respond in the user's language.", "example": true }, "safetySettings": { "type": "object", "properties": { "avoidHarmfulContent": { "type": "boolean" }, "avoidUngroundedContent": { "type": "boolean" }, "avoidCopyrightInfringements": { "type": "boolean" }, "preventJailbreakAndManipulation": { "type": "boolean" } } }, "contactProfilesOption": { "type": "string", "enum": [ "none", "selectedProfileFields", "completeProfile", "profileMemoriesOnly" ], "description": "Option to enable or customize Contact profiles selection for the AI Agent.", "example": "selectedProfileFields" }, "contactProfilesSelected": { "type": "array", "items": { "type": "string" }, "description": "Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.", "example": [ "name", "email" ] }, "instructions": { "type": "string", "description": "Instructions for the AI Agent.", "example": "I can help you with your questions, provide information and much more.", "maxLength": 1000 } } }, "IAiAgent_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "Cognigy AI Agent" }, "image": { "type": "string", "description": "Avatar of the AI Agent.", "example": "https://cognigy.com/ai-agent.png" }, "imageOptimizedFormat": { "type": "boolean", "description": "Whether the optimized image format defined by Cognigy is used.", "example": true }, "knowledgeReferenceId": { "type": "string", "nullable": true, "format": "uuid", "description": "A referenceId of a Knowledge Store this Agent will use as base knowledge or null.", "example": "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b" }, "description": { "type": "string", "maxLength": 1000, "description": "A short description of the AI Agent, up to 1000 characters.", "example": "I am a virtual assistant that can help you with your questions." }, "speakingStyle": { "type": "object", "properties": { "completeness": { "type": "string" }, "formality": { "type": "string" } }, "example": { "completeness": "concise", "formality": "formal" } }, "voiceConfigs": { "type": "object", "properties": { "ttsVoice": { "type": "string" }, "ttsLanguage": { "type": "string" }, "ttsVendor": { "enum": [ "aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none" ], "type": "string" }, "ttsModel": { "type": "string" }, "ttsLabel": { "type": "string" }, "ttsDisableCache": { "type": "boolean" } }, "example": { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false } }, "enableVoiceConfigs": { "type": "boolean", "description": "Enables the use of voice configuration.", "example": false }, "enableAutoLanguageDetection": { "type": "boolean", "description": "Whether the AI Agent should automatically detect and respond in the user's language.", "example": true }, "safetySettings": { "type": "object", "properties": { "avoidHarmfulContent": { "type": "boolean" }, "avoidUngroundedContent": { "type": "boolean" }, "avoidCopyrightInfringements": { "type": "boolean" }, "preventJailbreakAndManipulation": { "type": "boolean" } } }, "contactProfilesOption": { "type": "string", "enum": [ "none", "selectedProfileFields", "completeProfile", "profileMemoriesOnly" ], "description": "Option to enable or customize Contact profiles selection for the AI Agent.", "example": "selectedProfileFields" }, "contactProfilesSelected": { "type": "array", "items": { "type": "string" }, "description": "Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.", "example": [ "name", "email" ] }, "instructions": { "type": "string", "description": "Instructions for the AI Agent.", "example": "I can help you with your questions, provide information and much more.", "maxLength": 1000 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IAiAgentHiringTemplate_2_0": { "type": "object", "properties": { "templateId": { "type": "string", "description": "The ID of the AI Agent template to hire.", "example": "RetailAssistant-Rita" }, "aiAgentName": { "type": "string", "description": "The name of the AI Agent.", "example": "Rita" }, "aiAgentFileName": { "type": "string", "description": "The file name of the AI Agent.", "example": "Rita.tar" }, "aiAgentImage": { "type": "string", "description": "The image of the AI Agent.", "example": "https://cognigy.com/rita.png" }, "aiAgentDescription": { "type": "string", "description": "A short description of the AI Agent, up to 1000 characters.", "example": "I am a virtual assistant that can help you with your questions." } } }, "IAiAgentJobNodeWithTools_2_0": { "type": "object", "properties": { "_id": { "type": "string" }, "referenceId": { "type": "string" }, "type": { "type": "string", "example": "aiAgentJob" }, "label": { "type": "string" }, "comment": { "type": "string" }, "commentColor": { "type": "string" }, "analyticsLabel": { "type": "string", "nullable": true }, "isDisabled": { "type": "boolean" }, "isEntryPoint": { "type": "boolean" }, "extension": { "type": "string" }, "config": { "type": "object", "description": "Job node configuration (content varies by implementation)" }, "tools": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "referenceId": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" }, "comment": { "type": "string" }, "commentColor": { "type": "string" }, "analyticsLabel": { "type": "string", "nullable": true }, "isDisabled": { "type": "boolean" }, "isEntryPoint": { "type": "boolean" }, "extension": { "type": "string" }, "config": { "type": "object", "description": "Tool node configuration (content varies by tool type)" } } } } } }, "IAiAgentJobToolNode_2_0": { "type": "object", "properties": { "_id": { "type": "string" }, "referenceId": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" }, "comment": { "type": "string" }, "commentColor": { "type": "string" }, "analyticsLabel": { "type": "string", "nullable": true }, "isDisabled": { "type": "boolean" }, "isEntryPoint": { "type": "boolean" }, "extension": { "type": "string" }, "config": { "type": "object", "description": "Tool node configuration (content varies by tool type)" } } }, "IAiAgentTemplateId_2_0": { "type": "object", "properties": { "templateId": { "type": "string", "description": "The ID of the AI Agent template to hire.", "example": "airline-support-agent-en" }, "overrideAiAgentReferenceId": { "type": "string", "description": "The reference ID of the AI Agent to override the AI Agent from the hired package.", "example": "5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b" } } }, "IChart_2_0": { "type": "object", "properties": { "nodes": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "type": { "type": "string", "example": "if" }, "referenceId": { "type": "string", "format": "uuid" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node" }, "analyticsLabel": { "type": "string", "example": "Step name" }, "comment": { "type": "string", "example": "this is a very important node" }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isCollapsed": { "type": "boolean", "example": false }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false } } } }, "relations": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "node": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "children": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "next": { "nullable": true, "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "IChartNodeData_2_0": { "type": "object", "properties": { "type": { "type": "string", "example": "if", "description": "Type of the Node" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node", "description": "Replaces the default name of the Node displayed in the Flow Editor." }, "comment": { "type": "string", "example": "this is a very important node", "description": "Adds additional information about Nodes, for example, a specific of the Node." }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false }, "config": { "type": "object", "example": { "condition": { "type": "rule", "condition": "", "rule": { "left": "1", "operand": "gt", "right": "2" } } } }, "localeReference": { "type": "string", "example": "63bd8ebb648e6e739f1bbd82" }, "analyticsLabel": { "type": "string", "example": "condition" }, "mock": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "example": false }, "code": { "type": "string", "example": "console.log('Hello, world!');", "description": "Mock code to be executed when the mock mode is enabled.", "nullable": false } } } } }, "IChartNode_2_0": { "type": "object", "properties": { "type": { "type": "string", "example": "if", "description": "Type of the Node" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node", "description": "Replaces the default name of the Node displayed in the Flow Editor." }, "comment": { "type": "string", "example": "this is a very important node", "description": "Adds additional information about Nodes, for example, a specific of the Node." }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false }, "config": { "type": "object", "example": { "condition": { "type": "rule", "condition": "", "rule": { "left": "1", "operand": "gt", "right": "2" } } } }, "localeReference": { "type": "string", "example": "63bd8ebb648e6e739f1bbd82" }, "analyticsLabel": { "type": "string", "example": "condition" }, "mock": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "example": false }, "code": { "type": "string", "example": "console.log('Hello, world!');", "description": "Mock code to be executed when the mock mode is enabled.", "nullable": false } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IChartNodeIndexItemData_2_0": { "type": "object", "properties": { "type": { "type": "string", "example": "if" }, "referenceId": { "type": "string", "format": "uuid" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node" }, "analyticsLabel": { "type": "string", "example": "Step name" }, "comment": { "type": "string", "example": "this is a very important node" }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isCollapsed": { "type": "boolean", "example": false }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false } } }, "IChartNodeIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "type": { "type": "string", "example": "if" }, "referenceId": { "type": "string", "format": "uuid" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node" }, "analyticsLabel": { "type": "string", "example": "Step name" }, "comment": { "type": "string", "example": "this is a very important node" }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isCollapsed": { "type": "boolean", "example": false }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false } } }, "IChartNodeRelation_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "node": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "children": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "next": { "nullable": true, "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IGenerateNodeOutput_2_0": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "userText": { "type": "string", "example": "greetings" }, "outputType": { "type": "string", "example": "text", "enum": [ "text", "adaptiveCard" ] }, "lastOutput": { "type": "string", "description": "Last adaptive card output", "example": "{\"$schema\":\"http://adaptivecards.io/schemas/adaptive-card.json\", ...}" }, "generateContentLimit": { "type": "number", "description": "The number of sentences to be generated", "example": 3 } } }, "IGenerateTextNodeOutputResponse_2_0": { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "string", "example": "Greetings" } }, "outputType": { "type": "string", "example": "text" } } }, "IGenerateAdaptiveCardNodeOutputResponse_2_0": { "type": "object", "properties": { "output": { "type": "object", "properties": { "type": { "type": "string", "example": "AdaptiveCard" }, "body": { "type": "array", "items": { "type": "object" } }, "actions": { "type": "array", "items": { "type": "object" } }, "version": { "type": "string", "example": 1 }, "speak": { "type": "string", "example": "create a poll for playing football on saturday at 3pm with the following options: yes, no, maybe" } } }, "outputType": { "type": "string", "example": "adaptiveCard" } } }, "IChartNodeSearchResult_2_0": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "nodeReferenceId": { "type": "string", "format": "uuid" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "fieldType": { "type": "string" }, "matchPath": { "type": "string" } } } } } }, "IConnectionDataFields_2_0": { "type": "object", "properties": { "fields": { "type": "object", "description": "The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.", "minProperties": 1, "maxProperties": 10, "example": { "some-key-from-connection-schema": "x123sdfu12312" } } } }, "IConnectionDataCreate_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "some name" }, "isDeprecated": { "type": "boolean", "description": "Marked 'true' if the connection type is deprecated" }, "type": { "type": "string", "example": "http_basic" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "fields": { "type": "object", "description": "The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.", "minProperties": 1, "maxProperties": 10, "example": { "some-key-from-connection-schema": "x123sdfu12312" } } } }, "IConnectionData": { "type": "object", "properties": { "referenceId": { "type": "string", "description": "The reference id of the Connection", "format": "uuid" }, "name": { "type": "string", "description": "The name of the Connection", "example": "Azure API" }, "isDeprecated": { "type": "boolean", "description": "Marked 'true' if the connection type is deprecated" }, "connectionSchema": { "type": "object", "description": "Identifies the schema which should be used to validate the connection fields.", "properties": { "extension": { "type": "string", "description": "The package-name of the extension.", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection defined in the extension.", "example": "oauth2" } } }, "fields": { "type": "object", "description": "The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.", "minProperties": 1, "maxProperties": 10, "example": { "some-key-from-connection-schema": "x123sdfu12312" } } } }, "IConnection_2_0": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the connection field. The key should match the connection schema of the specific connection type.", "example": "some-key-from-connection-schema" }, "value": { "type": "string", "description": "The value of the connection field", "example": "x123w123" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IConnectionData_2_0": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the connection field. The key should match the connection schema of the specific connection type.", "example": "some-key-from-connection-schema" }, "value": { "type": "string", "description": "The value of the connection field", "example": "x123w123" } } }, "IConnectionIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "referenceId": { "type": "string", "description": "The reference id of the Connection", "example": "0f7b5514-e7a5-4947-ae44-7519a23c7403" }, "name": { "type": "string", "description": "The name of the Connection", "example": "azure" }, "isDeprecated": { "type": "boolean", "description": "Marked 'true' if the connection type is deprecated" }, "connectionSchema": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package-name of the extension." }, "type": { "type": "string", "description": "The type of connection." } } }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IConnectionSchemaData_2_0": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package name of the extension", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection within the extension", "example": "oauth-2" }, "label": { "type": "string", "description": "The label for the connection type", "example": "OAuth-2" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "The name of the field", "example": "client_secret" } } } } } }, "IConnectionSchema_2_0": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package name of the extension", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection within the extension", "example": "oauth-2" }, "label": { "type": "string", "description": "The label for the connection type", "example": "OAuth-2" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "The name of the field", "example": "client_secret" } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IConnectionSchemaIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "extension": { "type": "string", "description": "The package name of the extension this schema was found", "example": "azure" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IEndpointData_2_0": { "type": "object", "properties": { "foreignId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "entrypoint": { "type": "string", "description": "The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.", "example": "667ed4ae16d66f47dc2a9400" }, "active": { "type": "boolean", "description": "Toggle whether the endpoint is active or not" }, "nluConnectorId": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, { "type": "string" } ] }, "useConversations": { "type": "boolean", "description": "Whether to collect conversations history for this endpoint" }, "maskIPAddress": { "type": "boolean", "description": "Whether to mask sensitive IP address in input object and analytics data for this endpoint" }, "maskAnalytics": { "type": "boolean", "description": "Whether to mask sensitive data in analytics for this endpoint" }, "maskLogging": { "type": "boolean", "description": "Whether to mask sensitive data in logs for this endpoint" }, "useContactProfiles": { "type": "boolean", "description": "Whether to use contact profiles for this endpoint" }, "useAnalytics": { "type": "boolean", "description": "Whether we should store analytics for this endpoint" }, "useDashbotAnalytics": { "type": "boolean", "description": "Whether we should use Dashbot to collect analytics" }, "dashbotApikey": { "type": "string", "description": "The apikey for the dashbot bot" }, "dashbotPlatform": { "type": "string" }, "disableInputSanitization": { "type": "string", "description": "If true, disables input text sanitization after Input Transformer" }, "disableSkipUriTags": { "type": "string", "description": "If true, disables skipping of uri tags" }, "overrideSnapshotConnections": { "type": "boolean" }, "settings": { "type": "object", "properties": { "accessScope": { "type": "string" }, "accessToken": { "type": "string" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "basicAuthPassword": { "type": "string" }, "basicAuthUser": { "type": "string" }, "botUserId": { "type": "string" }, "businessHours": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" }, "weekDay": { "type": "string" } } } }, "enabled": { "type": "boolean" }, "text": { "type": "string" }, "mode": { "type": "string" }, "timeZone": { "type": "string" }, "title": { "type": "string" } } }, "colorScheme": { "type": "string" }, "connectionName": { "type": "string" }, "customJSON": { "type": "string" }, "designTemplate": { "type": "integer" }, "disableHtmlContentSanitization": { "type": "boolean" }, "disableInputAutocomplete": { "type": "boolean" }, "disableInputAutogrow": { "type": "boolean" }, "disableUrlButtonSanitization": { "type": "boolean" }, "enableGenericHTMLStyling": { "type": "boolean" }, "enableAsyncCommunication": { "type": "boolean" }, "engagementMessageText": { "type": "string" }, "displayGetStartedButton": { "type": "boolean" }, "dynamicImageAspectRatio": { "type": "boolean" }, "enableCollectMetadata": { "type": "boolean" }, "enableConnectionStatusIndicator": { "type": "boolean" }, "enableDemoWebchat": { "type": "boolean" }, "enableFileUpload": { "type": "boolean" }, "enablePersistentMenu": { "type": "boolean" }, "enableRating": { "type": "string", "enum": [ "onRequest", "always", "once" ] }, "enableSTT": { "type": "boolean" }, "enableTTS": { "type": "boolean" }, "enableUnreadMessageBadge": { "type": "boolean" }, "enableUnreadMessagePreview": { "type": "boolean" }, "enableUnreadMessageSound": { "type": "boolean" }, "enableUnreadMessageTitleIndicator": { "type": "boolean" }, "enableTypingIndicator": { "type": "boolean" }, "facebookPageToken": { "type": "string" }, "focusInputAfterPostback": { "type": "boolean" }, "getStartedButtonText": { "type": "string" }, "getStartedPayload": { "type": "string" }, "getStartedText": { "type": "string" }, "getStartedData": { "type": "string" }, "headerLogoUrl": { "type": "string" }, "hubSecret": { "type": "string" }, "inputAutogrowMaxRows": { "type": "number" }, "inputPlaceholder": { "type": "string" }, "language": { "type": "string" }, "lineChannelAccessToken": { "type": "string" }, "lineChannelSecret": { "type": "string" }, "maintenance": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string" }, "text": { "type": "string" }, "title": { "type": "string" } } }, "mergeContactProfiles": { "type": "boolean" }, "messageDelay": { "type": "integer" }, "messageLogoUrl": { "type": "string" }, "overwriteWebchatBundleUrl": { "type": "string" }, "ratingTitleText": { "type": "string" }, "ratingCommentText": { "type": "string" }, "ratingMessageHistoryRatingText": { "type": "string" }, "ratingMessageHistoryCommentText": { "type": "string" }, "reparseAlexaSlots": { "type": "boolean" }, "requestFacebookProfileData": { "type": "boolean" }, "sessionExpiration": { "type": "integer" }, "shouldOverwriteWebchatBundleUrl": { "type": "boolean" }, "showEngagementMessagesInChat": { "type": "boolean" }, "slackOAuthAccessToken": { "type": "string" }, "slackVerifyToken": { "type": "string" }, "sunshineConversationsChannelKeyId": { "type": "string" }, "sunshineConversationsChannelSecret": { "type": "string" }, "sunshineConversationsChannelUri": { "type": "string", "format": "uri" }, "tenantId": { "type": "string" }, "updateContactProfileWithFacebookProfile": { "type": "boolean" }, "voice": { "type": "string" }, "webhookUrl": { "type": "string", "format": "uri" }, "skill": { "type": "object" }, "persistentMenu": { "type": "object" } } }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "boolean", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.\n" }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings.\n" }, "transpiledTransformer": { "type": "string", "description": "The transformer object written by the user, but without typings. This will be executed.\n" }, "inputTransformerEnabled": { "type": "boolean" }, "outputTransformerEnabled": { "type": "boolean" }, "finalPingTransformerEnabled": { "type": "boolean" }, "notifyTransformerEnabled": { "type": "boolean" }, "injectTransformerEnabled": { "type": "boolean" } } }, "handoverSettings": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cognigy", "none", "rce" ] }, "providerSettings": { "type": "object", "properties": { "forwardOnlyHandoverConversations": { "type": "boolean", "description": "(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.\n" }, "getQueueUpdates": { "type": "boolean", "description": "(rce) Indicates if queue updates should be enabled to receive events about the estimated wait time\n" }, "apiVersion": { "type": "string", "description": "(salesforce) Salesforce LiveAgent API Version" }, "baseUrl": { "type": "string", "description": "Base URL of the LiveAgent API Deployment" }, "apiAccessToken": { "type": "string", "description": "(rce) The API access token you can create within RCE" }, "baseApiUrl": { "type": "string", "description": "(rce) The API URL to your RCE installation" }, "realtimeAccessToken": { "type": "string", "description": "(rce) The access token for your rce source sdk source" }, "realtimeEndpointUrl": { "type": "string", "description": "(rce) The endpoint URL of your rce source sdk source" }, "webhookSecret": { "type": "string", "description": "(rce) The secret used to secure webhooks in RCE" }, "botCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "agentCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "organizationId": { "type": "string", "description": "(salesforce) Salesforce Organization ID" }, "deploymentId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Deployment ID" }, "buttonId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Chat Button ID" } } }, "agentAssistSettings": { "type": "object", "properties": { "copilotType": { "type": "string", "enum": [ "none", "workspace", "whisper" ], "description": "Copilot Type" }, "agentAssistFlowId": { "type": "string", "description": "Copilot flow ID" }, "agentAssistConfigId": { "type": "string", "description": "Selected Copilot Config ReferenceId" }, "enableTranscriptTile": { "type": "boolean", "description": "Enable the transcript tile" }, "enableTranscriptTileChatInput": { "type": "boolean", "description": "Enable the chat input for transcript tile" }, "redactTranscriptTileMessages": { "type": "boolean", "description": "Enable redaction of messages in transcript tile" }, "enableAgentCopilotAuthentication": { "type": "boolean", "description": "Enable authentication for agent copilot" }, "blockNonJWTRequests": { "type": "boolean", "description": "Block requests made to the endpoint without a JWT token" }, "agentCopilotAuthentication": { "type": "string", "description": "Authentication connection reference Id for agent copilot" }, "oAuth2Connection": { "type": "string", "description": "OAuth2 Connection for Genesys Cloud" } } } } }, "orgDataPrivacySettings": { "description": "Organisation data privacy settings overwrite the ones defined on endpoint-level", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether or not organisation data privacy settings are enabled" }, "useAnalytics": { "type": "boolean" }, "storeDataPayload": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskIPAddress": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" } } } } }, "IEndpoint_2_0": { "type": "object", "properties": { "foreignId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "entrypoint": { "type": "string", "description": "The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.", "example": "667ed4ae16d66f47dc2a9400" }, "active": { "type": "boolean", "description": "Toggle whether the endpoint is active or not" }, "nluConnectorId": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, { "type": "string" } ] }, "useConversations": { "type": "boolean", "description": "Whether to collect conversations history for this endpoint" }, "maskIPAddress": { "type": "boolean", "description": "Whether to mask sensitive IP address in input object and analytics data for this endpoint" }, "maskAnalytics": { "type": "boolean", "description": "Whether to mask sensitive data in analytics for this endpoint" }, "maskLogging": { "type": "boolean", "description": "Whether to mask sensitive data in logs for this endpoint" }, "useContactProfiles": { "type": "boolean", "description": "Whether to use contact profiles for this endpoint" }, "useAnalytics": { "type": "boolean", "description": "Whether we should store analytics for this endpoint" }, "useDashbotAnalytics": { "type": "boolean", "description": "Whether we should use Dashbot to collect analytics" }, "dashbotApikey": { "type": "string", "description": "The apikey for the dashbot bot" }, "dashbotPlatform": { "type": "string" }, "disableInputSanitization": { "type": "string", "description": "If true, disables input text sanitization after Input Transformer" }, "disableSkipUriTags": { "type": "string", "description": "If true, disables skipping of uri tags" }, "overrideSnapshotConnections": { "type": "boolean" }, "settings": { "type": "object", "properties": { "accessScope": { "type": "string" }, "accessToken": { "type": "string" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "basicAuthPassword": { "type": "string" }, "basicAuthUser": { "type": "string" }, "botUserId": { "type": "string" }, "businessHours": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" }, "weekDay": { "type": "string" } } } }, "enabled": { "type": "boolean" }, "text": { "type": "string" }, "mode": { "type": "string" }, "timeZone": { "type": "string" }, "title": { "type": "string" } } }, "colorScheme": { "type": "string" }, "connectionName": { "type": "string" }, "customJSON": { "type": "string" }, "designTemplate": { "type": "integer" }, "disableHtmlContentSanitization": { "type": "boolean" }, "disableInputAutocomplete": { "type": "boolean" }, "disableInputAutogrow": { "type": "boolean" }, "disableUrlButtonSanitization": { "type": "boolean" }, "enableGenericHTMLStyling": { "type": "boolean" }, "enableAsyncCommunication": { "type": "boolean" }, "engagementMessageText": { "type": "string" }, "displayGetStartedButton": { "type": "boolean" }, "dynamicImageAspectRatio": { "type": "boolean" }, "enableCollectMetadata": { "type": "boolean" }, "enableConnectionStatusIndicator": { "type": "boolean" }, "enableDemoWebchat": { "type": "boolean" }, "enableFileUpload": { "type": "boolean" }, "enablePersistentMenu": { "type": "boolean" }, "enableRating": { "type": "string", "enum": [ "onRequest", "always", "once" ] }, "enableSTT": { "type": "boolean" }, "enableTTS": { "type": "boolean" }, "enableUnreadMessageBadge": { "type": "boolean" }, "enableUnreadMessagePreview": { "type": "boolean" }, "enableUnreadMessageSound": { "type": "boolean" }, "enableUnreadMessageTitleIndicator": { "type": "boolean" }, "enableTypingIndicator": { "type": "boolean" }, "facebookPageToken": { "type": "string" }, "focusInputAfterPostback": { "type": "boolean" }, "getStartedButtonText": { "type": "string" }, "getStartedPayload": { "type": "string" }, "getStartedText": { "type": "string" }, "getStartedData": { "type": "string" }, "headerLogoUrl": { "type": "string" }, "hubSecret": { "type": "string" }, "inputAutogrowMaxRows": { "type": "number" }, "inputPlaceholder": { "type": "string" }, "language": { "type": "string" }, "lineChannelAccessToken": { "type": "string" }, "lineChannelSecret": { "type": "string" }, "maintenance": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string" }, "text": { "type": "string" }, "title": { "type": "string" } } }, "mergeContactProfiles": { "type": "boolean" }, "messageDelay": { "type": "integer" }, "messageLogoUrl": { "type": "string" }, "overwriteWebchatBundleUrl": { "type": "string" }, "ratingTitleText": { "type": "string" }, "ratingCommentText": { "type": "string" }, "ratingMessageHistoryRatingText": { "type": "string" }, "ratingMessageHistoryCommentText": { "type": "string" }, "reparseAlexaSlots": { "type": "boolean" }, "requestFacebookProfileData": { "type": "boolean" }, "sessionExpiration": { "type": "integer" }, "shouldOverwriteWebchatBundleUrl": { "type": "boolean" }, "showEngagementMessagesInChat": { "type": "boolean" }, "slackOAuthAccessToken": { "type": "string" }, "slackVerifyToken": { "type": "string" }, "sunshineConversationsChannelKeyId": { "type": "string" }, "sunshineConversationsChannelSecret": { "type": "string" }, "sunshineConversationsChannelUri": { "type": "string", "format": "uri" }, "tenantId": { "type": "string" }, "updateContactProfileWithFacebookProfile": { "type": "boolean" }, "voice": { "type": "string" }, "webhookUrl": { "type": "string", "format": "uri" }, "skill": { "type": "object" }, "persistentMenu": { "type": "object" } } }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "boolean", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.\n" }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings.\n" }, "transpiledTransformer": { "type": "string", "description": "The transformer object written by the user, but without typings. This will be executed.\n" }, "inputTransformerEnabled": { "type": "boolean" }, "outputTransformerEnabled": { "type": "boolean" }, "finalPingTransformerEnabled": { "type": "boolean" }, "notifyTransformerEnabled": { "type": "boolean" }, "injectTransformerEnabled": { "type": "boolean" } } }, "handoverSettings": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cognigy", "none", "rce" ] }, "providerSettings": { "type": "object", "properties": { "forwardOnlyHandoverConversations": { "type": "boolean", "description": "(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.\n" }, "getQueueUpdates": { "type": "boolean", "description": "(rce) Indicates if queue updates should be enabled to receive events about the estimated wait time\n" }, "apiVersion": { "type": "string", "description": "(salesforce) Salesforce LiveAgent API Version" }, "baseUrl": { "type": "string", "description": "Base URL of the LiveAgent API Deployment" }, "apiAccessToken": { "type": "string", "description": "(rce) The API access token you can create within RCE" }, "baseApiUrl": { "type": "string", "description": "(rce) The API URL to your RCE installation" }, "realtimeAccessToken": { "type": "string", "description": "(rce) The access token for your rce source sdk source" }, "realtimeEndpointUrl": { "type": "string", "description": "(rce) The endpoint URL of your rce source sdk source" }, "webhookSecret": { "type": "string", "description": "(rce) The secret used to secure webhooks in RCE" }, "botCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "agentCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "organizationId": { "type": "string", "description": "(salesforce) Salesforce Organization ID" }, "deploymentId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Deployment ID" }, "buttonId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Chat Button ID" } } }, "agentAssistSettings": { "type": "object", "properties": { "copilotType": { "type": "string", "enum": [ "none", "workspace", "whisper" ], "description": "Copilot Type" }, "agentAssistFlowId": { "type": "string", "description": "Copilot flow ID" }, "agentAssistConfigId": { "type": "string", "description": "Selected Copilot Config ReferenceId" }, "enableTranscriptTile": { "type": "boolean", "description": "Enable the transcript tile" }, "enableTranscriptTileChatInput": { "type": "boolean", "description": "Enable the chat input for transcript tile" }, "redactTranscriptTileMessages": { "type": "boolean", "description": "Enable redaction of messages in transcript tile" }, "enableAgentCopilotAuthentication": { "type": "boolean", "description": "Enable authentication for agent copilot" }, "blockNonJWTRequests": { "type": "boolean", "description": "Block requests made to the endpoint without a JWT token" }, "agentCopilotAuthentication": { "type": "string", "description": "Authentication connection reference Id for agent copilot" }, "oAuth2Connection": { "type": "string", "description": "OAuth2 Connection for Genesys Cloud" } } } } }, "orgDataPrivacySettings": { "description": "Organisation data privacy settings overwrite the ones defined on endpoint-level", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether or not organisation data privacy settings are enabled" }, "useAnalytics": { "type": "boolean" }, "storeDataPayload": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskIPAddress": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IEndpointTranslationSettings_2_0": { "type": "object", "properties": { "translationEnabled": { "type": "boolean", "description": "Whether or not Translation is enabled for the Endpoint" }, "flowLanguage": { "type": "string", "description": "The language of the Flow outputs" }, "inputLanguage": { "type": "string", "description": "The language of the user inputs ('auto' for auto-detection)" }, "noTranslateMarker": { "type": "string", "description": "Don't translate inputs and outputs which are prefixed with this prefix" }, "glossaryId": { "type": "string", "description": "The glossary to use for the bot output translation" }, "glossaryIdInput": { "type": "string", "description": "The glossary to use for the user input translation" }, "formality": { "type": "string", "description": "Sets whether the translated text should lean towards formal or informal language" }, "padPayloads": { "type": "boolean", "description": "If true, prevents all user inputs based on payloads to be translated" }, "alwaysRemoveNoTranslateMarker": { "type": "boolean", "description": "Wether we remove No Translation Markers, even if translation is not enabled" }, "setInputLanguageOnExecutionCount": { "type": "boolean", "description": "If the input language is set to 'auto', it will be fixed to its current value on this execution count" } } }, "IEndpoitOrgDataPrivacySettings_2_0": { "description": "Organisation data privacy settings overwrite the ones defined on endpoint-level", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether or not organisation data privacy settings are enabled" }, "useAnalytics": { "type": "boolean" }, "storeDataPayload": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskIPAddress": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" } } }, "IEndpointIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "overrideSnapshotConnections": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IExtensionData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Extension", "example": "New Extension" }, "label": { "type": "string", "description": "The label of the Extension", "example": "New Extension" }, "version": { "type": "string", "description": "The version of the Extension", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", "example": "1.0.0" }, "imageUrlToken": { "type": "string", "format": "alphanum-64", "description": "A fully qualified URL to an image/icon for the extension." }, "description": { "type": "string", "description": "Optional description of the extension" }, "tags": { "type": "array", "description": "Optional list of tags to find the extension", "items": { "type": "string" } }, "author": { "type": "string", "description": "Author of the extension" }, "extensionType": { "type": "string", "description": "Type of this extension", "enum": [ "nodes" ] }, "trustedCode": { "type": "boolean", "description": "Whether the code of the extension is trusted and runs without isolation" }, "nodes": { "type": "object", "properties": { "type": { "type": "string" }, "parentType": { "type": "string", "description": "The type of the node parent, if there is one" }, "defaultLabel": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Node of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Node of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Node is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "extension": { "type": "string" }, "extensionImg": { "type": "string" }, "appearance": { "type": "object", "properties": { "logo": { "type": "string" }, "textColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "contrastTextColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "color": { "type": "string", "example": "red", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "variant": { "type": "string", "enum": [ "regular", "mini", "hexagon" ] } } }, "behavior": { "type": "object", "properties": { "stopping": { "type": "boolean" }, "entrypoint": { "type": "boolean" } } }, "constraints": { "type": "object", "properties": { "editable": { "type": "boolean", "description": "Should this node be editable" }, "deletable": { "type": "boolean", "description": "Should this node be deletable" }, "creatable": { "type": "boolean", "description": "Should this node be manually creatable" }, "collapsable": { "type": "boolean", "description": "Should this node be collapsable" }, "childFlowCreatable": { "type": "boolean", "description": "Should it be possible to create child flow from this node" }, "movable": { "type": "boolean", "description": "Should this node be movable" }, "placement": { "type": "object", "description": "Additional placement information", "properties": { "predecessor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "successor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "children": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } } } } } }, "dependencies": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "string" } } } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "previews": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message", "image", "code" ] }, "key": { "type": "string" } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 30, "example": "word count" }, "script": { "type": "string", "maxLength": 500, "example": "ci.text.split(' ').length" }, "type": { "type": "string", "enum": [ "profile", "input", "context", "custom", "answer", "flow-output", "flow-input" ], "example": "input" } } } }, "tags": { "type": "string", "enum": [ "basic", "logic", "message", "profile", "service", "nlu", "data" ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "connections": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package name of the extension", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection within the extension", "example": "oauth-2" }, "label": { "type": "string", "description": "The label for the connection type", "example": "OAuth-2" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "The name of the field", "example": "client_secret" } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "knowledge": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Knowledge of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Knowledge of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Knowledge is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule", "json", "checkbox", "time", "date", "datetime", "select", "xml", "textArray", "chipInput", "toggle", "slider", "number", "daterange", "connection", "condition", "description" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } } } }, "IExtension_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Extension", "example": "New Extension" }, "label": { "type": "string", "description": "The label of the Extension", "example": "New Extension" }, "version": { "type": "string", "description": "The version of the Extension", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", "example": "1.0.0" }, "imageUrlToken": { "type": "string", "format": "alphanum-64", "description": "A fully qualified URL to an image/icon for the extension." }, "description": { "type": "string", "description": "Optional description of the extension" }, "tags": { "type": "array", "description": "Optional list of tags to find the extension", "items": { "type": "string" } }, "author": { "type": "string", "description": "Author of the extension" }, "extensionType": { "type": "string", "description": "Type of this extension", "enum": [ "nodes" ] }, "trustedCode": { "type": "boolean", "description": "Whether the code of the extension is trusted and runs without isolation" }, "nodes": { "type": "object", "properties": { "type": { "type": "string" }, "parentType": { "type": "string", "description": "The type of the node parent, if there is one" }, "defaultLabel": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Node of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Node of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Node is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "extension": { "type": "string" }, "extensionImg": { "type": "string" }, "appearance": { "type": "object", "properties": { "logo": { "type": "string" }, "textColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "contrastTextColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "color": { "type": "string", "example": "red", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "variant": { "type": "string", "enum": [ "regular", "mini", "hexagon" ] } } }, "behavior": { "type": "object", "properties": { "stopping": { "type": "boolean" }, "entrypoint": { "type": "boolean" } } }, "constraints": { "type": "object", "properties": { "editable": { "type": "boolean", "description": "Should this node be editable" }, "deletable": { "type": "boolean", "description": "Should this node be deletable" }, "creatable": { "type": "boolean", "description": "Should this node be manually creatable" }, "collapsable": { "type": "boolean", "description": "Should this node be collapsable" }, "childFlowCreatable": { "type": "boolean", "description": "Should it be possible to create child flow from this node" }, "movable": { "type": "boolean", "description": "Should this node be movable" }, "placement": { "type": "object", "description": "Additional placement information", "properties": { "predecessor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "successor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "children": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } } } } } }, "dependencies": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "string" } } } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "previews": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message", "image", "code" ] }, "key": { "type": "string" } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 30, "example": "word count" }, "script": { "type": "string", "maxLength": 500, "example": "ci.text.split(' ').length" }, "type": { "type": "string", "enum": [ "profile", "input", "context", "custom", "answer", "flow-output", "flow-input" ], "example": "input" } } } }, "tags": { "type": "string", "enum": [ "basic", "logic", "message", "profile", "service", "nlu", "data" ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "connections": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package name of the extension", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection within the extension", "example": "oauth-2" }, "label": { "type": "string", "description": "The label for the connection type", "example": "OAuth-2" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "The name of the field", "example": "client_secret" } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "knowledge": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Knowledge of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Knowledge of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Knowledge is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule", "json", "checkbox", "time", "date", "datetime", "select", "xml", "textArray", "chipInput", "toggle", "slider", "number", "daterange", "connection", "condition", "description" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IExtensionIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Extension", "example": "new-extension" }, "label": { "type": "string", "description": "Optional human readable extension name", "example": "New Extension" }, "version": { "type": "string", "description": "The version of the Extension", "example": "1.0.0" }, "imageUrlToken": { "type": "string", "format": "alphanum-64", "description": "A fully qualified URL to an image/icon for the extension." }, "description": { "type": "string", "description": "Optional description of the extension", "example": "This is a fancy extension" }, "trustedCode": { "type": "boolean", "description": "NodeDescriptors trusted flag." }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IFileData_2_0": { "type": "object", "properties": { "name": { "type": "string" } } }, "IFile_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IGenericIntentFeedbackFinding_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorFScore", "fairFScore", "goodFScore", "fewSentences", "unclearIntent", "noSiblings" ] } } }, "ILowDataIntentFeedbackFinding_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "IOverlapIntentFeedbackFinding_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "someOverlap", "strongOverlap" ] }, "overlappingIntentReferenceId": { "type": "string" }, "overlappingIntentName": { "type": "string" }, "overlappingIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "overlappingFlowName": { "type": "string" }, "overlappingFlowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IIntentFeedbackReport_2_0": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorFScore", "fairFScore", "goodFScore", "fewSentences", "unclearIntent", "noSiblings" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "someOverlap", "strongOverlap" ] }, "overlappingIntentReferenceId": { "type": "string" }, "overlappingIntentName": { "type": "string" }, "overlappingIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "overlappingFlowName": { "type": "string" }, "overlappingFlowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "ISentenceFeedbackReport_2_0": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "TSentenceFeedbackFindingType_2_0": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] }, "TTrainGroupFeedbackFindingType_2_0": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] }, "ITrainGroupGenericFinding_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, "ITrainGroupLowDataFinding_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "ITrainGroupFeedbackReport_2_0": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "IFlowData_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" } } }, "IFlowGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "intentTrainGroupReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "isTrainingOutOfDate": { "type": "boolean" } } }, "IFlow_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "intentTrainGroupReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "isTrainingOutOfDate": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IUpdateFlowData_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" }, "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IFlowIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "referenceId": { "type": "string", "format": "uuid" }, "isTrainingOutOfDate": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IIntentData_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "OrderFood" }, "description": { "type": "string", "example": "Intent to order food" }, "condition": { "type": "string" }, "rules": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmationSentences": { "type": "array", "items": { "type": "string" } }, "disambiguationSentence": { "type": "string" }, "data": { "type": "object" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "childFeatures": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "example": false }, "biasTowardsParentOrChildIntents": { "type": "string", "enum": [ "parents", "children" ] }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "analyticsLabel": { "type": "string" }, "overrideIntentDefaultRepliesAsExamples": { "type": "string", "description": "Toggle overriding the flow setting for using default replies as training examples", "enum": [ "on", "off", "useFlowSettings" ] } } }, "IIntentGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorFScore", "fairFScore", "goodFScore", "fewSentences", "unclearIntent", "noSiblings" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "someOverlap", "strongOverlap" ] }, "overlappingIntentReferenceId": { "type": "string" }, "overlappingIntentName": { "type": "string" }, "overlappingIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "overlappingFlowName": { "type": "string" }, "overlappingFlowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } } } }, "IIntent_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "OrderFood" }, "description": { "type": "string", "example": "Intent to order food" }, "condition": { "type": "string" }, "rules": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmationSentences": { "type": "array", "items": { "type": "string" } }, "disambiguationSentence": { "type": "string" }, "data": { "type": "object" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "childFeatures": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "example": false }, "biasTowardsParentOrChildIntents": { "type": "string", "enum": [ "parents", "children" ] }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "analyticsLabel": { "type": "string" }, "overrideIntentDefaultRepliesAsExamples": { "type": "string", "description": "Toggle overriding the flow setting for using default replies as training examples", "enum": [ "on", "off", "useFlowSettings" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IIntentIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "referenceId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "OrderFood" }, "description": { "type": "string", "example": "Intent to order food" }, "tags": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorFScore", "fairFScore", "goodFScore", "fewSentences", "unclearIntent", "noSiblings" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "someOverlap", "strongOverlap" ] }, "overlappingIntentReferenceId": { "type": "string" }, "overlappingIntentName": { "type": "string" }, "overlappingIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "overlappingFlowName": { "type": "string" }, "overlappingFlowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } } } }, "ILearningSentenceData_2_0": { "type": "object", "properties": { "confirmationCount": { "type": "integer", "example": 42 }, "rejectedCount": { "type": "integer", "example": 42 }, "sentence": { "type": "string", "example": "How do you turn this on?" } } }, "ILearningSentence_2_0": { "type": "object", "properties": { "confirmationCount": { "type": "integer", "example": 42 }, "rejectedCount": { "type": "integer", "example": 42 }, "sentence": { "type": "string", "example": "How do you turn this on?" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ILearningSentenceIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "count": { "type": "integer", "example": 42 }, "sentence": { "type": "string", "example": "How do you turn this on?" } } }, "ISentenceData_2_0": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } } } }, "ISentenceGeneratedData_2_0": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } } } }, "ISentence_2_0": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ILexiconSentenceSlot_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, "IAnySlot_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, "ISystemSlot_2_0": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, "ISentenceIndexItemData_2_0": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slots": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "tagReference": { "type": "string" }, "lexiconReference": { "type": "string" } } } }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } } } }, "ISentenceIndexItem_2_0": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slots": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "tagReference": { "type": "string" }, "lexiconReference": { "type": "string" } } } }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IYesNoSentenceData_2_0": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." } } }, "IYesNoSentenceGeneratedData_2_0": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } } } }, "IYesNoSentence_2_0": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "text": { "type": "string", "example": "I want to buy a pizza." }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IFlowSettingsData_2_0": { "type": "object", "properties": { "continueExecutionAfterAttachedFlow": { "type": "boolean" }, "continueExecutionAterDefaultReply": { "type": "boolean" }, "continueExecutionAfterNegativeConfirmation": { "type": "boolean" }, "passDefaultRepliesIntoFlow": { "type": "boolean" }, "flowIntentMappingOrder": { "type": "string", "enum": [ "joint", "main", "attached" ] }, "useAttachedFlowThresholds": { "type": "boolean" }, "useAttachedFlowContinueAfterDefaultReply": { "type": "boolean" }, "useAttachedFlowPassDefaultRepliesIntoFlow": { "type": "boolean" }, "implicitSlotParsing": { "type": "string", "enum": [ "disabled", "full", "system", "lexicon" ] }, "useAttachedFlowImplicitSlotParsing": { "type": "boolean" }, "lexiconSlotsWithSubMatches": { "type": "boolean" }, "useIntentDefaultRepliesAsExamples": { "description": "Enable/Disable using default replies as training examples.", "type": "boolean" }, "localeSettings": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inheritFallbackLocaleModel": { "type": "boolean" } } } } }, "IFlowSettingsResponse_2_0": { "type": "object", "properties": { "continueExecutionAfterAttachedFlow": { "type": "boolean" }, "continueExecutionAterDefaultReply": { "type": "boolean" }, "continueExecutionAfterNegativeConfirmation": { "type": "boolean" }, "passDefaultRepliesIntoFlow": { "type": "boolean" }, "flowIntentMappingOrder": { "type": "string", "enum": [ "joint", "main", "attached" ] }, "useAttachedFlowThresholds": { "type": "boolean" }, "useAttachedFlowContinueAfterDefaultReply": { "type": "boolean" }, "useAttachedFlowPassDefaultRepliesIntoFlow": { "type": "boolean" }, "implicitSlotParsing": { "type": "string", "enum": [ "disabled", "full", "system", "lexicon" ] }, "useAttachedFlowImplicitSlotParsing": { "type": "boolean" }, "lexiconSlotsWithSubMatches": { "type": "boolean" }, "useIntentDefaultRepliesAsExamples": { "description": "Enable/Disable using default replies as training examples.", "type": "boolean" }, "localeSettings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inheritFallbackLocaleModel": { "type": "boolean" } } } } } } } }, "IFlowSettings_2_0": { "type": "object", "properties": { "continueExecutionAfterAttachedFlow": { "type": "boolean" }, "continueExecutionAterDefaultReply": { "type": "boolean" }, "continueExecutionAfterNegativeConfirmation": { "type": "boolean" }, "passDefaultRepliesIntoFlow": { "type": "boolean" }, "flowIntentMappingOrder": { "type": "string", "enum": [ "joint", "main", "attached" ] }, "useAttachedFlowThresholds": { "type": "boolean" }, "useAttachedFlowContinueAfterDefaultReply": { "type": "boolean" }, "useAttachedFlowPassDefaultRepliesIntoFlow": { "type": "boolean" }, "implicitSlotParsing": { "type": "string", "enum": [ "disabled", "full", "system", "lexicon" ] }, "useAttachedFlowImplicitSlotParsing": { "type": "boolean" }, "lexiconSlotsWithSubMatches": { "type": "boolean" }, "useIntentDefaultRepliesAsExamples": { "description": "Enable/Disable using default replies as training examples.", "type": "boolean" }, "localeSettings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inheritFallbackLocaleModel": { "type": "boolean" } } } } } }, "intentThreshold": { "type": "object", "properties": { "lower": { "type": "number", "example": 0.4 }, "upper": { "type": "number", "example": 0.5 } } }, "learnNewExampleSentences": { "type": "boolean" }, "learnNewExampleSentencesThreshold": { "type": "integer" }, "negativeConfirmationWords": { "type": "array", "items": { "type": "string" } }, "positiveConfirmationWords": { "type": "array", "items": { "type": "string" } }, "systemSlots": { "type": "object", "properties": { "useAgeSlots": { "type": "boolean" }, "useDateSlots": { "type": "boolean" }, "useDistanceSlots": { "type": "boolean" }, "useDurationSlots": { "type": "boolean" }, "useEmailSlots": { "type": "boolean" }, "useMoneySlots": { "type": "boolean" }, "useNumberSlots": { "type": "boolean" }, "usePercentageSlots": { "type": "boolean" }, "useTemperatureSlots": { "type": "boolean" }, "useURLSlots": { "type": "boolean" } } }, "yesNoLogic": { "type": "string", "enum": [ "yesNoIntents", "yesNoIntentsWithRules", "confirmationWords" ] }, "yesNoIntentThreshold": { "type": "integer" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ILocaleSettings_2_0": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inheritFallbackLocaleModel": { "type": "boolean" } } }, "ISlotFillerData_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "usePositiveOnly": { "type": "boolean" }, "removeNegated": { "type": "boolean" }, "storeResultInContext": { "type": "boolean" }, "contextKey": { "type": "string" }, "storeInContactProfile": { "type": "boolean" }, "profileKey": { "type": "string" }, "storeDetailedResults": { "type": "boolean" }, "skipIfResultInContext": { "type": "boolean" }, "additionalValidation": { "type": "string" }, "resultLocation": { "type": "string" }, "regex": { "type": "string" }, "slot": { "type": "string" } } }, "ISlotFillerGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" } } }, "ISlotFiller_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "usePositiveOnly": { "type": "boolean" }, "removeNegated": { "type": "boolean" }, "storeResultInContext": { "type": "boolean" }, "contextKey": { "type": "string" }, "storeInContactProfile": { "type": "boolean" }, "profileKey": { "type": "string" }, "storeDetailedResults": { "type": "boolean" }, "skipIfResultInContext": { "type": "boolean" }, "additionalValidation": { "type": "string" }, "resultLocation": { "type": "string" }, "regex": { "type": "string" }, "slot": { "type": "string" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ISlotFillerIndexItemData_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "example": "pizza" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "referenceId": { "type": "string" } } }, "ISlotFillerIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "example": "pizza" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "referenceId": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IFlowStateData_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "IFlowStateGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" } } }, "IFlowState_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IFlowStateIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "referenceId": { "type": "string", "format": "uuid" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IFunctionData_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "isDisabled": { "type": "boolean" } } }, "IFunction_2_0": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "isDisabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IFunctionIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the function", "example": "New Function" }, "code": { "type": "string", "description": "The code of the function", "example": "console.log('Hello World');" }, "referenceId": { "type": "string", "format": "uuid" }, "isDisabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IFunctionInstanceData_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "functionReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "trigger": { "type": "string", "enum": [ "flow", "manual" ], "description": "How was this function instance triggered, e.g. was it spawned while executing a Flow?", "example": "flow" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "error" ], "description": "The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.", "example": "active" }, "error": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "finishedAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IFunctionInstance_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "functionReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "trigger": { "type": "string", "enum": [ "flow", "manual" ], "description": "How was this function instance triggered, e.g. was it spawned while executing a Flow?", "example": "flow" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "error" ], "description": "The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.", "example": "active" }, "error": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "finishedAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IFunctionInstanceIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "trigger": { "type": "string", "enum": [ "flow", "manual" ], "description": "How was this function instance triggered, e.g. was it spawned while executing a Flow?", "example": "flow" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "error" ], "description": "The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.", "example": "active" }, "error": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "finishedAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "TFunctionInstanceStatus_2_0": { "type": "string", "enum": [ "queued", "active", "done", "error" ], "description": "The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.", "example": "active" }, "TFunctionInstanceTrigger_2_0": { "type": "string", "enum": [ "flow", "manual" ], "description": "How was this function instance triggered, e.g. was it spawned while executing a Flow?", "example": "flow" }, "IGoalData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Goal", "example": "New Goal" }, "description": { "type": "string", "description": "The description of the goal", "example": "This is a sample goal" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the goal step", "example": "Step 1" }, "description": { "type": "string", "description": "The description of the goal step", "example": "This is the first step" }, "order": { "type": "number", "description": "Step order in the goal configuration", "example": 1 }, "type": { "type": "string", "description": "Step type", "example": "start" }, "metrics": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the metric", "example": "Duration" }, "description": { "type": "string", "description": "The description of the metric", "example": "Time taken to complete the step" }, "type": { "type": "string", "description": "Metric type. Available values \"currency\", \"duration\", \"revenue\"", "example": "duration" }, "value": { "type": "number", "description": "Metric value", "example": 30 } } } } } } } } }, "IGoal_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Goal", "example": "New Goal" }, "description": { "type": "string", "description": "The description of the goal", "example": "This is a sample goal" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the goal step", "example": "Step 1" }, "description": { "type": "string", "description": "The description of the goal step", "example": "This is the first step" }, "order": { "type": "number", "description": "Step order in the goal configuration", "example": 1 }, "type": { "type": "string", "description": "Step type", "example": "start" }, "metrics": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the metric", "example": "Duration" }, "description": { "type": "string", "description": "The description of the metric", "example": "Time taken to complete the step" }, "type": { "type": "string", "description": "Metric type. Available values \"currency\", \"duration\", \"revenue\"", "example": "duration" }, "value": { "type": "number", "description": "Metric value", "example": 30 } } } } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IGoalIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the goal", "example": "New Goal" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IGoalStep_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the goal step", "example": "Step 1" }, "description": { "type": "string", "description": "The description of the goal step", "example": "This is the first step" }, "order": { "type": "number", "description": "Step order in the goal configuration", "example": 1 }, "type": { "type": "string", "description": "Step type", "example": "start" }, "metrics": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the metric", "example": "Duration" }, "description": { "type": "string", "description": "The description of the metric", "example": "Time taken to complete the step" }, "type": { "type": "string", "description": "Metric type. Available values \"currency\", \"duration\", \"revenue\"", "example": "duration" }, "value": { "type": "number", "description": "Metric value", "example": 30 } } } } } }, "IGoalStepMetric_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the metric", "example": "Duration" }, "description": { "type": "string", "description": "The description of the metric", "example": "Time taken to complete the step" }, "type": { "type": "string", "description": "Metric type. Available values \"currency\", \"duration\", \"revenue\"", "example": "duration" }, "value": { "type": "number", "description": "Metric value", "example": 30 } } }, "IHandoverProvider_2_0": { "type": "object", "properties": { "_id": { "type": "string", "format": "mongoId", "description": "The object id of the handover provider" }, "referenceId": { "type": "string", "description": "The referenceId of the handover provider" }, "organisationId": { "type": "string", "description": "The organisation Id associated with the handover provider" }, "serviceId": { "type": "string", "description": "The id of the service" }, "service": { "type": "string", "description": "The handover provider's specified service; e.g., Live Agent, Genesys" }, "localeId": { "type": "string", "description": "The referenceId of the locale to use" }, "name": { "type": "string", "description": "The name of the handover provider resource" }, "createdAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was created initially" }, "lastChangedAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was last modified" }, "createdBy": { "type": "string", "format": "mongoId", "description": "Id of the user who created the entity initially" }, "lastChangedBy": { "type": "string", "format": "mongoId", "description": "Id of the user who made the last modification" }, "properties": { "type": "array", "items": { "type": "object", "description": "Properties associated with the handover provider", "additionalProperties": { "type": "string" } }, "description": "A list of properties associated with the handover provider" }, "settings": { "type": "object", "description": "Settings related to the handover provider", "additionalProperties": { "type": "string" } } } }, "IHandoverService_2_0": { "type": "object", "properties": { "_id": { "type": "string", "format": "mongoId", "description": "The object id of the handover service" }, "referenceId": { "type": "string", "format": "uuid", "description": "The referenceId of the handover service" }, "version": { "type": "string", "description": "The version of the handover service" }, "name": { "type": "string", "description": "The name of the handover service" }, "serviceUrl": { "type": "string", "format": "uri", "description": "The service URL of the handover service" }, "logoUrl": { "type": "string", "format": "uri", "description": "The logo URL of the handover service" }, "properties": { "type": "array", "items": { "type": "object", "description": "Properties associated with the handover service", "additionalProperties": { "type": "string" } }, "description": "A list of properties for the handover service" } } }, "IKnowledgeConnectorCreatePayload_2_0": { "type": "object", "properties": { "extension": { "type": "string", "description": "The name of the extension", "example": "confluence" }, "version": { "type": "string", "description": "The version of extension identifier", "example": "1.1.0" }, "type": { "type": "string", "description": "The Knowledge Connector type identifier within an extension", "example": "MyConfluenceConnector" }, "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } } } }, "IKnowledgeConnectorUpdatePayload_2_0": { "type": "object", "properties": { "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } } } }, "IKnowledgeConnectorExtensionReference_2_0": { "type": "object", "properties": { "extension": { "type": "string", "description": "The name of the extension", "example": "confluence" }, "version": { "type": "string", "description": "The version of extension identifier", "example": "1.1.0" }, "type": { "type": "string", "description": "The Knowledge Connector type identifier within an extension", "example": "MyConfluenceConnector" } } }, "IKnowledgeConnectorDataCreateAndUpdate_2_0": { "type": "object", "properties": { "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } } } }, "IKnowledgeConnectorData_2_0": { "type": "object", "properties": { "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "start": { "description": "Start date and time to calculate scheduled execution, set internally", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "totalMinutes": { "type": "number", "description": "Total minutes for the scheduled execution, set internally", "example": 1 }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "timezone": { "type": "string", "description": "Timezone for the scheduled execution in UTC, set internally", "example": "UTC" }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } } } }, "IKnowledgeConnectorExecution_2_0": { "type": "object", "properties": { "lastExecution": { "description": "Unix-timestamp when the last execution was triggered or null if never executed", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastExecutionStatus": { "type": "string", "description": "Last execution status of the KnowledgeConnector", "enum": [ "none", "queued", "active", "done", "error" ] } } }, "IKnowledgeConnector_2_0": { "type": "object", "properties": { "extension": { "type": "string", "description": "The name of the extension", "example": "confluence" }, "version": { "type": "string", "description": "The version of extension identifier", "example": "1.1.0" }, "type": { "type": "string", "description": "The Knowledge Connector type identifier within an extension", "example": "MyConfluenceConnector" }, "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "start": { "description": "Start date and time to calculate scheduled execution, set internally", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "totalMinutes": { "type": "number", "description": "Total minutes for the scheduled execution, set internally", "example": 1 }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "timezone": { "type": "string", "description": "Timezone for the scheduled execution in UTC, set internally", "example": "UTC" }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } }, "lastExecution": { "description": "Unix-timestamp when the last execution was triggered or null if never executed", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastExecutionStatus": { "type": "string", "description": "Last execution status of the KnowledgeConnector", "enum": [ "none", "queued", "active", "done", "error" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IKnowledgeSearchIngestData_2_0": { "type": "object", "properties": { "documentUrl": { "type": "string", "example": "https://some-website.com/knowledgebase.txt", "description": "The document url or the file name ingested for the knowledge store" }, "paragraphNumber": { "type": "number", "example": 3, "description": "The paragraph number of the document" }, "content": { "type": "string", "example": "some content", "description": "The content of the paragraph" }, "data": { "type": "object", "example": { "someKey": "someValue" }, "description": "The supporting data of the paragraph" } } }, "IKnowledgeStoreDataCreate_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "mystore", "description": "The name of the KnowledgeStore" }, "description": { "type": "string", "example": "mystore description", "description": "The description about what the knowledge store contains" } } }, "IKnowledgeStoreData_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "mystore", "description": "The name of the KnowledgeStore" }, "description": { "type": "string", "example": "mystore description", "description": "The description about what the knowledge store contains" }, "language": { "type": "string", "example": "en-US", "description": "The language code" }, "status": { "type": "string", "enum": [ "ready", "warning" ] }, "documents": { "type": "array", "items": { "type": "string", "example": "https://some-website.com/knowledgebase.txt", "description": "The document url or the file name ingested for the knowledge store" } } } }, "IKnowledgeStoreGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" } } }, "IKnowledgeStore_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "mystore", "description": "The name of the KnowledgeStore" }, "description": { "type": "string", "example": "mystore description", "description": "The description about what the knowledge store contains" }, "language": { "type": "string", "example": "en-US", "description": "The language code" }, "status": { "type": "string", "enum": [ "ready", "warning" ] }, "documents": { "type": "array", "items": { "type": "string", "example": "https://some-website.com/knowledgebase.txt", "description": "The document url or the file name ingested for the knowledge store" } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IKnowledgeChunkDataCreate_2_0": { "type": "object", "properties": { "order": { "type": "number", "example": 1, "description": "The name of the KnowledgeChunk" }, "text": { "type": "string", "example": "This is a paragraph from an article", "description": "The text that is the actual content of the chunk" }, "data": { "type": "object", "description": "The extended data of KnowledgeChunk" } } }, "IKnowledgeChunkData_2_0": { "type": "object", "properties": { "order": { "type": "number", "example": 1, "description": "The name of the KnowledgeChunk" }, "text": { "type": "string", "example": "This is a paragraph from an article", "description": "The text that is the actual content of the chunk" }, "data": { "type": "object", "description": "The extended data of KnowledgeChunk" }, "disabled": { "type": "boolean", "enum": [ false, true ], "description": "The status to check if knowledge chunk is disabled" } } }, "IKnowledgeChunkGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" } } }, "IKnowledgeChunk_2_0": { "type": "object", "properties": { "order": { "type": "number", "example": 1, "description": "The name of the KnowledgeChunk" }, "text": { "type": "string", "example": "This is a paragraph from an article", "description": "The text that is the actual content of the chunk" }, "data": { "type": "object", "description": "The extended data of KnowledgeChunk" }, "disabled": { "type": "boolean", "enum": [ false, true ], "description": "The status to check if knowledge chunk is disabled" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IKnowledgeSourceDataCreate_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "type": { "type": "string", "enum": [ "url", "manual", "pdf", "txt", "ctxt", "extension" ], "description": "The type of source for the Knowledge store" }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "example": "tag1" } } } } } }, "IKnowledgeSourceDataUpdate_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "status": { "type": "string", "enum": [ "ready", "ingesting", "disabled" ] }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "description": "Array of tags to replace the existing tags", "items": { "type": "string", "example": "tag1" } } } } } }, "IKnowledgeSourceDataTypeWebsite_2_0": { "type": "object", "properties": { "url": { "type": "string", "example": "https://www.some-article.com", "description": "The url of the website to scrape the data from. This is only applicable for KnowledgeSources of type \"url\"" } } }, "IKnowledgeSourceData_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "type": { "type": "string", "enum": [ "url", "manual", "pdf", "txt", "ctxt", "extension" ], "description": "The type of source for the Knowledge store" }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "example": "tag1" } } } }, "data": { "type": "object", "additionalProperties": true, "description": "Custom metadata object to store additional information in the KnowledgeSource", "example": { "_id": "x4xU6hMntv23p", "sys_CreatedAt": "2019-12-16T11:40:45.7212", "sys_UpdatedAt": "2025-10-01T07:46:04.5932", "Type": "FAQ" } }, "chunkCount": { "type": "integer" }, "status": { "type": "string", "enum": [ "ready", "ingesting", "disabled" ] }, "connectorReference": { "type": "string", "format": "uuid", "description": "The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type \"extension\"" } } }, "IKnowledgeSourceGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" } } }, "IKnowledgeSourceDataTypeExtension_2_0": { "type": "object", "properties": { "connectorId": { "type": "string", "format": "uuid", "description": "The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type \"extension\"" } }, "example": { "name": "mysource", "description": "mysource description", "type": "extension", "metaData": { "tags": [ "tag1" ] }, "connectorId": "uuid" } }, "IKnowledgeSource_2_0": { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "type": { "type": "string", "enum": [ "url", "manual", "pdf", "txt", "ctxt", "extension" ], "description": "The type of source for the Knowledge store" }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "example": "tag1" } } } }, "data": { "type": "object", "additionalProperties": true, "description": "Custom metadata object to store additional information in the KnowledgeSource", "example": { "_id": "x4xU6hMntv23p", "sys_CreatedAt": "2019-12-16T11:40:45.7212", "sys_UpdatedAt": "2025-10-01T07:46:04.5932", "Type": "FAQ" } }, "chunkCount": { "type": "integer" }, "status": { "type": "string", "enum": [ "ready", "ingesting", "disabled" ] }, "connectorReference": { "type": "string", "format": "uuid", "description": "The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type \"extension\"" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IAvailableModelItem_2_0": { "type": "object", "properties": { "modelName": { "type": "string" }, "modelId": { "type": "string" }, "providerName": { "type": "array" } } }, "IAvailableModelsForLLMProvider_2_0": { "type": "object", "properties": { "availableModels": { "type": "array", "items": { "type": "object", "properties": { "modelName": { "type": "string" }, "modelId": { "type": "string" }, "providerName": { "type": "array" } } } } } }, "ILLMFallback_2_0": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" }, "ILargeLanguageModelFieldsBase_2_0": { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } } } }, "ILargeLanguageModelFields_2_0": { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "fallbacks": { "type": "array", "description": "(alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.", "items": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" } } } }, "IGlobalLargeLanguageModelFields_2_0": { "type": "object", "required": [ "name", "modelType", "provider", "connectionId", "resourceLevel" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] } } }, "ILargeLanguageModelCreate_2_0": { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "fallbacks": { "type": "array", "description": "(alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.", "items": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" } } } }, "ILargeLanguageModelData_2_0": { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "fallbacks": { "type": "array", "description": "(alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.", "items": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" } }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" } } }, "IGlobalLargeLanguageModelData_2_0": { "type": "object", "required": [ "name", "modelType", "provider", "connectionId", "resourceLevel" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" } } }, "IGlobalLargeLanguageModel_2_0": { "type": "object", "required": [ "name", "modelType", "provider", "connectionId", "resourceLevel" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ILargeLanguageModel_2_0": { "oneOf": [ { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "fallbacks": { "type": "array", "description": "(alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.", "items": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" } }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, { "type": "object", "required": [ "name", "modelType", "provider", "connectionId", "resourceLevel" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } ] }, "ILargeLanguageModelIndexItem_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM Name" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "TImportLexiconMode_2_0": { "type": "string", "example": "skip", "enum": [ "skip", "overwrite", "merge" ] }, "ILexiconData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "EU countries" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" } } }, "ILexiconGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "values": { "deprecated": true } } }, "ILexicon_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "EU countries" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" }, "referenceId": { "type": "string", "format": "uuid" }, "values": { "deprecated": true }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ILexiconEntryData_2_0": { "type": "object", "required": [ "mainKeyphrase" ], "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": "{\"key1\": \"value1\" }" }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" } } }, "ILexiconEntryGeneratedData_2_0": { "type": "object", "properties": { "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } } } }, "ILexiconEntry_2_0": { "type": "object", "required": [ "mainKeyphrase" ], "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": "{\"key1\": \"value1\" }" }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ILexiconEntryIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "mainKeyphrase": { "description": "the keyphrase value", "example": "pizza" }, "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": {} }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "ILexiconIndexItemData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "New Lexicon" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" }, "referenceId": { "type": "string", "format": "uuid" } } }, "ILexiconIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "New Lexicon" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ILexiconKeyphraseData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicates if it is main", "example": true } } }, "ILexiconKeyphrase_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicates if it is main", "example": true }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ILexiconKeyphraseIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicates if it is main", "example": true }, "lexiconEntryReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "ILexiconSlotData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" } } }, "ILexiconSlot_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ILexiconSlotIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the slot", "example": "food" } } }, "ILocaleData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "primary": { "type": "boolean" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "ILocale_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "primary": { "type": "boolean" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "ILocaleIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "primary": { "type": "boolean" }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "TNLULanguage_2_0": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "IYesNoIntentData_2_0": { "type": "object", "properties": { "isDisabled": { "type": "boolean" }, "name": { "type": "string", "example": "pizza" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rules": { "type": "array", "items": { "type": "string" } } } }, "IYesNoIntentItem_2_0": { "type": "object", "properties": { "yesIntent": { "type": "object", "properties": { "isDisabled": { "type": "boolean" }, "name": { "type": "string", "example": "pizza" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rules": { "type": "array", "items": { "type": "string" } } } }, "noIntent": { "type": "object", "properties": { "isDisabled": { "type": "boolean" }, "name": { "type": "string", "example": "pizza" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rules": { "type": "array", "items": { "type": "string" } } } }, "rejectIntent": { "type": "object", "properties": { "isDisabled": { "type": "boolean" }, "name": { "type": "string", "example": "pizza" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rules": { "type": "array", "items": { "type": "string" } } } } } }, "IYesNoIntentMetaData_2_0": { "type": "object", "properties": { "rules": { "type": "array", "items": { "type": "string" }, "description": "The intent rules", "example": [ "this should be a valid rule" ] }, "isDisabled": { "type": "boolean" } } }, "INLUConnectorData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "settings": { "oneOf": [ { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } }, { "type": "object", "description": "Settings used by the Lex NLUConnector", "properties": { "accessKeyId": { "type": "string", "description": "Apikey for accessing the Lex NLU Api" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key for accessing the Lex NLU Api" }, "awsRegion": { "type": "string", "description": "The AWS region the Lex bot is deployed to" }, "botId": { "type": "string", "description": "Id of the Lex bot" }, "botAliasId": { "type": "string", "description": "Alias of the Lex bot" } } } ] }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } } } }, "INLUConnectorGeneratedData_2_0": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" } } }, "INLUConnector_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "settings": { "oneOf": [ { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } }, { "type": "object", "description": "Settings used by the Lex NLUConnector", "properties": { "accessKeyId": { "type": "string", "description": "Apikey for accessing the Lex NLU Api" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key for accessing the Lex NLU Api" }, "awsRegion": { "type": "string", "description": "The AWS region the Lex bot is deployed to" }, "botId": { "type": "string", "description": "Id of the Lex bot" }, "botAliasId": { "type": "string", "description": "Alias of the Lex bot" } } } ] }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "INLUTransformerFunction_2_0": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } }, "IDialogFlowSettings_2_0": { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, "ILuisSettings_2_0": { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, "IWatsonSettings_2_0": { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } }, "ILexSettings_2_0": { "type": "object", "description": "Settings used by the Lex NLUConnector", "properties": { "accessKeyId": { "type": "string", "description": "Apikey for accessing the Lex NLU Api" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key for accessing the Lex NLU Api" }, "awsRegion": { "type": "string", "description": "The AWS region the Lex bot is deployed to" }, "botId": { "type": "string", "description": "Id of the Lex bot" }, "botAliasId": { "type": "string", "description": "Alias of the Lex bot" } } }, "IAlexaSettings_2_0": { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, "ISkill_2_0": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } }, "INLUConnectorIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "referenceId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "TNLUConnectorType_2_0": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "INodeDescriptor_2_0": { "type": "object", "properties": { "type": { "type": "string" }, "parentType": { "type": "string", "description": "The type of the node parent, if there is one" }, "defaultLabel": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Node of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Node of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Node is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "extension": { "type": "string" }, "extensionImg": { "type": "string" }, "appearance": { "type": "object", "properties": { "logo": { "type": "string" }, "textColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "contrastTextColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "color": { "type": "string", "example": "red", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "variant": { "type": "string", "enum": [ "regular", "mini", "hexagon" ] } } }, "behavior": { "type": "object", "properties": { "stopping": { "type": "boolean" }, "entrypoint": { "type": "boolean" } } }, "constraints": { "type": "object", "properties": { "editable": { "type": "boolean", "description": "Should this node be editable" }, "deletable": { "type": "boolean", "description": "Should this node be deletable" }, "creatable": { "type": "boolean", "description": "Should this node be manually creatable" }, "collapsable": { "type": "boolean", "description": "Should this node be collapsable" }, "childFlowCreatable": { "type": "boolean", "description": "Should it be possible to create child flow from this node" }, "movable": { "type": "boolean", "description": "Should this node be movable" }, "placement": { "type": "object", "description": "Additional placement information", "properties": { "predecessor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "successor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "children": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } } } } } }, "dependencies": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "string" } } } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "previews": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message", "image", "code" ] }, "key": { "type": "string" } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 30, "example": "word count" }, "script": { "type": "string", "maxLength": 500, "example": "ci.text.split(' ').length" }, "type": { "type": "string", "enum": [ "profile", "input", "context", "custom", "answer", "flow-output", "flow-input" ], "example": "input" } } } }, "tags": { "type": "string", "enum": [ "basic", "logic", "message", "profile", "service", "nlu", "data" ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "INodeDescriptorWithoutLocalization_2_0": { "type": "object", "properties": { "type": { "type": "string" }, "parentType": { "oneOf": [ { "type": "string", "description": "The type of the node parent, if there is one" }, { "type": "array", "items": { "type": "string" }, "minItems": 1, "description": "Possible types of node parents" } ] }, "defaultLabel": { "type": "string", "description": "The label that should be used when a new Node of this type is created" }, "summary": { "type": "string", "description": "A short line of text that describes what this Node is used for" }, "extension": { "type": "string" }, "extensionImg": { "type": "string" }, "appearance": { "type": "object", "properties": { "logo": { "type": "string" }, "textColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "contrastTextColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "color": { "type": "string", "example": "red", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "variant": { "type": "string", "enum": [ "regular", "mini", "hexagon" ] } } }, "behavior": { "type": "object", "properties": { "stopping": { "type": "boolean" }, "entrypoint": { "type": "boolean" } } }, "constraints": { "type": "object", "properties": { "editable": { "type": "boolean", "description": "Should this node be editable" }, "deletable": { "type": "boolean", "description": "Should this node be deletable" }, "creatable": { "type": "boolean", "description": "Should this node be manually creatable" }, "collapsable": { "type": "boolean", "description": "Should this node be collapsable" }, "childFlowCreatable": { "type": "boolean", "description": "Should it be possible to create child flow from this node" }, "movable": { "type": "boolean", "description": "Should this node be movable" }, "placement": { "type": "object", "description": "Additional placement information", "properties": { "predecessor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "successor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "children": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } } } } } }, "dependencies": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "string" } } } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule" ] }, "key": { "type": "string" }, "label": { "type": "string" }, "defaultValue": { "description": "The default value for that field" } } } }, "previews": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message", "image", "code" ] }, "key": { "type": "string" } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 30, "example": "word count" }, "script": { "type": "string", "maxLength": 500, "example": "ci.text.split(' ').length" }, "type": { "type": "string", "enum": [ "profile", "input", "context", "custom", "answer", "flow-output", "flow-input" ], "example": "input" } } } }, "tags": { "type": "string", "enum": [ "basic", "logic", "message", "profile", "service", "nlu", "data" ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "INodeFieldCondition_2_0": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } }, "INodeSection_2_0": { "type": "object", "properties": { "key": { "type": "string", "description": "Unique identifier for this section within all sections of a descriptor, e.g. 'authentication" }, "label": { "oneOf": [ { "type": "string", "description": "Condition whether this section should be rendered" }, { "type": "object", "description": "A localized Condition whether this section should be rendered", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "condition": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } }, "defaultCollapsed": { "type": "boolean", "description": "Whether the sections should be collapsed by default", "default": false }, "fields": { "type": "array", "items": { "type": "string" } }, "theme": { "type": "string", "description": "Used to highlight sections if they contain new features" } } }, "INodeFieldAndSectionFormElement_2_0": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } }, "IOptionsResolverRestReturnValue_2_0": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } } } } } }, "IPackageData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" } } }, "IPackageGeneratedData_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "hash": { "type": "string", "description": "The hash identifying the contents of the Package", "example": "Version 1" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IPackageDataCreate_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" }, "resourceIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "IPackage_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "hash": { "type": "string", "description": "The hash identifying the contents of the Package", "example": "Version 1" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IPackageIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" }, "hash": { "type": "string", "description": "The hash of the Package identifying the contents of the Package" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IStrategy_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rename": { "type": "string", "description": "explicitly sets a new name for the imported resource", "example": "new flow" }, "autoRename": { "type": "boolean", "description": "If set to true, will append a \"counter-suffix\" to the name in\ncase the name already exists in the agent.\n", "default": true, "example": true }, "identityConflictStrategy": { "type": "string", "description": "Defines what should be done in case the agent already contains a resource\nwith the same id.\n", "default": "abort", "enum": [ "replace", "re-identify", "abort", "merge" ] }, "mergeStrategy": { "type": "object", "properties": { "replaceContent": { "type": "boolean" }, "replaceStructure": { "type": "boolean" }, "localeOverrides": { "type": "array", "items": { "type": "object", "properties": { "replaceContent": { "type": "boolean" }, "localeId": { "type": "string" } } } } } } } }, "IPlaybookData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Playbook", "example": "New Playbook" }, "abortOnError": { "type": "boolean", "description": "Flag whether to stop Playbook execution when an assert-error occurred" }, "timeout": { "type": "integer", "description": "A time (in ms) after which a playbook step is 'invalid/failed'", "example": 2000, "minimum": 1 } } }, "IPlaybook_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Playbook", "example": "New Playbook" }, "abortOnError": { "type": "boolean", "description": "Flag whether to stop Playbook execution when an assert-error occurred" }, "timeout": { "type": "integer", "description": "A time (in ms) after which a playbook step is 'invalid/failed'", "example": 2000, "minimum": 1 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "object", "description": "The data of this playbook step" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "asserts": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IPlaybookIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the playbook", "example": "New Playbook" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IPlaybookRunStepResultAssertData_2_0": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the assert", "example": "assertText" }, "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether this playbook step was successful or failed", "example": "failed" }, "params": { "type": "object", "description": "Parameters for the assert" }, "negate": { "type": "boolean", "description": "Whether the assert was negated", "example": false }, "actual": { "type": "object", "description": "Actual output" } } }, "IPlaybookRunStepResultAssert_2_0": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the assert", "example": "assertText" }, "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether this playbook step was successful or failed", "example": "failed" }, "params": { "type": "object", "description": "Parameters for the assert" }, "negate": { "type": "boolean", "description": "Whether the assert was negated", "example": false }, "actual": { "type": "object", "description": "Actual output" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IPlaybookRunStepResultData_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether this playbook step was successful or failed", "example": "failed" }, "text": { "type": "string", "description": "Text which we shoot into the system", "example": "Hello, how are you?" }, "data": { "type": "object", "description": "Data which we shoot into the system" } } }, "IPlaybookRunStepResult_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether this playbook step was successful or failed", "example": "failed" }, "text": { "type": "string", "description": "Text which we shoot into the system", "example": "Hello, how are you?" }, "data": { "type": "object", "description": "Data which we shoot into the system" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "asserts": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the assert", "example": "assertText" }, "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether this playbook step was successful or failed", "example": "failed" }, "params": { "type": "object", "description": "Parameters for the assert" }, "negate": { "type": "boolean", "description": "Whether the assert was negated", "example": false }, "actual": { "type": "object", "description": "Actual output" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "timeout": { "type": "boolean", "description": "Whether the step timed out" } } }, "IPlaybookRunData_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether the playbook run was successful or failed", "example": "successful" } } }, "IPlaybookRun_2_0": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether the playbook run was successful or failed", "example": "successful" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "stepResults": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether this playbook step was successful or failed", "example": "failed" }, "text": { "type": "string", "description": "Text which we shoot into the system", "example": "Hello, how are you?" }, "data": { "type": "object", "description": "Data which we shoot into the system" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "asserts": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the assert", "example": "assertText" }, "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether this playbook step was successful or failed", "example": "failed" }, "params": { "type": "object", "description": "Parameters for the assert" }, "negate": { "type": "boolean", "description": "Whether the assert was negated", "example": false }, "actual": { "type": "object", "description": "Actual output" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "timeout": { "type": "boolean", "description": "Whether the step timed out" } } } }, "flowId": { "type": "string", "description": "Reference Id of the flow", "example": "uuid" }, "localeId": { "type": "string", "description": "Reference Id of the locale", "example": "uuid" }, "entrypoint": { "type": "string", "description": "snapshot or project ID", "example": "^[a-z0-9]{24}$" } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IPlaybookRunIndexItem_2_0": { "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Status of the whole Playbook Run", "example": "successful" } } }, "IPlaybookStepData_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "object", "description": "The data of this playbook step" } } }, "IPlaybookStep_2_0": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "object", "description": "The data of this playbook step" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "asserts": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "IPlaybookStepAssertData_2_0": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" } } }, "IPlaybookStepAssert_2_0": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "ISchedulePlaybookRunRestReturnValue_2_0": { "type": "object", "description": "Created task metadata (same shape as ITaskReturnValue).", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "Task status (e.g. queued, active, done)", "example": "queued" }, "type": { "type": "string", "description": "Task type (e.g. runPlaybook)", "example": "runPlaybook" }, "parameters": { "type": "object", "description": "Task payload (playbookId, projectId, entrypoint, flowId, localeId, etc.)" }, "createdAt": { "type": "number", "description": "Unix timestamp in seconds when the task was created" }, "lastChangedAt": { "type": "number", "description": "Unix timestamp in seconds when the task was last updated" }, "progress": { "type": "integer", "minimum": 0, "maximum": 100, "description": "Task progress (0-100)" }, "job": { "type": "object", "description": "Present only when the task runs as a Kubernetes job", "properties": { "name": { "type": "string" }, "namespace": { "type": "string" }, "timeoutInMs": { "type": "number" } } } } }, "ISchedulePlaybookRunRestDataBody_2_0": { "type": "object", "properties": { "entrypoint": { "type": "string", "description": "snapshot or project ID", "example": "61f25579055c2f43c249a181" }, "flowId": { "type": "string", "description": "The reference ID of the flow", "example": "010d1970-89b9-4012-892b-53c78ef6c117" }, "localeId": { "type": "string", "description": "The reference ID of locale", "example": "8b3b45e2-48f9-446d-a4c5-35d8284a01b2" } } }, "ICreateProjectByTemplateRestDataBody_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } }, "locale": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "templateConfiguration": { "type": "object", "properties": { "endpoints": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string" } } } }, "skills": { "type": "array", "items": { "type": "string" } }, "template": { "type": "string" } } } } }, "IGraph_2_0": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "example": "project", "enum": [ "project", "snapshot" ] }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "resources": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "properties": { "type": "object" } } } } } } ] } }, "IGraphProject_2_0": { "type": "object", "properties": { "type": { "type": "string", "example": "project", "enum": [ "project", "snapshot" ] }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "resources": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "properties": { "type": "object" } } } } } }, "IGraphResource_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "properties": { "type": "object" } } }, "IProjectData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } } } }, "IProjectGeneratedData_2_0": { "type": "object", "properties": { "primaryLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "IHandoverConfiguration_2_0": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } }, "IProjectCreateData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } }, "locale": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] } } }, "IProject_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } }, "liveAgentDefaultInbox": { "type": "number", "description": "Live agent default inbox Id for the project" }, "primaryLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IProjectIndexItem_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } }, "liveAgentDefaultInbox": { "type": "number", "description": "Live agent default inbox Id for the project" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "IAgentSettingsData_2_0": { "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone according to IANA Timezone Database (2020a)", "example": "Europe/Berlin", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ] }, "useCaseSensitiveIntentMapping": { "type": "boolean" }, "collectAnalytics": { "type": "boolean" }, "trackDataOnlyInputs": { "type": "boolean" }, "translationSettings": { "type": "object", "properties": { "provider": { "type": "string", "description": "Supported Translation Providers", "enum": [ "none", "microsoft", "google", "deepl" ] }, "connections": { "type": "object", "properties": { "microsoft": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "deepl": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "google": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } } } } } }, "audioPreviewSettings": { "type": "object", "properties": { "provider": { "type": "string", "description": "Supported AudioPreview Providers", "enum": [ null, "microsoft", "google", "aws" ] }, "connections": { "type": "object", "properties": { "microsoft": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "aws": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "google": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } } } } } }, "generativeAISettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useCasesSettings": { "type": "object", "properties": { "designTimeGeneration": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "aiEnhancedOutputs": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "gptConversation": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "gptPromptNode": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "knowledgeSearch": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } } } } } }, "currencySettings": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" } } }, "knowledgeAISettings": { "type": "object", "properties": { "fileExtractor": { "type": "string", "description": "Options for the Knowledge AI File Extractor", "enum": [ "default", "legacy", "azure" ] }, "azureDIConnectionId": { "type": "string", "description": "ReferenceId of the Azure AI Document Intelligence Connection", "example": "f66e99eb-db8f-433c-977f-69160d9a6bdb" } } }, "piiDataRedactionSettings": { "type": "object", "properties": { "emailAddress": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "phoneNumber": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "creditCard": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ssn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ipAddressV4": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ipAddressV6": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "customTypes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the custom PII field type" }, "regex": { "type": "string", "description": "Regular expression pattern to match custom PII data (RE2 syntax)", "minLength": 1, "maxLength": 2000 } }, "required": [ "behavior", "scope", "name", "regex" ] }, "description": "User-defined custom PII patterns with regex matching" } }, "required": [ "emailAddress", "phoneNumber", "creditCard", "ssn", "ipAddressV4", "ipAddressV6" ] } } }, "IAgentSettings_2_0": { "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone according to IANA Timezone Database (2020a)", "example": "Europe/Berlin", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ] }, "useCaseSensitiveIntentMapping": { "type": "boolean" }, "collectAnalytics": { "type": "boolean" }, "trackDataOnlyInputs": { "type": "boolean" }, "translationSettings": { "type": "object", "properties": { "provider": { "type": "string", "description": "Supported Translation Providers", "enum": [ "none", "microsoft", "google", "deepl" ] }, "connections": { "type": "object", "properties": { "microsoft": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "deepl": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "google": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } } } } } }, "audioPreviewSettings": { "type": "object", "properties": { "provider": { "type": "string", "description": "Supported AudioPreview Providers", "enum": [ null, "microsoft", "google", "aws" ] }, "connections": { "type": "object", "properties": { "microsoft": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "aws": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "google": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } } } } } }, "generativeAISettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useCasesSettings": { "type": "object", "properties": { "designTimeGeneration": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "aiEnhancedOutputs": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "gptConversation": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "gptPromptNode": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "knowledgeSearch": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } } } } } }, "currencySettings": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" } } }, "knowledgeAISettings": { "type": "object", "properties": { "fileExtractor": { "type": "string", "description": "Options for the Knowledge AI File Extractor", "enum": [ "default", "legacy", "azure" ] }, "azureDIConnectionId": { "type": "string", "description": "ReferenceId of the Azure AI Document Intelligence Connection", "example": "f66e99eb-db8f-433c-977f-69160d9a6bdb" } } }, "piiDataRedactionSettings": { "type": "object", "properties": { "emailAddress": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "phoneNumber": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "creditCard": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ssn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ipAddressV4": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ipAddressV6": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "customTypes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the custom PII field type" }, "regex": { "type": "string", "description": "Regular expression pattern to match custom PII data (RE2 syntax)", "minLength": 1, "maxLength": 2000 } }, "required": [ "behavior", "scope", "name", "regex" ] }, "description": "User-defined custom PII patterns with regex matching" } }, "required": [ "emailAddress", "phoneNumber", "creditCard", "ssn", "ipAddressV4", "ipAddressV6" ] }, "intentThreshold": { "type": "object", "properties": { "lower": { "type": "number", "example": 0.4 }, "upper": { "type": "number", "example": 0.5 } } }, "learnNewExampleSentences": { "type": "boolean" }, "learnNewExampleSentencesThreshold": { "type": "integer" }, "negativeConfirmationWords": { "type": "array", "items": { "type": "string" } }, "positiveConfirmationWords": { "type": "array", "items": { "type": "string" } }, "systemSlots": { "type": "object", "properties": { "useAgeSlots": { "type": "boolean" }, "useDateSlots": { "type": "boolean" }, "useDistanceSlots": { "type": "boolean" }, "useDurationSlots": { "type": "boolean" }, "useEmailSlots": { "type": "boolean" }, "useMoneySlots": { "type": "boolean" }, "useNumberSlots": { "type": "boolean" }, "usePercentageSlots": { "type": "boolean" }, "useTemperatureSlots": { "type": "boolean" }, "useURLSlots": { "type": "boolean" } } }, "yesNoLogic": { "type": "string", "enum": [ "yesNoIntents", "yesNoIntentsWithRules", "confirmationWords" ] }, "yesNoIntentThreshold": { "type": "integer" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "TTranslationProvider_2_0": { "type": "string", "description": "Supported Translation Providers", "enum": [ "none", "microsoft", "google", "deepl" ] }, "TranslationConnection": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "IAgentTranslationSettings_2_0": { "type": "object", "properties": { "provider": { "type": "string", "description": "Supported Translation Providers", "enum": [ "none", "microsoft", "google", "deepl" ] }, "connections": { "type": "object", "properties": { "microsoft": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "deepl": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "google": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } } } } } }, "TAudioPreviewProvider_2_0": { "type": "string", "description": "Supported AudioPreview Providers", "enum": [ null, "microsoft", "google", "aws" ] }, "IAudioPreviewMicrosoftSettings_2_0": { "type": "object", "properties": { "apiKey": { "type": "string", "maxLength": 30, "description": "MS API Key" }, "region": { "type": "string", "maxLength": 30, "description": "MS region" } } }, "IAudioPreviewAWSSettings_2_0": { "type": "object", "properties": { "accessKeyId": { "type": "string", "maxLength": 100, "description": "AWS API Id" }, "secretAccessKey": { "type": "string", "maxLength": 150, "description": "AWS API accesss Key" }, "sessionToken": { "type": "string", "maxLength": 300, "description": "AWS API session token" }, "region": { "type": "string", "maxLength": 30, "description": "AWS region" } } }, "IAudioPreviewGoogleSettings_2_0": { "type": "object", "properties": { "googleCredentialsFileName": { "type": "string", "maxLength": 100, "description": "Google Cloud credentials .json file" }, "fileToken": { "type": "string", "maxLength": 500, "description": "Credentials file token" }, "credentialsStringified": { "type": "string", "maxLength": 300, "description": "Credentials file stringified" }, "clientEmail": { "type": "string", "maxLength": 300, "description": "Client Email from the Google Cloud credentials .json file" }, "privateKey": { "type": "string", "maxLength": 150, "description": "Client private key from Google credentials file name" } } }, "AudioPreviewConnection": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "IAudioPreviewSettings_2_0": { "type": "object", "properties": { "provider": { "type": "string", "description": "Supported AudioPreview Providers", "enum": [ null, "microsoft", "google", "aws" ] }, "connections": { "type": "object", "properties": { "microsoft": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "aws": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "google": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } } } } } }, "TGenerativeAIProviders_2_0": { "type": "string", "description": "Supported Generative AI Providers", "enum": [ "openAI", "openAICompatible", "azureOpenAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "TGenerativeAIModels_2_0": { "type": "string", "description": "Supported Generative AI Models", "enum": [ "gpt-4o", "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "text-embedding-ada-002", "luminous-extended-control", "text-bison@001" ] }, "IGenerativeAIMeta_2_0": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "IGenerativeAIModelSettings_2_0": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useCasesSettings": { "type": "object", "properties": { "designTimeGeneration": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "aiEnhancedOutputs": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "gptConversation": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "gptPromptNode": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "knowledgeSearch": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } } } } } }, "TFileExtractorOptions_2_0": { "type": "string", "description": "Options for the Knowledge AI File Extractor", "enum": [ "default", "legacy", "azure" ] }, "IKnowledgeAISettings_2_0": { "type": "object", "properties": { "fileExtractor": { "type": "string", "description": "Options for the Knowledge AI File Extractor", "enum": [ "default", "legacy", "azure" ] }, "azureDIConnectionId": { "type": "string", "description": "ReferenceId of the Azure AI Document Intelligence Connection", "example": "f66e99eb-db8f-433c-977f-69160d9a6bdb" } } }, "EPiiBehaviorType": { "type": "string", "description": "PII redaction behavior types", "enum": [ "predefined-alias", "custom-alias" ] }, "IRedactionBehavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "IRedactionScope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "IPiiFieldSettings": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ICustomPatternSettings": { "type": "object", "properties": { "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the custom PII field type" }, "regex": { "type": "string", "description": "Regular expression pattern to match custom PII data (RE2 syntax)", "minLength": 1, "maxLength": 2000 } }, "required": [ "behavior", "scope", "name", "regex" ] }, "IPiiDataRedactionSettings_2_0": { "type": "object", "properties": { "emailAddress": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "phoneNumber": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "creditCard": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ssn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ipAddressV4": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ipAddressV6": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "customTypes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the custom PII field type" }, "regex": { "type": "string", "description": "Regular expression pattern to match custom PII data (RE2 syntax)", "minLength": 1, "maxLength": 2000 } }, "required": [ "behavior", "scope", "name", "regex" ] }, "description": "User-defined custom PII patterns with regex matching" } }, "required": [ "emailAddress", "phoneNumber", "creditCard", "ssn", "ipAddressV4", "ipAddressV6" ] }, "ISharedSettings_2_0": { "type": "object", "properties": { "intentThreshold": { "type": "object", "properties": { "lower": { "type": "number", "example": 0.4 }, "upper": { "type": "number", "example": 0.5 } } }, "learnNewExampleSentences": { "type": "boolean" }, "learnNewExampleSentencesThreshold": { "type": "integer" }, "negativeConfirmationWords": { "type": "array", "items": { "type": "string" } }, "positiveConfirmationWords": { "type": "array", "items": { "type": "string" } }, "systemSlots": { "type": "object", "properties": { "useAgeSlots": { "type": "boolean" }, "useDateSlots": { "type": "boolean" }, "useDistanceSlots": { "type": "boolean" }, "useDurationSlots": { "type": "boolean" }, "useEmailSlots": { "type": "boolean" }, "useMoneySlots": { "type": "boolean" }, "useNumberSlots": { "type": "boolean" }, "usePercentageSlots": { "type": "boolean" }, "useTemperatureSlots": { "type": "boolean" }, "useURLSlots": { "type": "boolean" } } }, "yesNoLogic": { "type": "string", "enum": [ "yesNoIntents", "yesNoIntentsWithRules", "confirmationWords" ] }, "yesNoIntentThreshold": { "type": "integer" } } }, "ITestTranslationSettings_2_0": { "type": "object", "properties": { "language": { "type": "string" }, "error": { "type": "object" }, "msg": { "type": "string" } } }, "ISnippet_2_0": { "type": "object", "properties": { "label": { "type": "string", "description": "The snippet Name", "example": "New snippet" } } }, "ISearchResultIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "pizza-endpoint" }, "type": { "type": "string", "description": "The type of a resource", "example": "endpoint", "enum": [ "endpoint", "extension", "flow", "function", "lexicon", "goal", "handoverProvider", "nluconnector", "playbook", "project", "snapshot" ] }, "subType": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, { "type": "string", "description": "Supported Generative AI Providers", "enum": [ "openAI", "openAICompatible", "azureOpenAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] } ] }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "IResourceInSnapshotItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "New Resource" }, "referenceId": { "type": "string", "description": "The reference ID of the resource" }, "resourceType": { "type": "string", "description": "The type of resource", "example": "flow" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 } } }, "ISnapshotData_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Snapshot", "example": "New Snapshot" }, "description": { "type": "string", "description": "The description of the Snapshot", "example": "Version 1" } } }, "ISnapshotGeneratedData_2_0": { "type": "object", "properties": { "isPackaged": { "type": "boolean", "description": "Whether the Snapshot has already been packaged and is ready for download" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "hash": { "type": "string", "description": "The hash identifying the contents of the Snapshot", "example": "Version 1" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "ISnapshot_2_0": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Snapshot", "example": "New Snapshot" }, "description": { "type": "string", "description": "The description of the Snapshot", "example": "Version 1" }, "isPackaged": { "type": "boolean", "description": "Whether the Snapshot has already been packaged and is ready for download" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "hash": { "type": "string", "description": "The hash identifying the contents of the Snapshot", "example": "Version 1" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } }, "ISnapshotIndexItem_2_0": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Snapshot", "example": "New Snapshot" }, "description": { "type": "string", "description": "The description of the Snapshot", "example": "Version 1" }, "isPackaged": { "type": "boolean", "description": "Whether the Snapshot has already been packaged and is ready for download" }, "packageExpiresAt": { "type": "number", "description": "The timestamp where the downloadable package expires" }, "hash": { "type": "string", "description": "The hash of the Snapshot identifying the contents of the Snapshot" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 } } }, "TUploadResumableTypes": { "type": "string", "enum": [ "snapshots", "packages" ] }, "ICrudPermissions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "IOrganisationWideAcl": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "auditEvents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentAccount": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "knowledgeStores": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentInbox": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "goals": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "voiceGatewayAccount": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } } } }, "IProjectWideAcl": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "agentAssistConfigs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analytics": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensionsTrust": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "handoverProviders": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "largeLanguageModels": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "knowledgeStores": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentInbox": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "goals": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "simulator": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "additionalProperties": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "agentAssistConfigAdmin", "agentAssistConfigViewer", "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "followUser", "handoverProviderAdmin", "intents", "data_privacy_admin", "data_privacy_editor", "data_privacy_viewer", "knowledgeAdmin", "large_language_model_admin,", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "simulator_admin" ] } }, "allowedLocales": { "type": "array", "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "primary": { "type": "boolean" } } } } } }, "IUserAcl": { "type": "object", "properties": { "organisationWide": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "auditEvents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentAccount": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "knowledgeStores": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentInbox": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "goals": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "voiceGatewayAccount": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } } } }, "projectWide": { "type": "object", "additionalProperties": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "agentAssistConfigs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analytics": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensionsTrust": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "handoverProviders": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "largeLanguageModels": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "knowledgeStores": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentInbox": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "goals": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "simulator": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "additionalProperties": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "agentAssistConfigAdmin", "agentAssistConfigViewer", "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "followUser", "handoverProviderAdmin", "intents", "data_privacy_admin", "data_privacy_editor", "data_privacy_viewer", "knowledgeAdmin", "large_language_model_admin,", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "simulator_admin" ] } }, "allowedLocales": { "type": "array", "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "primary": { "type": "boolean" } } } } } } } } }, "IAllowedLocale": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "primary": { "type": "boolean" } } }, "TIdentityProviderType": { "type": "string", "description": "The Type of Identity Provider. Currently saml and oidc are supported.\n", "enum": [ "saml", "oidc" ] }, "ISamlIdentityProviderData": { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "saml" ] }, "idpIssuer": { "type": "string", "description": "The value that will be in the issuer field in the SAML request.", "format": "url" }, "idpLoginEndpoint": { "type": "string", "description": "The URL to use to login in the IDP. Used in the SP initiated Flow.", "format": "url" }, "idpLogoutEndpoint": { "type": "string", "description": "The URL to send SLO requests against. Not all identity providers support this.", "format": "url" }, "idpCertificate": { "type": "string", "description": "The certificate from the ID used to sign the SAML requests. It is base64 encoded." }, "wantAuthnResponseSigned": { "type": "boolean", "description": "If the SAML authentification response should be signed, not all providers support this." }, "decryptionPrivateKey": { "type": "string", "description": "An optional decryption key. This is necessary if the SAML request is encoded." }, "idpDisableRequestedAuthnContext": { "type": "boolean", "description": "For some providers, e.g. Azure on-prem, it might be necessary to disable the authn context field in the SAML request.", "default": false } } }, "TIdpTokenEndpointAuthMethod": { "type": "string", "description": "Requested Client Authentication method for the Token Endpoint.\n\nhttps://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication\n", "enum": [ "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt", "tls_client_auth", "self_signed_tls_client_auth", "none" ], "default": "client_secret_basic", "example": "client_secret_basic" }, "TIdpIdTokenSignedResponseAlg": { "type": "string", "description": "The Algorithm used to sign the ID Token issued to this Client.\n", "enum": [ "RS256", "RS384", "RS512", "HS256", "HS384", "HS512" ], "default": "RS256", "example": "RS256" }, "IOidcIdentityProviderData": { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "oidc" ] }, "idpIssuer": { "type": "string", "description": "The URL of the OIDC identity provider. Must include `https://` to ensure a secure connection. Example `https://accounts.google.com`.", "format": "url" }, "idpClientId": { "type": "string", "description": "The client identifier issued to the client during\nthe registration process.\n\nThe authorization server issues the registered client a client\nidentifier -- a unique string representing the registration\ninformation provided by the client. The client identifier is not\na secret; it is exposed to the resource owner and MUST NOT be\nused alone for client authentication.\n\nThe client identifier is unique to the authorization server.\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\n" }, "idpClientSecret": { "type": "string", "description": "This value is used by Confidential Clients to authenticate to the\nToken Endpoint, as described in Section 2.3.1 of OAuth 2.0, and\nfor the derivation of symmetric encryption key values, as\ndescribed in Section 10.2 of OpenID Connect Core 1.0\n[OpenID.Core].\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\nhttps://openid.net/specs/openid-connect-core-1_0.html#Encryption\n" }, "idpAdditionalScope": { "type": "string", "default": "openid profile email offline_access", "description": "The scopes associated with Access Tokens determine what resources\nwill be available when they are used to access OAuth 2.0\nprotected endpoints.\nFor OpenID Connect, scopes can be used to request that specific\nsets of information be made available as Claim Values.\nThe scopes openid, profile, email and offline_access are always\nrequested.\n" }, "idpFrontChannelLogoutUrl": { "type": "string", "format": "url" }, "idpIdTokenSignedResponseAlg": { "type": "string", "description": "The Algorithm used to sign the ID Token issued to this Client.\n", "enum": [ "RS256", "RS384", "RS512", "HS256", "HS384", "HS512" ], "default": "RS256", "example": "RS256" }, "idpTokenEndpointAuthMethod": { "type": "string", "description": "Requested Client Authentication method for the Token Endpoint.\n\nhttps://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication\n", "enum": [ "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt", "tls_client_auth", "self_signed_tls_client_auth", "none" ], "default": "client_secret_basic", "example": "client_secret_basic" } } }, "IIdentityProviderData": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "saml" ] }, "idpIssuer": { "type": "string", "description": "The value that will be in the issuer field in the SAML request.", "format": "url" }, "idpLoginEndpoint": { "type": "string", "description": "The URL to use to login in the IDP. Used in the SP initiated Flow.", "format": "url" }, "idpLogoutEndpoint": { "type": "string", "description": "The URL to send SLO requests against. Not all identity providers support this.", "format": "url" }, "idpCertificate": { "type": "string", "description": "The certificate from the ID used to sign the SAML requests. It is base64 encoded." }, "wantAuthnResponseSigned": { "type": "boolean", "description": "If the SAML authentification response should be signed, not all providers support this." }, "decryptionPrivateKey": { "type": "string", "description": "An optional decryption key. This is necessary if the SAML request is encoded." }, "idpDisableRequestedAuthnContext": { "type": "boolean", "description": "For some providers, e.g. Azure on-prem, it might be necessary to disable the authn context field in the SAML request.", "default": false } } }, { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "oidc" ] }, "idpIssuer": { "type": "string", "description": "The URL of the OIDC identity provider. Must include `https://` to ensure a secure connection. Example `https://accounts.google.com`.", "format": "url" }, "idpClientId": { "type": "string", "description": "The client identifier issued to the client during\nthe registration process.\n\nThe authorization server issues the registered client a client\nidentifier -- a unique string representing the registration\ninformation provided by the client. The client identifier is not\na secret; it is exposed to the resource owner and MUST NOT be\nused alone for client authentication.\n\nThe client identifier is unique to the authorization server.\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\n" }, "idpClientSecret": { "type": "string", "description": "This value is used by Confidential Clients to authenticate to the\nToken Endpoint, as described in Section 2.3.1 of OAuth 2.0, and\nfor the derivation of symmetric encryption key values, as\ndescribed in Section 10.2 of OpenID Connect Core 1.0\n[OpenID.Core].\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\nhttps://openid.net/specs/openid-connect-core-1_0.html#Encryption\n" }, "idpAdditionalScope": { "type": "string", "default": "openid profile email offline_access", "description": "The scopes associated with Access Tokens determine what resources\nwill be available when they are used to access OAuth 2.0\nprotected endpoints.\nFor OpenID Connect, scopes can be used to request that specific\nsets of information be made available as Claim Values.\nThe scopes openid, profile, email and offline_access are always\nrequested.\n" }, "idpFrontChannelLogoutUrl": { "type": "string", "format": "url" }, "idpIdTokenSignedResponseAlg": { "type": "string", "description": "The Algorithm used to sign the ID Token issued to this Client.\n", "enum": [ "RS256", "RS384", "RS512", "HS256", "HS384", "HS512" ], "default": "RS256", "example": "RS256" }, "idpTokenEndpointAuthMethod": { "type": "string", "description": "Requested Client Authentication method for the Token Endpoint.\n\nhttps://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication\n", "enum": [ "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt", "tls_client_auth", "self_signed_tls_client_auth", "none" ], "default": "client_secret_basic", "example": "client_secret_basic" } } } ] }, "TOrganisationWidePermissions": { "type": "string", "enum": [ "analyticsOdata", "apiKeys", "auditEvents", "liveAgentAccount", "projects", "userDetails", "users", "voiceGatewayAccount", "opsCenter" ] }, "TProjectWidePermissions": { "type": "string", "enum": [ "agentAssistConfigs", "aiAgents", "analytics", "connections", "contactProfiles", "conversationHistory", "endpoints", "extensions", "extensionsTrust", "flowNodeComments", "flowNodeDescription", "flowNodes", "flows", "followUser", "intents", "largeLanguageModels", "knowledgeStores", "lexicons", "liveAgentInbox", "locales", "logs", "memberDetails", "members", "goals", "handoverProviders", "nluConnectors", "packages", "playbooks", "project", "projectSettings", "snapshots", "states", "tasks", "tokens", "functions", "yesNoIntents", "dataPrivacySettings", "simulator" ] }, "TPermissionState": { "type": "number", "enum": [ -1, 0, 1 ], "description": "Sort order:\n * `-1` - explicitly denied\n * `0` - unset(inherit)\n * `1` - explicitly granted\n" }, "IProjectScope": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, "TOrganisationWideRole": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] }, "TProjectWideRole": { "type": "string", "enum": [ "agentAssistConfigAdmin", "agentAssistConfigViewer", "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "followUser", "handoverProviderAdmin", "intents", "data_privacy_admin", "data_privacy_editor", "data_privacy_viewer", "knowledgeAdmin", "large_language_model_admin,", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "simulator_admin" ] }, "TTaskProgress": { "type": "integer", "minimum": 0, "maximum": 100 }, "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", "example": "5ce7c2d833ea1e04d7e6c432", "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, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "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/organisations/chunkcount": { "get": { "operationId": "readOrganisationKnowledgeChunksCount_2_0", "summary": "Get Knowledge Chunk Count", "description": "Gets the total number of Knowledge Chunks created across Projects in the organization.", "tags": [ "Administration" ], "responses": { "200": { "description": "Returns the total number of Knowledge Chunks created across Projects in the organization.", "content": { "application/json": { "schema": { "type": "object", "properties": { "chunkCount": { "type": "number" } } } } } }, "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/organisations/policy": { "get": { "operationId": "readOrganisationPolicies_2_0", "summary": "Get Organization Policies", "description": "Gets all policies for the organization as shown in the Management UI, including quotas, password and session rules, conversation and Contact Profile settings, data privacy options, billing time zone, and AI Ops Center status.", "tags": [ "Administration" ], "responses": { "200": { "description": "Returns the policies defined for the user's organisation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "businessUnitId": { "type": "string", "description": "The business unit ID" }, "tenantId": { "type": "string", "description": "The tenant ID" }, "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "quotaMaxKnowledgeChunks": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "liveAgentAccount": { "type": "number" }, "billingTimezone": { "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" ] }, "dataPrivacySettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "aiOpsCenterEnabled": { "type": "boolean" } } } } } }, "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/organisations/requestdeletion": { "post": { "operationId": "requestOrganisationDeletion_2_0", "summary": "Initiate Organization Deletion", "description": "Initiates the process to delete an organisation. A confirmation token will be sent via email to the system administrator to proceed with the deletion.", "tags": [ "Administration" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "deleteOrganisation data model with all the data collection that will be removed." }, "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/system/license": { "get": { "operationId": "getSystemLicenseState_2_0", "summary": "Get the License State for the Organization", "description": "Gets the current license state of the organization, including its system capabilities and usage quotas.", "tags": [ "Administration" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "The state of the license", "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "type": "string", "description": "The state of the license", "example": "valid", "enum": [ "invalid", "valid", "valid3MonthsLeft", "willExpireSoon", "expiredRenewRequired", "expired" ] } } } } } }, "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": [] } ] }, "post": { "operationId": "setSystemLicense_2_0", "summary": "Set the License", "description": "Sets the system license for the organization, updating license details such as access and quotas.", "tags": [ "Administration" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "organisationId", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string" }, "licensekey": { "type": "string" } } } } } }, "responses": { "202": { "description": "Successfully updated the System License", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "The success message.", "example": "The new license was installed within the system." } } } } } }, "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/system/message": { "get": { "operationId": "getSystemMessage_2_0", "summary": "Get System Maintenance Messages", "description": "Gets system-wide maintenance messages that are preconfigured in the Management UI, including their display timing and visibility settings.", "tags": [ "Administration" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "The maintenance message", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Next great Update will be released next Monday." }, "until": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "showOnLogin": { "type": "boolean" } } } } } }, "204": { "description": "Currently no maintenance message" }, "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/aicopilotconfigs": { "post": { "operationId": "createAiCopilotConfig_2_0", "summary": "Create an Agent Copilot Configuration", "description": "Creates an Agent Copilot configuration in a Project. The Agent Copilot configuration defines the grid layout, which serves as the structure for your AI Copilot Workspace. After creation, select the configuration in the Cognigy.AI Endpoint under the Copilot section.", "tags": [ "Agent Copilot Configuration" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The human readable name of the config." }, "description": { "type": "string", "description": "The description which can be used to understand what the agent assist config contains in terms of tiles." }, "config": { "type": "object", "description": "The actual grid-config.", "properties": { "grid": { "type": "object", "properties": { "columns": { "type": "number", "description": "Number of columns in the grid." }, "rows": { "type": "number", "description": "Number of rows in the grid." }, "gap": { "type": "number", "description": "Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used." } } }, "tiles": { "type": "object", "properties": { "tile-id": { "type": "object", "description": "The Tile ID is used in the Flow Nodes to fill in this specific tile.", "properties": { "x": { "type": "number", "description": "The row number where the tile is located, starting from 1." }, "y": { "type": "number", "description": "The column number where the tile is located, starting from 1." }, "columns": { "type": "number", "description": "The number of columns the tile should occupy. The default value is 1." }, "rows": { "type": "number", "description": "The number of rows the tile should occupy. The default value is 1." } } } } } } }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns the Agent Copilot Configuration object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The human readable name of the config." }, "description": { "type": "string", "description": "The description which can be used to understand what the agent assist config contains in terms of tiles." }, "config": { "type": "object", "description": "The actual grid-config.", "properties": { "grid": { "type": "object", "properties": { "columns": { "type": "number", "description": "Number of columns in the grid." }, "rows": { "type": "number", "description": "Number of rows in the grid." }, "gap": { "type": "number", "description": "Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used." } } }, "tiles": { "type": "object", "properties": { "tile-id": { "type": "object", "description": "The Tile ID is used in the Flow Nodes to fill in this specific tile.", "properties": { "x": { "type": "number", "description": "The row number where the tile is located, starting from 1." }, "y": { "type": "number", "description": "The column number where the tile is located, starting from 1." }, "columns": { "type": "number", "description": "The number of columns the tile should occupy. The default value is 1." }, "rows": { "type": "number", "description": "The number of rows the tile should occupy. The default value is 1." } } } } } } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexAiCopilotConfigs_2_0", "summary": "Get Agent Copilot Configurations", "description": "Gets Agent Copilot configurations for a Project. By default, 25 audit events are returned. Use the `limit` query parameter to change this value.", "tags": [ "Agent Copilot Configurations" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "Filter records by specific field eg:name." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns an array of Agent Copilot configuration objects.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The human readable name of the config." }, "description": { "type": "string", "description": "The description which can be used to understand what the agent assist config contains in terms of tiles." }, "config": { "type": "object", "description": "The actual grid-config.", "properties": { "grid": { "type": "object", "properties": { "columns": { "type": "number", "description": "Number of columns in the grid." }, "rows": { "type": "number", "description": "Number of rows in the grid." }, "gap": { "type": "number", "description": "Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used." } } }, "tiles": { "type": "object", "properties": { "tile-id": { "type": "object", "description": "The Tile ID is used in the Flow Nodes to fill in this specific tile.", "properties": { "x": { "type": "number", "description": "The row number where the tile is located, starting from 1." }, "y": { "type": "number", "description": "The column number where the tile is located, starting from 1." }, "columns": { "type": "number", "description": "The number of columns the tile should occupy. The default value is 1." }, "rows": { "type": "number", "description": "The number of rows the tile should occupy. The default value is 1." } } } } } } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/aicopilotconfigs/{configId}": { "delete": { "operationId": "deleteAiCopilotConfig_2_0", "summary": "Delete an Agent Copilot Configuration", "description": "Deletes an Agent Copilot configuration from a Project. If the configuration is still in use in the Copilot section of any Endpoint in this Project, replace the configuration with another one before using this method.", "tags": [ "Agent Copilot Configuration" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "configId", "description": "The Id of the Ai Copilot config", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The Agent Copilot Configuration was successfully deleted." }, "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": [] } ] }, "get": { "operationId": "readAiCopilotConfig_2_0", "summary": "Get an Agent Copilot Configuration", "description": "Gets an Agent Copilot Configuration from a Project.", "tags": [ "Agent Copilot Configurations" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "configId", "description": "The Id of the Ai Copilot config", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the Agent Copilot Configuration object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The human readable name of the config." }, "description": { "type": "string", "description": "The description which can be used to understand what the agent assist config contains in terms of tiles." }, "config": { "type": "object", "description": "The actual grid-config.", "properties": { "grid": { "type": "object", "properties": { "columns": { "type": "number", "description": "Number of columns in the grid." }, "rows": { "type": "number", "description": "Number of rows in the grid." }, "gap": { "type": "number", "description": "Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used." } } }, "tiles": { "type": "object", "properties": { "tile-id": { "type": "object", "description": "The Tile ID is used in the Flow Nodes to fill in this specific tile.", "properties": { "x": { "type": "number", "description": "The row number where the tile is located, starting from 1." }, "y": { "type": "number", "description": "The column number where the tile is located, starting from 1." }, "columns": { "type": "number", "description": "The number of columns the tile should occupy. The default value is 1." }, "rows": { "type": "number", "description": "The number of rows the tile should occupy. The default value is 1." } } } } } } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateAiCopilotConfig_2_0", "summary": "Update an Agent Copilot Configuration", "description": "Updates an existing Agent Copilot configuration in a Project. Allows modifying the grid layout, tiles, or metadata of a configuration. You must provide the relevant project ID and the configuration ID to apply changes.", "tags": [ "Agent Copilot Configurations" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "configId", "description": "The Id of the Ai Copilot config", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The human readable name of the config." }, "description": { "type": "string", "description": "The description which can be used to understand what the agent assist config contains in terms of tiles." }, "config": { "type": "object", "description": "The actual grid-config.", "properties": { "grid": { "type": "object", "properties": { "columns": { "type": "number", "description": "Number of columns in the grid." }, "rows": { "type": "number", "description": "Number of rows in the grid." }, "gap": { "type": "number", "description": "Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used." } } }, "tiles": { "type": "object", "properties": { "tile-id": { "type": "object", "description": "The Tile ID is used in the Flow Nodes to fill in this specific tile.", "properties": { "x": { "type": "number", "description": "The row number where the tile is located, starting from 1." }, "y": { "type": "number", "description": "The column number where the tile is located, starting from 1." }, "columns": { "type": "number", "description": "The number of columns the tile should occupy. The default value is 1." }, "rows": { "type": "number", "description": "The number of rows the tile should occupy. The default value is 1." } } } } } } } } } } } }, "responses": { "204": { "description": "The Agent Copilot Configuration was successfully updated." }, "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/aiagents": { "post": { "operationId": "createAiAgent_2_0", "summary": "Create an AI Agent", "description": "Creates an AI Agent in a Project. The request defines the AI Agent persona (name, description, avatar), behavioral instructions, speaking style, and safety settings. You can optionally link the AI Agent to a Knowledge Store, configure voice and text-to-speech settings, and control whether voice configurations are activated. The method returns the newly created AI Agent, including its unique ID and metadata such as creation timestamps and author information.", "tags": [ "AI Agents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Cognigy AI Agent" }, "image": { "type": "string", "description": "Avatar of the AI Agent.", "example": "https://cognigy.com/ai-agent.png" }, "imageOptimizedFormat": { "type": "boolean", "description": "Whether the optimized image format defined by Cognigy is used.", "example": true }, "knowledgeReferenceId": { "type": "string", "nullable": true, "format": "uuid", "description": "A referenceId of a Knowledge Store this Agent will use as base knowledge or null.", "example": "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b" }, "description": { "type": "string", "maxLength": 1000, "description": "A short description of the AI Agent, up to 1000 characters.", "example": "I am a virtual assistant that can help you with your questions." }, "speakingStyle": { "type": "object", "properties": { "completeness": { "type": "string" }, "formality": { "type": "string" } }, "example": { "completeness": "concise", "formality": "formal" } }, "voiceConfigs": { "type": "object", "properties": { "ttsVoice": { "type": "string" }, "ttsLanguage": { "type": "string" }, "ttsVendor": { "enum": [ "aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none" ], "type": "string" }, "ttsModel": { "type": "string" }, "ttsLabel": { "type": "string" }, "ttsDisableCache": { "type": "boolean" } }, "example": { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false } }, "enableVoiceConfigs": { "type": "boolean", "description": "Enables the use of voice configuration.", "example": false }, "enableAutoLanguageDetection": { "type": "boolean", "description": "Whether the AI Agent should automatically detect and respond in the user's language.", "example": true }, "safetySettings": { "type": "object", "properties": { "avoidHarmfulContent": { "type": "boolean" }, "avoidUngroundedContent": { "type": "boolean" }, "avoidCopyrightInfringements": { "type": "boolean" }, "preventJailbreakAndManipulation": { "type": "boolean" } } }, "contactProfilesOption": { "type": "string", "enum": [ "none", "selectedProfileFields", "completeProfile", "profileMemoriesOnly" ], "description": "Option to enable or customize Contact profiles selection for the AI Agent.", "example": "selectedProfileFields" }, "contactProfilesSelected": { "type": "array", "items": { "type": "string" }, "description": "Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.", "example": [ "name", "email" ] }, "instructions": { "type": "string", "description": "Instructions for the AI Agent.", "example": "I can help you with your questions, provide information and much more.", "maxLength": 1000 }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns the AI Agent object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Cognigy AI Agent" }, "image": { "type": "string", "description": "Avatar of the AI Agent.", "example": "https://cognigy.com/ai-agent.png" }, "imageOptimizedFormat": { "type": "boolean", "description": "Whether the optimized image format defined by Cognigy is used.", "example": true }, "knowledgeReferenceId": { "type": "string", "nullable": true, "format": "uuid", "description": "A referenceId of a Knowledge Store this Agent will use as base knowledge or null.", "example": "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b" }, "description": { "type": "string", "maxLength": 1000, "description": "A short description of the AI Agent, up to 1000 characters.", "example": "I am a virtual assistant that can help you with your questions." }, "speakingStyle": { "type": "object", "properties": { "completeness": { "type": "string" }, "formality": { "type": "string" } }, "example": { "completeness": "concise", "formality": "formal" } }, "voiceConfigs": { "type": "object", "properties": { "ttsVoice": { "type": "string" }, "ttsLanguage": { "type": "string" }, "ttsVendor": { "enum": [ "aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none" ], "type": "string" }, "ttsModel": { "type": "string" }, "ttsLabel": { "type": "string" }, "ttsDisableCache": { "type": "boolean" } }, "example": { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false } }, "enableVoiceConfigs": { "type": "boolean", "description": "Enables the use of voice configuration.", "example": false }, "enableAutoLanguageDetection": { "type": "boolean", "description": "Whether the AI Agent should automatically detect and respond in the user's language.", "example": true }, "safetySettings": { "type": "object", "properties": { "avoidHarmfulContent": { "type": "boolean" }, "avoidUngroundedContent": { "type": "boolean" }, "avoidCopyrightInfringements": { "type": "boolean" }, "preventJailbreakAndManipulation": { "type": "boolean" } } }, "contactProfilesOption": { "type": "string", "enum": [ "none", "selectedProfileFields", "completeProfile", "profileMemoriesOnly" ], "description": "Option to enable or customize Contact profiles selection for the AI Agent.", "example": "selectedProfileFields" }, "contactProfilesSelected": { "type": "array", "items": { "type": "string" }, "description": "Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.", "example": [ "name", "email" ] }, "instructions": { "type": "string", "description": "Instructions for the AI Agent.", "example": "I can help you with your questions, provide information and much more.", "maxLength": 1000 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexAiAiAgents_2_0", "summary": "Get AI Agents", "description": "Gets AI Agents from a Project. By default, returns 25 AI Agents from all Projects the user has access to. Use the `limit` query parameter to change the default value. Specify the Project ID to get AI Agents from a specific Project.", "tags": [ "AI Agents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "Filter records by specific field eg:name." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns an array of a AI agent objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Cognigy AI Agent" }, "image": { "type": "string", "description": "Avatar of the AI Agent.", "example": "https://cognigy.com/ai-agent.png" }, "imageOptimizedFormat": { "type": "boolean", "description": "Whether the optimized image format defined by Cognigy is used.", "example": true }, "knowledgeReferenceId": { "type": "string", "nullable": true, "format": "uuid", "description": "A referenceId of a Knowledge Store this Agent will use as base knowledge or null.", "example": "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b" }, "description": { "type": "string", "maxLength": 1000, "description": "A short description of the AI Agent, up to 1000 characters.", "example": "I am a virtual assistant that can help you with your questions." }, "speakingStyle": { "type": "object", "properties": { "completeness": { "type": "string" }, "formality": { "type": "string" } }, "example": { "completeness": "concise", "formality": "formal" } }, "voiceConfigs": { "type": "object", "properties": { "ttsVoice": { "type": "string" }, "ttsLanguage": { "type": "string" }, "ttsVendor": { "enum": [ "aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none" ], "type": "string" }, "ttsModel": { "type": "string" }, "ttsLabel": { "type": "string" }, "ttsDisableCache": { "type": "boolean" } }, "example": { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false } }, "enableVoiceConfigs": { "type": "boolean", "description": "Enables the use of voice configuration.", "example": false }, "enableAutoLanguageDetection": { "type": "boolean", "description": "Whether the AI Agent should automatically detect and respond in the user's language.", "example": true }, "safetySettings": { "type": "object", "properties": { "avoidHarmfulContent": { "type": "boolean" }, "avoidUngroundedContent": { "type": "boolean" }, "avoidCopyrightInfringements": { "type": "boolean" }, "preventJailbreakAndManipulation": { "type": "boolean" } } }, "contactProfilesOption": { "type": "string", "enum": [ "none", "selectedProfileFields", "completeProfile", "profileMemoriesOnly" ], "description": "Option to enable or customize Contact profiles selection for the AI Agent.", "example": "selectedProfileFields" }, "contactProfilesSelected": { "type": "array", "items": { "type": "string" }, "description": "Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.", "example": [ "name", "email" ] }, "instructions": { "type": "string", "description": "Instructions for the AI Agent.", "example": "I can help you with your questions, provide information and much more.", "maxLength": 1000 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/aiagents/{aiAgentId}": { "delete": { "operationId": "deleteAiAgent_2_0", "summary": "Delete an AI Agent", "description": "Deletes an AI Agent from a Project.", "tags": [ "AI Agents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "aiAgentId", "description": "The Id of the Ai Agent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The AI Agent was successfully deleted." }, "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": [] } ] }, "get": { "operationId": "readAiAgent_2_0", "summary": "Get an AI Agent", "description": "Gets an AI Agent from a Project. Returns the AI Agent configuration, including identity, description, avatar, instructions, speaking style, voice, safety settings, and metadata such as creation and modification timestamps.", "tags": [ "AI Agents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "aiAgentId", "description": "The Id of the Ai Agent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns AI agent object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Cognigy AI Agent" }, "image": { "type": "string", "description": "Avatar of the AI Agent.", "example": "https://cognigy.com/ai-agent.png" }, "imageOptimizedFormat": { "type": "boolean", "description": "Whether the optimized image format defined by Cognigy is used.", "example": true }, "knowledgeReferenceId": { "type": "string", "nullable": true, "format": "uuid", "description": "A referenceId of a Knowledge Store this Agent will use as base knowledge or null.", "example": "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b" }, "description": { "type": "string", "maxLength": 1000, "description": "A short description of the AI Agent, up to 1000 characters.", "example": "I am a virtual assistant that can help you with your questions." }, "speakingStyle": { "type": "object", "properties": { "completeness": { "type": "string" }, "formality": { "type": "string" } }, "example": { "completeness": "concise", "formality": "formal" } }, "voiceConfigs": { "type": "object", "properties": { "ttsVoice": { "type": "string" }, "ttsLanguage": { "type": "string" }, "ttsVendor": { "enum": [ "aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none" ], "type": "string" }, "ttsModel": { "type": "string" }, "ttsLabel": { "type": "string" }, "ttsDisableCache": { "type": "boolean" } }, "example": { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false } }, "enableVoiceConfigs": { "type": "boolean", "description": "Enables the use of voice configuration.", "example": false }, "enableAutoLanguageDetection": { "type": "boolean", "description": "Whether the AI Agent should automatically detect and respond in the user's language.", "example": true }, "safetySettings": { "type": "object", "properties": { "avoidHarmfulContent": { "type": "boolean" }, "avoidUngroundedContent": { "type": "boolean" }, "avoidCopyrightInfringements": { "type": "boolean" }, "preventJailbreakAndManipulation": { "type": "boolean" } } }, "contactProfilesOption": { "type": "string", "enum": [ "none", "selectedProfileFields", "completeProfile", "profileMemoriesOnly" ], "description": "Option to enable or customize Contact profiles selection for the AI Agent.", "example": "selectedProfileFields" }, "contactProfilesSelected": { "type": "array", "items": { "type": "string" }, "description": "Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.", "example": [ "name", "email" ] }, "instructions": { "type": "string", "description": "Instructions for the AI Agent.", "example": "I can help you with your questions, provide information and much more.", "maxLength": 1000 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateAiAgent_2_0", "summary": "Update an AI Agent", "description": "Updates an AI Agent in a Project. Allows modifying AI Agent persona, instructions, speaking style, voice, and safety settings. Returns no content on success", "tags": [ "AI Agents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "aiAgentId", "description": "The Id of the Ai Agent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Cognigy AI Agent" }, "image": { "type": "string", "description": "Avatar of the AI Agent.", "example": "https://cognigy.com/ai-agent.png" }, "imageOptimizedFormat": { "type": "boolean", "description": "Whether the optimized image format defined by Cognigy is used.", "example": true }, "knowledgeReferenceId": { "type": "string", "nullable": true, "format": "uuid", "description": "A referenceId of a Knowledge Store this Agent will use as base knowledge or null.", "example": "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b" }, "description": { "type": "string", "maxLength": 1000, "description": "A short description of the AI Agent, up to 1000 characters.", "example": "I am a virtual assistant that can help you with your questions." }, "speakingStyle": { "type": "object", "properties": { "completeness": { "type": "string" }, "formality": { "type": "string" } }, "example": { "completeness": "concise", "formality": "formal" } }, "voiceConfigs": { "type": "object", "properties": { "ttsVoice": { "type": "string" }, "ttsLanguage": { "type": "string" }, "ttsVendor": { "enum": [ "aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none" ], "type": "string" }, "ttsModel": { "type": "string" }, "ttsLabel": { "type": "string" }, "ttsDisableCache": { "type": "boolean" } }, "example": { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false } }, "enableVoiceConfigs": { "type": "boolean", "description": "Enables the use of voice configuration.", "example": false }, "enableAutoLanguageDetection": { "type": "boolean", "description": "Whether the AI Agent should automatically detect and respond in the user's language.", "example": true }, "safetySettings": { "type": "object", "properties": { "avoidHarmfulContent": { "type": "boolean" }, "avoidUngroundedContent": { "type": "boolean" }, "avoidCopyrightInfringements": { "type": "boolean" }, "preventJailbreakAndManipulation": { "type": "boolean" } } }, "contactProfilesOption": { "type": "string", "enum": [ "none", "selectedProfileFields", "completeProfile", "profileMemoriesOnly" ], "description": "Option to enable or customize Contact profiles selection for the AI Agent.", "example": "selectedProfileFields" }, "contactProfilesSelected": { "type": "array", "items": { "type": "string" }, "description": "Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.", "example": [ "name", "email" ] }, "instructions": { "type": "string", "description": "Instructions for the AI Agent.", "example": "I can help you with your questions, provide information and much more.", "maxLength": 1000 } } } } } }, "responses": { "204": { "description": "The AI Agent was successfully updated." }, "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/aiagents/{aiAgentId}/jobs": { "get": { "operationId": "getAiAgentJobAndTools_2_0", "summary": "Get AI Agent Jobs and their Tools", "description": "Gets all jobs and associated tools for an AI Agent by its ID.", "tags": [ "AI Agents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "aiAgentId", "description": "The Id of the Ai Agent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns an array of jobs, each with a `tools` array.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "referenceId": { "type": "string" }, "type": { "type": "string", "example": "aiAgentJob" }, "label": { "type": "string" }, "comment": { "type": "string" }, "commentColor": { "type": "string" }, "analyticsLabel": { "type": "string", "nullable": true }, "isDisabled": { "type": "boolean" }, "isEntryPoint": { "type": "boolean" }, "extension": { "type": "string" }, "config": { "type": "object", "description": "Job node configuration (content varies by implementation)" }, "tools": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "referenceId": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" }, "comment": { "type": "string" }, "commentColor": { "type": "string" }, "analyticsLabel": { "type": "string", "nullable": true }, "isDisabled": { "type": "boolean" }, "isEntryPoint": { "type": "boolean" }, "extension": { "type": "string" }, "config": { "type": "object", "description": "Tool node configuration (content varies by tool type)" } } } } } } } } } }, "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": "AI Agent not found in this project/organisation" }, "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/aiagents/hire": { "post": { "operationId": "hireAiAgent_2_0", "summary": "Hire an AI Agent from the Job Market", "description": "Hires an AI Agent in a Project using a ready-made template (`templateId`) with predefined skills for a specific job. You can optionally override an existing AI Agent using `overrideAiAgentReferenceId` to adapt it to your needs. The method returns a task tracking the status of the hiring process.", "tags": [ "AI Agents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "string", "description": "The ID of the AI Agent template to hire.", "example": "airline-support-agent-en" }, "overrideAiAgentReferenceId": { "type": "string", "description": "The reference ID of the AI Agent to override the AI Agent from the hired package.", "example": "5f7b1b1b-7b1b-4b1b-9b1b-7b1b1b1b1b1b" }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "202": { "description": "Successfully created a Task to hire the AI Agent.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/aiagents/hire/templates": { "get": { "operationId": "getAiAgentHiringTemplates_2_0", "summary": "Get AI Agents from the Job Market", "description": "Gets a list of AI Agents from the job market that are ready for hire.", "tags": [ "AI Agents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Returns available AI Agents for hire.", "content": { "application/json": { "schema": { "type": "object", "properties": { "templates": { "type": "array", "items": { "type": "object", "properties": { "templateId": { "type": "string", "description": "The ID of the AI Agent template to hire.", "example": "RetailAssistant-Rita" }, "aiAgentName": { "type": "string", "description": "The name of the AI Agent.", "example": "Rita" }, "aiAgentFileName": { "type": "string", "description": "The file name of the AI Agent.", "example": "Rita.tar" }, "aiAgentImage": { "type": "string", "description": "The image of the AI Agent.", "example": "https://cognigy.com/rita.png" }, "aiAgentDescription": { "type": "string", "description": "A short description of the AI Agent, up to 1000 characters.", "example": "I am a virtual assistant that can help you with your questions." } } } } } } } } }, "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/aiagents/validatename": { "post": { "operationId": "validateAiAgentName_2_0", "summary": "Check AI Agent Name Availability", "description": "Checks whether an AI Agent name is already used in a Project.", "tags": [ "AI Agents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name to validate if it exists in the Project." }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "The AI Agent name can be used." }, "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 AI Agent name can't be used as it is already being used." }, "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": [] } ] } }, "/external/alexa/skills/{skillId}/deploy": { "post": { "operationId": "deployAlexaEndpoint_2_0", "summary": "Deploy an Alexa Endpoint to an Alexa Skill", "description": "Deploys a Cognigy.AI Alexa Endpoint to an Alexa skill.", "tags": [ "Alexa" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "skillId", "description": "The Id of the Alexa-Skill", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "URLToken": { "type": "string" } } } } } }, "responses": { "204": { "description": "Successfully deployed the Endpoint" }, "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/external/alexa/skills": { "get": { "operationId": "getAlexaSkills_2_0", "summary": "Get Alexa Skills", "description": "Gets a list of all Alexa skills associated with the current user, including details like skill ID, name per locale, last update, and lifecycle stage.", "tags": [ "Alexa" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Returns all the Alexa skills", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } } } } } }, "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/external/alexa/users": { "post": { "operationId": "createAuthenticatedAmazonUser_2_0", "summary": "Create an Amazon User", "description": "Creates an authenticated Amazon user by submitting their access token and refresh token. This method enables secure integration with Amazon Alexa services for the current Cognigy.AI user.", "tags": [ "Alexa" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accessToken": { "type": "string" }, "refreshToken": { "type": "string" } } } } } }, "responses": { "204": { "description": "Successfully created AmazonUser" }, "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/external/alexa/users/me": { "delete": { "operationId": "deleteAmazonAccount_2_0", "summary": "Delete an Amazon User", "description": "Deletes an already registered Amazon user from the Cognigy.AI platform.", "tags": [ "Alexa" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "204": { "description": "The Amazon user was successfully deleted." }, "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": [] } ] }, "get": { "operationId": "getAmazonAccount_2_0", "summary": "Get Amazon User Details", "description": "Gets details about an already registered Amazon user.", "tags": [ "Alexa" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Returns the data of the Amazon-Account", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "description": "The userId of the amazon user in the platform." }, "accessToken": { "type": "string", "description": "The user's access token that allows platform to make requests to Amazon." }, "refreshToken": { "type": "string", "description": "A refresh token that is used to generate a new access token refresh token pair." } } } } } }, "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/analytics": { "patch": { "operationId": "updateAnalyticsRecords_2_0", "summary": "Update an Analytics Record", "description": "Updates an analytics record for a specific user input. Allows modifying conversation properties, Flow and Intent details, ratings, handover information, Slots, tracked goals, and custom fields.", "tags": [ "Analytics" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "projectId": { "type": "string" }, "sessionId": { "type": "string" }, "inputId": { "type": "string" }, "properties": { "anyOf": [ { "type": "object", "properties": { "state": { "type": "string" }, "mode": { "type": "string" }, "userType": { "type": "string" }, "channel": { "type": "string" }, "flowLanguage": { "type": "string" }, "intent": { "type": "string" }, "intentScore": { "type": "number" }, "intentFlow": { "type": "string" }, "flowName": { "type": "string" }, "inHandoverRequest": { "type": "boolean" }, "inHandoverConversation": { "type": "boolean" }, "localeName": { "type": "string" }, "rating": { "type": "number" }, "ratingComment": { "type": "string" }, "entrypointType": { "type": "string" }, "trackedGoals": { "type": "array", "items": { "type": "string" } }, "endpointName": { "type": "string" }, "endpointUrlToken": { "type": "string" }, "handoverEscalations": { "type": "number" }, "snapshotName": { "type": "string" }, "slots": { "type": "object" }, "custom1": { "type": "string" }, "custom2": { "type": "string" }, "custom3": { "type": "string" }, "custom4": { "type": "string" }, "custom5": { "type": "string" }, "custom6": { "type": "string" }, "custom7": { "type": "string" }, "custom8": { "type": "string" }, "custom9": { "type": "string" }, "custom10": { "type": "string" } } } ] } } }, "example": { "contactId": "contactId", "projectId": "projectId", "sessionId": "sessionId", "inputId": "inputId", "properties": { "state": "state", "mode": "mode", "userType": "user userType", "channel": "channel", "flowLanguage": "new flowLanguage", "intent": "new intent", "intentFlow": "new intentFlow", "intentScore": 0, "flowName": "new flowName", "inHandoverRequest": false, "inHandoverConversation": false, "localeName": "new localeName", "rating": 9, "ratingComment": "new ratingComment", "entrypointType": "new entrypointType", "endpointName": "new endpointName", "endpointUrlToken": "new endpointUrlToken", "handoverEscalations": 2, "snapshotName": "new snapshotName", "slots": "new slots", "custom1": "new custom1", "custom2": "new custom2", "custom3": "new custom3", "custom4": "new custom4", "custom5": "new custom5", "custom6": "new custom6", "custom7": "new custom7", "custom8": "new custom8", "custom9": "new custom9", "custom10": "new custom10" } } } } }, "responses": { "204": { "description": "Successfully updated the Analytics Record" }, "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/analytics/{projectId}": { "delete": { "operationId": "deleteAnalyticsRecords_2_0", "summary": "Delete Analytics Records", "description": "Deletes analytics records for a Project.", "tags": [ "Analytics" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactIds": { "type": "array", "nullable": true, "items": { "type": "string" } }, "timestampStart": { "type": "string", "example": "2020-01-01T00:00:00Z" }, "timestampEnd": { "type": "string", "example": "2020-01-31T23:59:00Z" } } } } } }, "responses": { "202": { "description": "Accepts the Request to Delete Analytics Records." }, "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/callcounter": { "get": { "operationId": "getCallCounterOrganisation_2_0", "summary": "Get Call Counter Metrics for the Organization", "description": "Gets call counter metrics for the organization.", "deprecated": true, "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "The call counter stats for the given time-frame.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "calls": { "type": "number" }, "duration": { "type": "number" }, "concurrentCalls": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" } } } } } } } } }, "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/conversationcounter": { "get": { "operationId": "getConversationCounterOrganisation_2_0", "summary": "Get Conversation Counter Metrics for the Organization", "description": "Gets conversation counter metrics for the organization.", "deprecated": true, "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } }, { "in": "query", "name": "nonConversational", "required": false, "description": "Deprecated. Please no longer use this parameter. Use channel=nonConversational instead.", "schema": { "type": "boolean" } }, { "in": "query", "name": "channel", "required": false, "description": "As of release 4.96, conversations can be filtered by specific channels like \"webchat2\". Previously, \"webchat2\" conversations were aggregated under \"realtime\" and could not be individually filtered.", "schema": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] } } ], "responses": { "200": { "description": "The conversation counter stats for the given time-frame.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "conversations": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "channel": { "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/knowledgequerycounter": { "get": { "operationId": "getKnowledgeQueryCounterOrganisation_2_0", "summary": "Get Knowledge Query Counter Metrics for an Organization.", "description": "Gets knowledge query counter metrics for the organization.", "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "The knowledge query counter stats for the given time-frame.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "queries": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" } } } } } } } } }, "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}/callcounter": { "get": { "operationId": "getCallCounter_2_0", "summary": "Get Call Counter Metrics for a Project", "description": "Gets call counter metrics for a Project by its ID.", "deprecated": true, "tags": [ "Analytics" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "The call counter stats for the given time-frame.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "calls": { "type": "number" }, "duration": { "type": "number" }, "concurrentCalls": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" } } } } } } } } }, "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}/conversationcounter": { "get": { "operationId": "getConversationCounter_2_0", "summary": "Get Conversation Counter Metrics for a Project", "description": "Gets conversation counter metrics for a Project by its ID.", "deprecated": true, "tags": [ "Analytics" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } }, { "in": "query", "name": "nonConversational", "required": false, "description": "Deprecated. Please no longer use this parameter. Use channel=nonConversational instead.", "schema": { "type": "boolean" } }, { "in": "query", "name": "channel", "required": false, "description": "As of release 4.96, conversations can be filtered by specific channels like \"webchat2\". Previously, \"webchat2\" conversations were aggregated under \"realtime\" and could not be individually filtered.", "schema": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] } } ], "responses": { "200": { "description": "The conversation counter stats for the given time-frame.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "conversations": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "channel": { "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}/knowledgequerycounter": { "get": { "operationId": "getKnowledgeQueryCounter_2_0", "summary": "Get Knowledge Query Counter Metrics for a Project.", "description": "Gets knowledge query counter metrics for a Project by its ID.", "tags": [ "Analytics" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "The knowlege query counter stats for the given time-frame.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "queries": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" } } } } } } } } }, "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": [] } ] } }, "/v3.0/callcounter": { "get": { "operationId": "getCallCounterOrganisation_3_0", "summary": "Get Call Counter Metrics for the Organization", "description": "Gets call counter metrics for the organization. Data is available up to two days ago, and only for 2025 onwards.", "tags": [ "Analytics 3.0" ], "parameters": [ { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "The call counter stats for the given time-frame.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "maxConcurrency": { "type": "number" }, "callMinutes": { "type": "number" }, "processedCalls": { "type": "number" }, "billableCalls": { "type": "number" } } } } } } } } }, "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": [] } ] } }, "/v3.0/conversationcounter": { "get": { "operationId": "getConversationCounterOrganisation_3_0", "summary": "Get Conversation Counter Metrics for the Organization", "description": "Gets conversation counter metrics for the organization. Data is available up to one day ago, and only for 2025 onwards.", "tags": [ "Analytics 3.0" ], "parameters": [ { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } }, { "in": "query", "name": "nonConversational", "required": false, "description": "Deprecated. Please no longer use this parameter. Use channel=nonConversational instead.", "schema": { "type": "boolean" } }, { "in": "query", "name": "channel", "required": false, "description": "As of release 4.96, conversations can be filtered by specific channels like \"webchat2\". Previously, \"webchat2\" conversations were aggregated under \"realtime\" and could not be individually filtered.", "schema": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] } } ], "responses": { "200": { "description": "The conversation counter stats for the given time-frame.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "conversations": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "perChannel": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string" }, "conversations": { "type": "number" } } } } } } } } } } } }, "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": [] } ] } }, "/v3.0/projects/{projectId}/callcounter": { "get": { "operationId": "getCallCounter_3_0", "summary": "Get Call Counter Metrics for a Project", "description": "Gets call counter metrics for a Project by its ID. Data is available up to two days ago, and only for 2025 onwards.", "tags": [ "Analytics 3.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "The call counter stats for the given time-frame.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "maxConcurrency": { "type": "number" }, "callMinutes": { "type": "number" }, "processedCalls": { "type": "number" }, "billableCalls": { "type": "number" } } } } } } } } }, "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": [] } ] } }, "/v3.0/projects/{projectId}/conversationcounter": { "get": { "operationId": "getConversationCounter_3_0", "summary": "Get Conversation Counter Metrics for a Project", "description": "Gets conversation counter metrics for a Project by its ID. Data is available up to one day ago, and only for 2025 onwards.", "tags": [ "Analytics 3.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "year", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "month", "required": false, "schema": { "type": "number" } }, { "in": "query", "name": "nonConversational", "required": false, "description": "Deprecated. Please no longer use this parameter. Use channel=nonConversational instead.", "schema": { "type": "boolean" } }, { "in": "query", "name": "channel", "required": false, "description": "As of release 4.96, conversations can be filtered by specific channels like \"webchat2\". Previously, \"webchat2\" conversations were aggregated under \"realtime\" and could not be individually filtered.", "schema": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] } } ], "responses": { "200": { "description": "The conversation counter stats for the given time-frame.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "conversations": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "perChannel": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string" }, "conversations": { "type": "number" } } } } } } } } } } } }, "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/auditevents": { "get": { "operationId": "indexAuditEvents_2_0", "summary": "Get Audit Events", "description": "Gets audit events for the organization. By default, 25 audit events are returned. Use the `limit` query parameter to change this value.", "tags": [ "Audit Events" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 user or type to filter the records" }, { "in": "query", "name": "user", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "type", "required": false, "schema": { "type": "string", "enum": [ "action", "create", "replace", "patch", "delete", "authentication", "authorization" ] } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of audit event metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp when the action happened", "example": "2020-04-27T14:22:11.000Z" }, "type": { "type": "string", "description": "The type of operation that was performed", "example": "create", "enum": [ "action", "create", "replace", "patch", "delete", "authentication", "authorization" ] }, "user": { "type": "string", "description": "The email of the user who performed the operation", "example": "hans.mustermann@xyz.com" }, "modifiedResources": { "type": "array", "description": "A list of resources in the chain of the modification", "items": { "type": "object", "properties": { "elementId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "elementType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "aiAgent", "agentassistconfig", "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "handoverProvider", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "knowledgeStore", "largeLanguageModel", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "goal", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "simulation", "aicopilotconfig", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "trainerRecord", "user", "yesNoIntent" ] } } } } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/auditevents/{auditEventId}": { "get": { "operationId": "readAuditEvent_2_0", "summary": "Get an Audit Event", "description": "Gets an audit event by its ID.", "tags": [ "Audit Events" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "auditEventId", "schema": { "type": "string" }, "required": true, "description": "Audit event ID" } ], "responses": { "200": { "description": "Returns audit event object", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "description": "The timestamp when the action happened", "example": "2020-04-27T14:22:11.000Z" }, "type": { "type": "string", "description": "The type of operation that was performed", "example": "create", "enum": [ "action", "create", "replace", "patch", "delete", "authentication", "authorization" ] }, "user": { "type": "string", "description": "The email of the user who performed the operation", "example": "hans.mustermann@xyz.com" }, "modifiedResources": { "type": "array", "description": "An list of resources in the chain of the modification", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "description": "The id of the resource in the modification chain", "example": "5e997f0cdcfc57730cf32941" }, "resourceType": { "type": "string", "description": "Additional resource types for audit purposes", "example": "node", "enum": [ "aiAgent", "agentassistconfig", "agentSettings", "chart", "connection", "connectionSchema", "endpoint", "extension", "file", "flow", "flowSettings", "flowState", "function", "handoverProvider", "intent", "intentDefaultReply", "intentLearningSentence", "intentRelation", "intentSentence", "intentTrainGroup", "knowledgeStore", "largeLanguageModel", "lexicon", "lexiconEntry", "lexiconKeyphrase", "lexiconSlot", "locale", "goal", "nluconnector", "nodeData", "nodeDescriptorSet", "package", "playbook", "slotFiller", "snapshot", "snippet", "simulation", "aicopilotconfig", "apiKey", "analytics", "connectionField", "conversation", "examplesentence", "functionInstance", "keyphrase", "learningsentence", "node", "playbookStep", "playbookStepAssert", "profile", "profileSchema", "project", "projectsettings", "synonym", "tag", "task", "trainerRecord", "user", "yesNoIntent" ] } } } }, "payload": { "type": "object", "description": "The raw payload of the operation in case it was tracked", "example": { "name": "new resource name" } } } } } } }, "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/connections": { "patch": { "operationId": "batchConnections_2_0", "summary": "Perform Batch Operations on Connections", "description": "Performs batch operations on Connections. Executes batch create, update, and delete operations, returning the affected Connection IDs.", "tags": [ "Connections" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "properties": { "name": { "type": "string", "example": "some name" }, "isDeprecated": { "type": "boolean", "description": "Marked 'true' if the connection type is deprecated" }, "type": { "type": "string", "example": "http_basic" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "fields": { "type": "object", "description": "The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.", "minProperties": 1, "maxProperties": 10, "example": { "some-key-from-connection-schema": "x123sdfu12312" } } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "properties": { "fields": { "type": "object", "description": "The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.", "minProperties": 1, "maxProperties": 10, "example": { "some-key-from-connection-schema": "x123sdfu12312" } } } } } } ] } } } } } } }, "responses": { "200": { "description": "Batch operations completed successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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": [] } ] }, "post": { "operationId": "createConnection_2_0", "summary": "Create a Connection", "description": "Creates a Connection in a Project.", "tags": [ "Connections" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "name": { "type": "string", "example": "some name" }, "isDeprecated": { "type": "boolean", "description": "Marked 'true' if the connection type is deprecated" }, "type": { "type": "string", "example": "http_basic" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "fields": { "type": "object", "description": "The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.", "minProperties": 1, "maxProperties": 10, "example": { "some-key-from-connection-schema": "x123sdfu12312" } }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "name": { "type": "string", "example": "some name" }, "isDeprecated": { "type": "boolean", "description": "Marked 'true' if the connection type is deprecated" }, "type": { "type": "string", "example": "http_basic" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "fields": { "type": "object", "description": "The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.", "minProperties": 1, "maxProperties": 10, "example": { "some-key-from-connection-schema": "x123sdfu12312" } }, "resourceLevel": { "type": "string", "enum": [ "organisation", "project" ], "description": "General scope of the resource.", "default": "project" } } } ], "description": "Either `projectId` or `resourceLevel: organization` must be present in the request body.\n" } } } }, "responses": { "201": { "description": "Returns Connection metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the connection field. The key should match the connection schema of the specific connection type.", "example": "some-key-from-connection-schema" }, "value": { "type": "string", "description": "The value of the connection field", "example": "x123w123" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexConnections_2_0", "summary": "Get Connections", "description": "Gets Connections from a Project. By default, 25 Connections are returned. To change this value, use the `limit` query parameter.", "tags": [ "Connections" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the connection to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "query", "name": "resourceLevel", "description": "Scope of the resource (global \"organisation\" or project).", "required": false, "schema": { "type": "string", "enum": [ "organisation", "project" ], "description": "General scope of the resource.", "default": "project" } } ], "responses": { "200": { "description": "Returns an array of Connection metadata objects.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "referenceId": { "type": "string", "description": "The reference id of the Connection", "example": "0f7b5514-e7a5-4947-ae44-7519a23c7403" }, "name": { "type": "string", "description": "The name of the Connection", "example": "azure" }, "isDeprecated": { "type": "boolean", "description": "Marked 'true' if the connection type is deprecated" }, "connectionSchema": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package-name of the extension." }, "type": { "type": "string", "description": "The type of connection." } } }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/connections/{connectionId}": { "delete": { "operationId": "deleteConnection_2_0", "summary": "Delete a Connection", "description": "Deletes a Connection from a Project. Deleting a Connection stops any dependent features from working. Flows that use the deleted Connection aren't updated automatically and may hang at the affected Node, causing errors.", "tags": [ "Connections" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "connectionId", "description": "The Id of the Connection", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The Connection was deleted successfully." }, "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": [] } ] }, "get": { "operationId": "readConnection_2_0", "summary": "Get a Connection", "description": "Gets a Connection from a Project.", "tags": [ "Connections" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "connectionId", "description": "The Id of the Connection", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the Connection object", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the connection field. The key should match the connection schema of the specific connection type.", "example": "some-key-from-connection-schema" }, "value": { "type": "string", "description": "The value of the connection field", "example": "x123w123" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateConnection_2_0", "summary": "Update a Connection", "description": "Updates a Connection in a Project, including type, credential and custom fields.", "tags": [ "Connections" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "connectionId", "description": "The Id of the Connection", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "description": "The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.", "minProperties": 1, "maxProperties": 10, "example": { "some-key-from-connection-schema": "x123sdfu12312" } } } } } } }, "responses": { "204": { "description": "Successfully updated Flow" }, "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/connections/{connectionId}/fields": { "post": { "operationId": "createConnectionField_2_0", "summary": "Create a Connection Field", "description": "Creates a Connection field, allowing you to store additional key-value data in a Connection. This method is useful for adding custom settings required by external services or integrations.", "tags": [ "Connections" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "connectionId", "description": "The Id of the Connection", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the connection field. The key should match the connection schema of the specific connection type.", "example": "some-key-from-connection-schema" }, "value": { "type": "string", "description": "The value of the connection field", "example": "x123w123" } } } } } }, "responses": { "201": { "description": "The connection field was created." }, "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/connections/{connectionId}/fields/{fieldName}": { "delete": { "operationId": "deleteConnectionField_2_0", "summary": "Delete a Connection Field", "description": "Deletes a Connection field, removing the associated key-value data from a Connection. This method is useful for removing unused or sensitive data from a Connection.", "tags": [ "Connections" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "connectionId", "description": "The Id of the Connection", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "fieldName", "description": "The name of the Connection field", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The Connection field was deleted successfully." }, "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/connections/schemas": { "get": { "operationId": "indexConnectionSchemas_2_0", "summary": "Get Connection Schemas", "description": "Gets Connection schemas from a Project. This method helps understand the structure and fields for creating or validating Connections. By default, 25 schemas are returned. Use the `limit` query parameter to change this value.", "tags": [ "Connections" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The type, label, or extension of the Connection Schema to filter the records." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns an array of Connection schemas.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "extension": { "type": "string", "description": "The package name of the extension this schema was found", "example": "azure" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/profiles": { "post": { "operationId": "createProfile_2_0", "summary": "Create a Contact Profile", "description": "Creates a [Contact Profile](https://docs.cognigy.com/ai/agents/analyze/contact-profiles).", "tags": [ "Contact Profiles" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns Profile object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexProfiles_2_0", "summary": "Get Contact Profiles", "description": "Gets [Contact Profiles](https://docs.cognigy.com/ai/agents/analyze/contact-profiles) in a Project. By default, 25 Contact Profiles are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Contact Profiles" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The contactIds, firstname, lastName or email of the profile to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a Profile metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "type": { "type": "string", "enum": [ "simulator" ] }, "contactIds": { "type": "array", "items": { "type": "string" } }, "lastChanged": { "type": "number" }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/profiles/{profileId}": { "delete": { "operationId": "deleteProfile_2_0", "summary": "Delete a Contact Profile", "description": "Deletes a [Contact Profile](https://docs.cognigy.com/ai/agents/analyze/contact-profiles).", "tags": [ "Contact Profiles" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "profileId", "description": "The Id of the Profile", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted Profile" }, "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": [] } ] }, "get": { "operationId": "readProfile_2_0", "summary": "Get a Contact Profile", "description": "Gets the data of a [Contact Profile](https://docs.cognigy.com/ai/agents/analyze/contact-profiles).", "tags": [ "Contact Profiles" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "profileId", "description": "The Id of the Profile", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Profile Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateProfile", "summary": "Update a Contact Profile", "description": "Updates Contact Profile data.", "tags": [ "Contact Profiles" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "profileId", "description": "The Id of the Profile", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } } } } } } }, "responses": { "204": { "description": "Successfully updated Profile" }, "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/profiles/{profileId}/contactids/remove": { "post": { "operationId": "removeContactIdFromProfile_2_0", "summary": "Remove the Contact ID", "description": "Removes the contact ID from a Contact Profile.", "tags": [ "Contact Profiles" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "profileId", "description": "The Id of the Profile", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" } } } } } }, "responses": { "204": { "description": "Successfully deleted Conversations" }, "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/profiles/{profileId}/data/export": { "post": { "operationId": "exportProfileData_2_0", "summary": "Export Contact Profile", "description": "Exports Contact Profile data in JSON format.", "tags": [ "Contact Profiles" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "profileId", "description": "The Id of the Profile", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns all profile data", "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "contactInput": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "sessionId": { "type": "string", "example": "f84324f4-98eb-4f02-abdd-375a2e6c3c1f" }, "inputText": { "type": "string", "example": "Hi, my name is Max." }, "timestamp": { "type": "string", "format": "date-time" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] } } } } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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/profiles/{profileId}/data/remove": { "post": { "operationId": "removeProfileData_2_0", "summary": "Delete Contact Profile Data", "description": "Deletes data associated with a Contact Profile.", "tags": [ "Contact Profiles" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "profileId", "description": "The Id of the Profile", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted Data" }, "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/profiles/{profileId}/merge": { "post": { "operationId": "mergeProfiles_2_0", "summary": "Merge Contact Profiles", "description": "Merges a [Contact Profile](https://docs.cognigy.com/ai/agents/analyze/contact-profiles) with another one.", "tags": [ "Contact Profiles" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "projectId": { "type": "string" } } } } } }, "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "profileId", "description": "The Id of the Profile", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully merged Profiles" }, "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/profiles/{profileId}/unmerge": { "post": { "operationId": "unmergeProfiles_2_0", "summary": "Unmerge Contact Profiles", "description": "Splits a merged [Contact Profile](https://docs.cognigy.com/ai/agents/analyze/contact-profiles) into two separate ones.", "tags": [ "Contact Profiles" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" } } } } } }, "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "profileId", "description": "The Id of the Profile", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Successfully unmerged Profiles" }, "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/profiles/schema/{projectId}": { "get": { "operationId": "getProfileSchema_2_0", "summary": "Get Schema", "description": "Gets the [Contact Profile schema](https://docs.cognigy.com/ai/agents/analyze/contact-profiles#profile-schema).", "tags": [ "Contact Profiles" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Profile schema object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "prevent_data_collection": { "type": "boolean" }, "accepted_gdpr": { "type": "boolean" }, "privacy_policy": { "type": "object" }, "tasks": { "type": "array", "items": { "type": "string", "example": "buyer" } }, "memories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the memory", "example": "123456" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of when the memory was created", "example": "2024-09-23T08:37:00Z" }, "text": { "type": "string", "description": "The text content of the memory", "example": "This is a memory." } } }, "description": "Array of memories associated with the profile." }, "firstname": { "type": "string", "example": "Max" }, "lastname": { "type": "string", "example": "Mustermann" }, "email": { "type": "string", "format": "email" }, "profilepic": { "type": "string", "example": "" } } }, "active": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "example": "mail@example.com" } } } } } } }, "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": [] } ] }, "put": { "operationId": "setProfileSchema_2_0", "summary": "Set Schema", "description": "Sets the [Contact Profile schema](https://docs.cognigy.com/ai/agents/analyze/contact-profiles#profile-schema).", "tags": [ "Contact Profiles" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "internal": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "object", "number", "boolean" ] } } } } } } } } }, "responses": { "204": { "description": "Successfully updated the Schema." }, "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/conversations": { "get": { "operationId": "indexConversations_2_0", "summary": "Get Conversations", "description": "Gets conversations from a Project. You can also get conversations for a specific user by specifying their contact ID.", "tags": [ "Conversations" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "contactIds", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Returns an array of conversations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "contactId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectName": { "type": "string" }, "flowName": { "type": "string" }, "messages": { "type": "integer" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "ratings": { "type": "array", "items": { "type": "number" } }, "ratingComments": { "type": "array", "items": { "type": "string" } }, "endpointName": { "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/conversations/{sessionId}": { "delete": { "operationId": "deleteConversation_2_0", "summary": "Deletes a Conversation", "description": "Deletes a conversation by its `sessionId`.\n**Deprecated.** Use the Insights API [DELETE /v2.1/conversations/{sessionId}](#delete-/v2.1/conversations/-sessionId-) instead.\n", "deprecated": true, "tags": [ "Conversations" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "sessionId", "description": "The Id of the Session", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Deletes a conversation." }, "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": [] } ] }, "get": { "operationId": "readConversation_2_0", "summary": "Get a Conversation", "description": "Gets a conversation by its `sessionId`.", "tags": [ "Conversations v2.0" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sessionId", "description": "The Id of the Session", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expertMode", "schema": { "type": "boolean" }, "description": "expertMode on or off e.g. expertMode=true" } ], "responses": { "200": { "description": "Returns a conversation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectName": { "type": "string" }, "inputId": { "type": "string" }, "sessionId": { "type": "string" }, "contactId": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inputText": { "type": "string" }, "inputData": { "type": "object" }, "type": { "type": "string", "example": "user", "enum": [ "input", "output" ] }, "source": { "type": "string", "example": "user", "enum": [ "user", "bot", "agent", "suggestion" ] }, "flowName": { "type": "string" }, "flowReferenceId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "timestamp": { "type": "object" }, "inHandoverRequest": { "type": "boolean" }, "inHandoverConversation": { "type": "boolean" }, "outputId": { "type": "string" }, "expiresAt": { "type": "object" }, "endpointUrlToken": { "type": "string" }, "endpointName": { "type": "string" }, "localeReferenceId": { "type": "string" }, "localeName": { "type": "string" }, "snapshotId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "snapshotName": { "type": "string" }, "rating": { "type": "number" }, "ratingComment": { "type": "string" } } } }, "total": { "type": "integer" } } } } } }, "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/conversations/{sessionId}": { "delete": { "operationId": "deleteConversationsBySession_2_1", "summary": "Deletes conversations records for a sessionId.", "description": "Deletes conversations records for a sessionId.", "tags": [ "Conversations v2.1" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "sessionId", "description": "Filter by sessionId", "required": true, "schema": { "type": "string", "format": "mongo-id" } }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Accepts the request to delete conversations records." }, "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/endpoint/inject": { "post": { "operationId": "inject_2_0", "summary": "Send a Message as a User Input", "description": "Sends a message as a user input in an active conversation, so an AI Agent can process the input and continue the conversation. For example, to follow up after user inactivity or trigger a reply after an external API event. **Deprecated.** This v2.0 endpoint will be removed in a future release; please use the `/inject/{URLToken}` in Endpoint Service", "deprecated": true, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "text", "data", "URLToken", "sessionId" ], "properties": { "userId": { "type": "string", "format": "email", "example": "user@example.com" }, "text": { "type": "string", "example": "inject text" }, "data": { "type": "object" }, "URLToken": { "type": "string", "example": "endpoint-url-token" }, "sessionId": { "type": "string", "example": "your-session-id" } } } } } }, "responses": { "200": { "description": "Returns success message.", "content": { "text/html": { "examples": { "response": { "value": "Message was sent to AI for Flow processing" } } } } }, "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/endpoint/notify": { "post": { "operationId": "notify_2_0", "summary": "Send a Message as an AI Agent Output", "description": "Sends a message as an AI Agent Output. It bypasses the Flow's input processing and delivers a message to the user. For example, sending `Your order 12345 has shipped` as a status update. **Deprecated.** This v2.0 endpoint will be removed in a future release; please use the `/notify/{URLToken}` in Endpoint Service", "deprecated": true, "tags": [ "Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "text", "data", "URLToken" ], "properties": { "userId": { "type": "string", "format": "email", "example": "user@example.com" }, "text": { "type": "string", "example": "inject text" }, "data": { "type": "object" }, "attachments": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "file", "document" ] } }, "required": [ "name", "url", "type" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "image" ] } }, "required": [ "name", "url", "type" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "video" ] } }, "required": [ "name", "url", "type" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "audio" ] } }, "required": [ "name", "url", "type" ] }, { "type": "object", "properties": { "name": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string", "enum": [ "sticker" ] } }, "required": [ "name", "url", "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "contact" ] }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "countryCode": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "type": { "type": "string", "enum": [ "HOME", "WORK" ] }, "zip": { "type": "string" }, "postOfficeBox": { "type": "string" }, "extendedAddress": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" } } } }, "birthday": { "type": "string" }, "emails": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string", "enum": [ "HOME", "WORK" ] } } } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string", "enum": [ "HOME", "WORK" ] } } } }, "photos": { "type": "array", "items": { "type": "string" } }, "gender": { "type": "string" }, "languages": { "type": "array", "items": { "type": "string" } }, "timeZone": { "type": "string" }, "notes": { "type": "array", "items": { "type": "string" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "location" ] }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "name": { "type": "string" }, "title": { "type": "string" }, "address": { "type": "string" } }, "required": [ "type", "latitude", "longitude" ] } ] } }, "URLToken": { "type": "string", "example": "endpoint-url-token" }, "sessionId": { "type": "string", "example": "your-session-id" } } } } } }, "responses": { "200": { "description": "Returns success message.", "content": { "text/html": { "examples": { "response": { "value": "Sucessfully sent message to user" } } } } }, "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/endpoints": { "patch": { "operationId": "batchEndpoints_2_0", "summary": "Perform Batch Operations on Endpoints", "description": "Performs batch operations on Endpoints in a Project. Use this method to create, update, or delete multiple Endpoints in a request by specifying the operation type (`create`, `update`, or `delete`) for each item in the operations array.", "tags": [ "Endpoints" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "properties": { "foreignId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "entrypoint": { "type": "string", "description": "The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.", "example": "667ed4ae16d66f47dc2a9400" }, "active": { "type": "boolean", "description": "Toggle whether the endpoint is active or not" }, "nluConnectorId": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, { "type": "string" } ] }, "useConversations": { "type": "boolean", "description": "Whether to collect conversations history for this endpoint" }, "maskIPAddress": { "type": "boolean", "description": "Whether to mask sensitive IP address in input object and analytics data for this endpoint" }, "maskAnalytics": { "type": "boolean", "description": "Whether to mask sensitive data in analytics for this endpoint" }, "maskLogging": { "type": "boolean", "description": "Whether to mask sensitive data in logs for this endpoint" }, "useContactProfiles": { "type": "boolean", "description": "Whether to use contact profiles for this endpoint" }, "useAnalytics": { "type": "boolean", "description": "Whether we should store analytics for this endpoint" }, "useDashbotAnalytics": { "type": "boolean", "description": "Whether we should use Dashbot to collect analytics" }, "dashbotApikey": { "type": "string", "description": "The apikey for the dashbot bot" }, "dashbotPlatform": { "type": "string" }, "disableInputSanitization": { "type": "string", "description": "If true, disables input text sanitization after Input Transformer" }, "disableSkipUriTags": { "type": "string", "description": "If true, disables skipping of uri tags" }, "overrideSnapshotConnections": { "type": "boolean" }, "settings": { "type": "object", "properties": { "accessScope": { "type": "string" }, "accessToken": { "type": "string" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "basicAuthPassword": { "type": "string" }, "basicAuthUser": { "type": "string" }, "botUserId": { "type": "string" }, "businessHours": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" }, "weekDay": { "type": "string" } } } }, "enabled": { "type": "boolean" }, "text": { "type": "string" }, "mode": { "type": "string" }, "timeZone": { "type": "string" }, "title": { "type": "string" } } }, "colorScheme": { "type": "string" }, "connectionName": { "type": "string" }, "customJSON": { "type": "string" }, "designTemplate": { "type": "integer" }, "disableHtmlContentSanitization": { "type": "boolean" }, "disableInputAutocomplete": { "type": "boolean" }, "disableInputAutogrow": { "type": "boolean" }, "disableUrlButtonSanitization": { "type": "boolean" }, "enableGenericHTMLStyling": { "type": "boolean" }, "enableAsyncCommunication": { "type": "boolean" }, "engagementMessageText": { "type": "string" }, "displayGetStartedButton": { "type": "boolean" }, "dynamicImageAspectRatio": { "type": "boolean" }, "enableCollectMetadata": { "type": "boolean" }, "enableConnectionStatusIndicator": { "type": "boolean" }, "enableDemoWebchat": { "type": "boolean" }, "enableFileUpload": { "type": "boolean" }, "enablePersistentMenu": { "type": "boolean" }, "enableRating": { "type": "string", "enum": [ "onRequest", "always", "once" ] }, "enableSTT": { "type": "boolean" }, "enableTTS": { "type": "boolean" }, "enableUnreadMessageBadge": { "type": "boolean" }, "enableUnreadMessagePreview": { "type": "boolean" }, "enableUnreadMessageSound": { "type": "boolean" }, "enableUnreadMessageTitleIndicator": { "type": "boolean" }, "enableTypingIndicator": { "type": "boolean" }, "facebookPageToken": { "type": "string" }, "focusInputAfterPostback": { "type": "boolean" }, "getStartedButtonText": { "type": "string" }, "getStartedPayload": { "type": "string" }, "getStartedText": { "type": "string" }, "getStartedData": { "type": "string" }, "headerLogoUrl": { "type": "string" }, "hubSecret": { "type": "string" }, "inputAutogrowMaxRows": { "type": "number" }, "inputPlaceholder": { "type": "string" }, "language": { "type": "string" }, "lineChannelAccessToken": { "type": "string" }, "lineChannelSecret": { "type": "string" }, "maintenance": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string" }, "text": { "type": "string" }, "title": { "type": "string" } } }, "mergeContactProfiles": { "type": "boolean" }, "messageDelay": { "type": "integer" }, "messageLogoUrl": { "type": "string" }, "overwriteWebchatBundleUrl": { "type": "string" }, "ratingTitleText": { "type": "string" }, "ratingCommentText": { "type": "string" }, "ratingMessageHistoryRatingText": { "type": "string" }, "ratingMessageHistoryCommentText": { "type": "string" }, "reparseAlexaSlots": { "type": "boolean" }, "requestFacebookProfileData": { "type": "boolean" }, "sessionExpiration": { "type": "integer" }, "shouldOverwriteWebchatBundleUrl": { "type": "boolean" }, "showEngagementMessagesInChat": { "type": "boolean" }, "slackOAuthAccessToken": { "type": "string" }, "slackVerifyToken": { "type": "string" }, "sunshineConversationsChannelKeyId": { "type": "string" }, "sunshineConversationsChannelSecret": { "type": "string" }, "sunshineConversationsChannelUri": { "type": "string", "format": "uri" }, "tenantId": { "type": "string" }, "updateContactProfileWithFacebookProfile": { "type": "boolean" }, "voice": { "type": "string" }, "webhookUrl": { "type": "string", "format": "uri" }, "skill": { "type": "object" }, "persistentMenu": { "type": "object" } } }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "boolean", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.\n" }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings.\n" }, "transpiledTransformer": { "type": "string", "description": "The transformer object written by the user, but without typings. This will be executed.\n" }, "inputTransformerEnabled": { "type": "boolean" }, "outputTransformerEnabled": { "type": "boolean" }, "finalPingTransformerEnabled": { "type": "boolean" }, "notifyTransformerEnabled": { "type": "boolean" }, "injectTransformerEnabled": { "type": "boolean" } } }, "handoverSettings": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cognigy", "none", "rce" ] }, "providerSettings": { "type": "object", "properties": { "forwardOnlyHandoverConversations": { "type": "boolean", "description": "(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.\n" }, "getQueueUpdates": { "type": "boolean", "description": "(rce) Indicates if queue updates should be enabled to receive events about the estimated wait time\n" }, "apiVersion": { "type": "string", "description": "(salesforce) Salesforce LiveAgent API Version" }, "baseUrl": { "type": "string", "description": "Base URL of the LiveAgent API Deployment" }, "apiAccessToken": { "type": "string", "description": "(rce) The API access token you can create within RCE" }, "baseApiUrl": { "type": "string", "description": "(rce) The API URL to your RCE installation" }, "realtimeAccessToken": { "type": "string", "description": "(rce) The access token for your rce source sdk source" }, "realtimeEndpointUrl": { "type": "string", "description": "(rce) The endpoint URL of your rce source sdk source" }, "webhookSecret": { "type": "string", "description": "(rce) The secret used to secure webhooks in RCE" }, "botCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "agentCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "organizationId": { "type": "string", "description": "(salesforce) Salesforce Organization ID" }, "deploymentId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Deployment ID" }, "buttonId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Chat Button ID" } } }, "agentAssistSettings": { "type": "object", "properties": { "copilotType": { "type": "string", "enum": [ "none", "workspace", "whisper" ], "description": "Copilot Type" }, "agentAssistFlowId": { "type": "string", "description": "Copilot flow ID" }, "agentAssistConfigId": { "type": "string", "description": "Selected Copilot Config ReferenceId" }, "enableTranscriptTile": { "type": "boolean", "description": "Enable the transcript tile" }, "enableTranscriptTileChatInput": { "type": "boolean", "description": "Enable the chat input for transcript tile" }, "redactTranscriptTileMessages": { "type": "boolean", "description": "Enable redaction of messages in transcript tile" }, "enableAgentCopilotAuthentication": { "type": "boolean", "description": "Enable authentication for agent copilot" }, "blockNonJWTRequests": { "type": "boolean", "description": "Block requests made to the endpoint without a JWT token" }, "agentCopilotAuthentication": { "type": "string", "description": "Authentication connection reference Id for agent copilot" }, "oAuth2Connection": { "type": "string", "description": "OAuth2 Connection for Genesys Cloud" } } } } }, "orgDataPrivacySettings": { "description": "Organisation data privacy settings overwrite the ones defined on endpoint-level", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether or not organisation data privacy settings are enabled" }, "useAnalytics": { "type": "boolean" }, "storeDataPayload": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskIPAddress": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" } } } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "properties": { "foreignId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "entrypoint": { "type": "string", "description": "The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.", "example": "667ed4ae16d66f47dc2a9400" }, "active": { "type": "boolean", "description": "Toggle whether the endpoint is active or not" }, "nluConnectorId": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, { "type": "string" } ] }, "useConversations": { "type": "boolean", "description": "Whether to collect conversations history for this endpoint" }, "maskIPAddress": { "type": "boolean", "description": "Whether to mask sensitive IP address in input object and analytics data for this endpoint" }, "maskAnalytics": { "type": "boolean", "description": "Whether to mask sensitive data in analytics for this endpoint" }, "maskLogging": { "type": "boolean", "description": "Whether to mask sensitive data in logs for this endpoint" }, "useContactProfiles": { "type": "boolean", "description": "Whether to use contact profiles for this endpoint" }, "useAnalytics": { "type": "boolean", "description": "Whether we should store analytics for this endpoint" }, "useDashbotAnalytics": { "type": "boolean", "description": "Whether we should use Dashbot to collect analytics" }, "dashbotApikey": { "type": "string", "description": "The apikey for the dashbot bot" }, "dashbotPlatform": { "type": "string" }, "disableInputSanitization": { "type": "string", "description": "If true, disables input text sanitization after Input Transformer" }, "disableSkipUriTags": { "type": "string", "description": "If true, disables skipping of uri tags" }, "overrideSnapshotConnections": { "type": "boolean" }, "settings": { "type": "object", "properties": { "accessScope": { "type": "string" }, "accessToken": { "type": "string" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "basicAuthPassword": { "type": "string" }, "basicAuthUser": { "type": "string" }, "botUserId": { "type": "string" }, "businessHours": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" }, "weekDay": { "type": "string" } } } }, "enabled": { "type": "boolean" }, "text": { "type": "string" }, "mode": { "type": "string" }, "timeZone": { "type": "string" }, "title": { "type": "string" } } }, "colorScheme": { "type": "string" }, "connectionName": { "type": "string" }, "customJSON": { "type": "string" }, "designTemplate": { "type": "integer" }, "disableHtmlContentSanitization": { "type": "boolean" }, "disableInputAutocomplete": { "type": "boolean" }, "disableInputAutogrow": { "type": "boolean" }, "disableUrlButtonSanitization": { "type": "boolean" }, "enableGenericHTMLStyling": { "type": "boolean" }, "enableAsyncCommunication": { "type": "boolean" }, "engagementMessageText": { "type": "string" }, "displayGetStartedButton": { "type": "boolean" }, "dynamicImageAspectRatio": { "type": "boolean" }, "enableCollectMetadata": { "type": "boolean" }, "enableConnectionStatusIndicator": { "type": "boolean" }, "enableDemoWebchat": { "type": "boolean" }, "enableFileUpload": { "type": "boolean" }, "enablePersistentMenu": { "type": "boolean" }, "enableRating": { "type": "string", "enum": [ "onRequest", "always", "once" ] }, "enableSTT": { "type": "boolean" }, "enableTTS": { "type": "boolean" }, "enableUnreadMessageBadge": { "type": "boolean" }, "enableUnreadMessagePreview": { "type": "boolean" }, "enableUnreadMessageSound": { "type": "boolean" }, "enableUnreadMessageTitleIndicator": { "type": "boolean" }, "enableTypingIndicator": { "type": "boolean" }, "facebookPageToken": { "type": "string" }, "focusInputAfterPostback": { "type": "boolean" }, "getStartedButtonText": { "type": "string" }, "getStartedPayload": { "type": "string" }, "getStartedText": { "type": "string" }, "getStartedData": { "type": "string" }, "headerLogoUrl": { "type": "string" }, "hubSecret": { "type": "string" }, "inputAutogrowMaxRows": { "type": "number" }, "inputPlaceholder": { "type": "string" }, "language": { "type": "string" }, "lineChannelAccessToken": { "type": "string" }, "lineChannelSecret": { "type": "string" }, "maintenance": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string" }, "text": { "type": "string" }, "title": { "type": "string" } } }, "mergeContactProfiles": { "type": "boolean" }, "messageDelay": { "type": "integer" }, "messageLogoUrl": { "type": "string" }, "overwriteWebchatBundleUrl": { "type": "string" }, "ratingTitleText": { "type": "string" }, "ratingCommentText": { "type": "string" }, "ratingMessageHistoryRatingText": { "type": "string" }, "ratingMessageHistoryCommentText": { "type": "string" }, "reparseAlexaSlots": { "type": "boolean" }, "requestFacebookProfileData": { "type": "boolean" }, "sessionExpiration": { "type": "integer" }, "shouldOverwriteWebchatBundleUrl": { "type": "boolean" }, "showEngagementMessagesInChat": { "type": "boolean" }, "slackOAuthAccessToken": { "type": "string" }, "slackVerifyToken": { "type": "string" }, "sunshineConversationsChannelKeyId": { "type": "string" }, "sunshineConversationsChannelSecret": { "type": "string" }, "sunshineConversationsChannelUri": { "type": "string", "format": "uri" }, "tenantId": { "type": "string" }, "updateContactProfileWithFacebookProfile": { "type": "boolean" }, "voice": { "type": "string" }, "webhookUrl": { "type": "string", "format": "uri" }, "skill": { "type": "object" }, "persistentMenu": { "type": "object" } } }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "boolean", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.\n" }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings.\n" }, "transpiledTransformer": { "type": "string", "description": "The transformer object written by the user, but without typings. This will be executed.\n" }, "inputTransformerEnabled": { "type": "boolean" }, "outputTransformerEnabled": { "type": "boolean" }, "finalPingTransformerEnabled": { "type": "boolean" }, "notifyTransformerEnabled": { "type": "boolean" }, "injectTransformerEnabled": { "type": "boolean" } } }, "handoverSettings": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cognigy", "none", "rce" ] }, "providerSettings": { "type": "object", "properties": { "forwardOnlyHandoverConversations": { "type": "boolean", "description": "(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.\n" }, "getQueueUpdates": { "type": "boolean", "description": "(rce) Indicates if queue updates should be enabled to receive events about the estimated wait time\n" }, "apiVersion": { "type": "string", "description": "(salesforce) Salesforce LiveAgent API Version" }, "baseUrl": { "type": "string", "description": "Base URL of the LiveAgent API Deployment" }, "apiAccessToken": { "type": "string", "description": "(rce) The API access token you can create within RCE" }, "baseApiUrl": { "type": "string", "description": "(rce) The API URL to your RCE installation" }, "realtimeAccessToken": { "type": "string", "description": "(rce) The access token for your rce source sdk source" }, "realtimeEndpointUrl": { "type": "string", "description": "(rce) The endpoint URL of your rce source sdk source" }, "webhookSecret": { "type": "string", "description": "(rce) The secret used to secure webhooks in RCE" }, "botCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "agentCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "organizationId": { "type": "string", "description": "(salesforce) Salesforce Organization ID" }, "deploymentId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Deployment ID" }, "buttonId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Chat Button ID" } } }, "agentAssistSettings": { "type": "object", "properties": { "copilotType": { "type": "string", "enum": [ "none", "workspace", "whisper" ], "description": "Copilot Type" }, "agentAssistFlowId": { "type": "string", "description": "Copilot flow ID" }, "agentAssistConfigId": { "type": "string", "description": "Selected Copilot Config ReferenceId" }, "enableTranscriptTile": { "type": "boolean", "description": "Enable the transcript tile" }, "enableTranscriptTileChatInput": { "type": "boolean", "description": "Enable the chat input for transcript tile" }, "redactTranscriptTileMessages": { "type": "boolean", "description": "Enable redaction of messages in transcript tile" }, "enableAgentCopilotAuthentication": { "type": "boolean", "description": "Enable authentication for agent copilot" }, "blockNonJWTRequests": { "type": "boolean", "description": "Block requests made to the endpoint without a JWT token" }, "agentCopilotAuthentication": { "type": "string", "description": "Authentication connection reference Id for agent copilot" }, "oAuth2Connection": { "type": "string", "description": "OAuth2 Connection for Genesys Cloud" } } } } }, "orgDataPrivacySettings": { "description": "Organisation data privacy settings overwrite the ones defined on endpoint-level", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether or not organisation data privacy settings are enabled" }, "useAnalytics": { "type": "boolean" }, "storeDataPayload": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskIPAddress": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" } } } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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": [] } ] }, "post": { "operationId": "createEndpoint_2_0", "summary": "Create an Endpoint", "description": "Creates an Endpoint in a Project.", "tags": [ "Endpoints" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "resourceId", "description": "An Id of a resource within the corresponding project to copy from", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "foreignId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "entrypoint": { "type": "string", "description": "The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.", "example": "667ed4ae16d66f47dc2a9400" }, "active": { "type": "boolean", "description": "Toggle whether the endpoint is active or not" }, "nluConnectorId": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, { "type": "string" } ] }, "useConversations": { "type": "boolean", "description": "Whether to collect conversations history for this endpoint" }, "maskIPAddress": { "type": "boolean", "description": "Whether to mask sensitive IP address in input object and analytics data for this endpoint" }, "maskAnalytics": { "type": "boolean", "description": "Whether to mask sensitive data in analytics for this endpoint" }, "maskLogging": { "type": "boolean", "description": "Whether to mask sensitive data in logs for this endpoint" }, "useContactProfiles": { "type": "boolean", "description": "Whether to use contact profiles for this endpoint" }, "useAnalytics": { "type": "boolean", "description": "Whether we should store analytics for this endpoint" }, "useDashbotAnalytics": { "type": "boolean", "description": "Whether we should use Dashbot to collect analytics" }, "dashbotApikey": { "type": "string", "description": "The apikey for the dashbot bot" }, "dashbotPlatform": { "type": "string" }, "disableInputSanitization": { "type": "string", "description": "If true, disables input text sanitization after Input Transformer" }, "disableSkipUriTags": { "type": "string", "description": "If true, disables skipping of uri tags" }, "overrideSnapshotConnections": { "type": "boolean" }, "settings": { "type": "object", "properties": { "accessScope": { "type": "string" }, "accessToken": { "type": "string" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "basicAuthPassword": { "type": "string" }, "basicAuthUser": { "type": "string" }, "botUserId": { "type": "string" }, "businessHours": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" }, "weekDay": { "type": "string" } } } }, "enabled": { "type": "boolean" }, "text": { "type": "string" }, "mode": { "type": "string" }, "timeZone": { "type": "string" }, "title": { "type": "string" } } }, "colorScheme": { "type": "string" }, "connectionName": { "type": "string" }, "customJSON": { "type": "string" }, "designTemplate": { "type": "integer" }, "disableHtmlContentSanitization": { "type": "boolean" }, "disableInputAutocomplete": { "type": "boolean" }, "disableInputAutogrow": { "type": "boolean" }, "disableUrlButtonSanitization": { "type": "boolean" }, "enableGenericHTMLStyling": { "type": "boolean" }, "enableAsyncCommunication": { "type": "boolean" }, "engagementMessageText": { "type": "string" }, "displayGetStartedButton": { "type": "boolean" }, "dynamicImageAspectRatio": { "type": "boolean" }, "enableCollectMetadata": { "type": "boolean" }, "enableConnectionStatusIndicator": { "type": "boolean" }, "enableDemoWebchat": { "type": "boolean" }, "enableFileUpload": { "type": "boolean" }, "enablePersistentMenu": { "type": "boolean" }, "enableRating": { "type": "string", "enum": [ "onRequest", "always", "once" ] }, "enableSTT": { "type": "boolean" }, "enableTTS": { "type": "boolean" }, "enableUnreadMessageBadge": { "type": "boolean" }, "enableUnreadMessagePreview": { "type": "boolean" }, "enableUnreadMessageSound": { "type": "boolean" }, "enableUnreadMessageTitleIndicator": { "type": "boolean" }, "enableTypingIndicator": { "type": "boolean" }, "facebookPageToken": { "type": "string" }, "focusInputAfterPostback": { "type": "boolean" }, "getStartedButtonText": { "type": "string" }, "getStartedPayload": { "type": "string" }, "getStartedText": { "type": "string" }, "getStartedData": { "type": "string" }, "headerLogoUrl": { "type": "string" }, "hubSecret": { "type": "string" }, "inputAutogrowMaxRows": { "type": "number" }, "inputPlaceholder": { "type": "string" }, "language": { "type": "string" }, "lineChannelAccessToken": { "type": "string" }, "lineChannelSecret": { "type": "string" }, "maintenance": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string" }, "text": { "type": "string" }, "title": { "type": "string" } } }, "mergeContactProfiles": { "type": "boolean" }, "messageDelay": { "type": "integer" }, "messageLogoUrl": { "type": "string" }, "overwriteWebchatBundleUrl": { "type": "string" }, "ratingTitleText": { "type": "string" }, "ratingCommentText": { "type": "string" }, "ratingMessageHistoryRatingText": { "type": "string" }, "ratingMessageHistoryCommentText": { "type": "string" }, "reparseAlexaSlots": { "type": "boolean" }, "requestFacebookProfileData": { "type": "boolean" }, "sessionExpiration": { "type": "integer" }, "shouldOverwriteWebchatBundleUrl": { "type": "boolean" }, "showEngagementMessagesInChat": { "type": "boolean" }, "slackOAuthAccessToken": { "type": "string" }, "slackVerifyToken": { "type": "string" }, "sunshineConversationsChannelKeyId": { "type": "string" }, "sunshineConversationsChannelSecret": { "type": "string" }, "sunshineConversationsChannelUri": { "type": "string", "format": "uri" }, "tenantId": { "type": "string" }, "updateContactProfileWithFacebookProfile": { "type": "boolean" }, "voice": { "type": "string" }, "webhookUrl": { "type": "string", "format": "uri" }, "skill": { "type": "object" }, "persistentMenu": { "type": "object" } } }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "boolean", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.\n" }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings.\n" }, "transpiledTransformer": { "type": "string", "description": "The transformer object written by the user, but without typings. This will be executed.\n" }, "inputTransformerEnabled": { "type": "boolean" }, "outputTransformerEnabled": { "type": "boolean" }, "finalPingTransformerEnabled": { "type": "boolean" }, "notifyTransformerEnabled": { "type": "boolean" }, "injectTransformerEnabled": { "type": "boolean" } } }, "handoverSettings": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cognigy", "none", "rce" ] }, "providerSettings": { "type": "object", "properties": { "forwardOnlyHandoverConversations": { "type": "boolean", "description": "(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.\n" }, "getQueueUpdates": { "type": "boolean", "description": "(rce) Indicates if queue updates should be enabled to receive events about the estimated wait time\n" }, "apiVersion": { "type": "string", "description": "(salesforce) Salesforce LiveAgent API Version" }, "baseUrl": { "type": "string", "description": "Base URL of the LiveAgent API Deployment" }, "apiAccessToken": { "type": "string", "description": "(rce) The API access token you can create within RCE" }, "baseApiUrl": { "type": "string", "description": "(rce) The API URL to your RCE installation" }, "realtimeAccessToken": { "type": "string", "description": "(rce) The access token for your rce source sdk source" }, "realtimeEndpointUrl": { "type": "string", "description": "(rce) The endpoint URL of your rce source sdk source" }, "webhookSecret": { "type": "string", "description": "(rce) The secret used to secure webhooks in RCE" }, "botCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "agentCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "organizationId": { "type": "string", "description": "(salesforce) Salesforce Organization ID" }, "deploymentId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Deployment ID" }, "buttonId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Chat Button ID" } } }, "agentAssistSettings": { "type": "object", "properties": { "copilotType": { "type": "string", "enum": [ "none", "workspace", "whisper" ], "description": "Copilot Type" }, "agentAssistFlowId": { "type": "string", "description": "Copilot flow ID" }, "agentAssistConfigId": { "type": "string", "description": "Selected Copilot Config ReferenceId" }, "enableTranscriptTile": { "type": "boolean", "description": "Enable the transcript tile" }, "enableTranscriptTileChatInput": { "type": "boolean", "description": "Enable the chat input for transcript tile" }, "redactTranscriptTileMessages": { "type": "boolean", "description": "Enable redaction of messages in transcript tile" }, "enableAgentCopilotAuthentication": { "type": "boolean", "description": "Enable authentication for agent copilot" }, "blockNonJWTRequests": { "type": "boolean", "description": "Block requests made to the endpoint without a JWT token" }, "agentCopilotAuthentication": { "type": "string", "description": "Authentication connection reference Id for agent copilot" }, "oAuth2Connection": { "type": "string", "description": "OAuth2 Connection for Genesys Cloud" } } } } }, "orgDataPrivacySettings": { "description": "Organisation data privacy settings overwrite the ones defined on endpoint-level", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether or not organisation data privacy settings are enabled" }, "useAnalytics": { "type": "boolean" }, "storeDataPayload": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskIPAddress": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" } } }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns the Endpoint metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "foreignId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "entrypoint": { "type": "string", "description": "The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.", "example": "667ed4ae16d66f47dc2a9400" }, "active": { "type": "boolean", "description": "Toggle whether the endpoint is active or not" }, "nluConnectorId": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, { "type": "string" } ] }, "useConversations": { "type": "boolean", "description": "Whether to collect conversations history for this endpoint" }, "maskIPAddress": { "type": "boolean", "description": "Whether to mask sensitive IP address in input object and analytics data for this endpoint" }, "maskAnalytics": { "type": "boolean", "description": "Whether to mask sensitive data in analytics for this endpoint" }, "maskLogging": { "type": "boolean", "description": "Whether to mask sensitive data in logs for this endpoint" }, "useContactProfiles": { "type": "boolean", "description": "Whether to use contact profiles for this endpoint" }, "useAnalytics": { "type": "boolean", "description": "Whether we should store analytics for this endpoint" }, "useDashbotAnalytics": { "type": "boolean", "description": "Whether we should use Dashbot to collect analytics" }, "dashbotApikey": { "type": "string", "description": "The apikey for the dashbot bot" }, "dashbotPlatform": { "type": "string" }, "disableInputSanitization": { "type": "string", "description": "If true, disables input text sanitization after Input Transformer" }, "disableSkipUriTags": { "type": "string", "description": "If true, disables skipping of uri tags" }, "overrideSnapshotConnections": { "type": "boolean" }, "settings": { "type": "object", "properties": { "accessScope": { "type": "string" }, "accessToken": { "type": "string" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "basicAuthPassword": { "type": "string" }, "basicAuthUser": { "type": "string" }, "botUserId": { "type": "string" }, "businessHours": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" }, "weekDay": { "type": "string" } } } }, "enabled": { "type": "boolean" }, "text": { "type": "string" }, "mode": { "type": "string" }, "timeZone": { "type": "string" }, "title": { "type": "string" } } }, "colorScheme": { "type": "string" }, "connectionName": { "type": "string" }, "customJSON": { "type": "string" }, "designTemplate": { "type": "integer" }, "disableHtmlContentSanitization": { "type": "boolean" }, "disableInputAutocomplete": { "type": "boolean" }, "disableInputAutogrow": { "type": "boolean" }, "disableUrlButtonSanitization": { "type": "boolean" }, "enableGenericHTMLStyling": { "type": "boolean" }, "enableAsyncCommunication": { "type": "boolean" }, "engagementMessageText": { "type": "string" }, "displayGetStartedButton": { "type": "boolean" }, "dynamicImageAspectRatio": { "type": "boolean" }, "enableCollectMetadata": { "type": "boolean" }, "enableConnectionStatusIndicator": { "type": "boolean" }, "enableDemoWebchat": { "type": "boolean" }, "enableFileUpload": { "type": "boolean" }, "enablePersistentMenu": { "type": "boolean" }, "enableRating": { "type": "string", "enum": [ "onRequest", "always", "once" ] }, "enableSTT": { "type": "boolean" }, "enableTTS": { "type": "boolean" }, "enableUnreadMessageBadge": { "type": "boolean" }, "enableUnreadMessagePreview": { "type": "boolean" }, "enableUnreadMessageSound": { "type": "boolean" }, "enableUnreadMessageTitleIndicator": { "type": "boolean" }, "enableTypingIndicator": { "type": "boolean" }, "facebookPageToken": { "type": "string" }, "focusInputAfterPostback": { "type": "boolean" }, "getStartedButtonText": { "type": "string" }, "getStartedPayload": { "type": "string" }, "getStartedText": { "type": "string" }, "getStartedData": { "type": "string" }, "headerLogoUrl": { "type": "string" }, "hubSecret": { "type": "string" }, "inputAutogrowMaxRows": { "type": "number" }, "inputPlaceholder": { "type": "string" }, "language": { "type": "string" }, "lineChannelAccessToken": { "type": "string" }, "lineChannelSecret": { "type": "string" }, "maintenance": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string" }, "text": { "type": "string" }, "title": { "type": "string" } } }, "mergeContactProfiles": { "type": "boolean" }, "messageDelay": { "type": "integer" }, "messageLogoUrl": { "type": "string" }, "overwriteWebchatBundleUrl": { "type": "string" }, "ratingTitleText": { "type": "string" }, "ratingCommentText": { "type": "string" }, "ratingMessageHistoryRatingText": { "type": "string" }, "ratingMessageHistoryCommentText": { "type": "string" }, "reparseAlexaSlots": { "type": "boolean" }, "requestFacebookProfileData": { "type": "boolean" }, "sessionExpiration": { "type": "integer" }, "shouldOverwriteWebchatBundleUrl": { "type": "boolean" }, "showEngagementMessagesInChat": { "type": "boolean" }, "slackOAuthAccessToken": { "type": "string" }, "slackVerifyToken": { "type": "string" }, "sunshineConversationsChannelKeyId": { "type": "string" }, "sunshineConversationsChannelSecret": { "type": "string" }, "sunshineConversationsChannelUri": { "type": "string", "format": "uri" }, "tenantId": { "type": "string" }, "updateContactProfileWithFacebookProfile": { "type": "boolean" }, "voice": { "type": "string" }, "webhookUrl": { "type": "string", "format": "uri" }, "skill": { "type": "object" }, "persistentMenu": { "type": "object" } } }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "boolean", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.\n" }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings.\n" }, "transpiledTransformer": { "type": "string", "description": "The transformer object written by the user, but without typings. This will be executed.\n" }, "inputTransformerEnabled": { "type": "boolean" }, "outputTransformerEnabled": { "type": "boolean" }, "finalPingTransformerEnabled": { "type": "boolean" }, "notifyTransformerEnabled": { "type": "boolean" }, "injectTransformerEnabled": { "type": "boolean" } } }, "handoverSettings": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cognigy", "none", "rce" ] }, "providerSettings": { "type": "object", "properties": { "forwardOnlyHandoverConversations": { "type": "boolean", "description": "(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.\n" }, "getQueueUpdates": { "type": "boolean", "description": "(rce) Indicates if queue updates should be enabled to receive events about the estimated wait time\n" }, "apiVersion": { "type": "string", "description": "(salesforce) Salesforce LiveAgent API Version" }, "baseUrl": { "type": "string", "description": "Base URL of the LiveAgent API Deployment" }, "apiAccessToken": { "type": "string", "description": "(rce) The API access token you can create within RCE" }, "baseApiUrl": { "type": "string", "description": "(rce) The API URL to your RCE installation" }, "realtimeAccessToken": { "type": "string", "description": "(rce) The access token for your rce source sdk source" }, "realtimeEndpointUrl": { "type": "string", "description": "(rce) The endpoint URL of your rce source sdk source" }, "webhookSecret": { "type": "string", "description": "(rce) The secret used to secure webhooks in RCE" }, "botCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "agentCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "organizationId": { "type": "string", "description": "(salesforce) Salesforce Organization ID" }, "deploymentId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Deployment ID" }, "buttonId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Chat Button ID" } } }, "agentAssistSettings": { "type": "object", "properties": { "copilotType": { "type": "string", "enum": [ "none", "workspace", "whisper" ], "description": "Copilot Type" }, "agentAssistFlowId": { "type": "string", "description": "Copilot flow ID" }, "agentAssistConfigId": { "type": "string", "description": "Selected Copilot Config ReferenceId" }, "enableTranscriptTile": { "type": "boolean", "description": "Enable the transcript tile" }, "enableTranscriptTileChatInput": { "type": "boolean", "description": "Enable the chat input for transcript tile" }, "redactTranscriptTileMessages": { "type": "boolean", "description": "Enable redaction of messages in transcript tile" }, "enableAgentCopilotAuthentication": { "type": "boolean", "description": "Enable authentication for agent copilot" }, "blockNonJWTRequests": { "type": "boolean", "description": "Block requests made to the endpoint without a JWT token" }, "agentCopilotAuthentication": { "type": "string", "description": "Authentication connection reference Id for agent copilot" }, "oAuth2Connection": { "type": "string", "description": "OAuth2 Connection for Genesys Cloud" } } } } }, "orgDataPrivacySettings": { "description": "Organisation data privacy settings overwrite the ones defined on endpoint-level", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether or not organisation data privacy settings are enabled" }, "useAnalytics": { "type": "boolean" }, "storeDataPayload": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskIPAddress": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexEndpoints_2_0", "summary": "Get Endpoints", "description": "Gets Endpoints from a Project. By default, 25 Endpoints are returned. To change this value, use the `limit` query parameter.", "tags": [ "Endpoints" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the Endpoint to filter the records." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a Endpoint metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "overrideSnapshotConnections": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/endpoints/{endpointId}": { "delete": { "operationId": "deleteEndpoint_2_0", "summary": "Delete an Endpoint", "description": "Deletes an Endpoint from a Project.", "tags": [ "Endpoints" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "endpointId", "description": "The Id of the Endpoint", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The Endpoint was deleted successfully." }, "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": [] } ] }, "get": { "operationId": "readEndpoint_2_0", "summary": "Get an Endpoint", "description": "Gets an Endpoint from a Project.", "tags": [ "Endpoints" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "endpointId", "description": "The Id of the Endpoint", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the Endpoint object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "foreignId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "entrypoint": { "type": "string", "description": "The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.", "example": "667ed4ae16d66f47dc2a9400" }, "active": { "type": "boolean", "description": "Toggle whether the endpoint is active or not" }, "nluConnectorId": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, { "type": "string" } ] }, "useConversations": { "type": "boolean", "description": "Whether to collect conversations history for this endpoint" }, "maskIPAddress": { "type": "boolean", "description": "Whether to mask sensitive IP address in input object and analytics data for this endpoint" }, "maskAnalytics": { "type": "boolean", "description": "Whether to mask sensitive data in analytics for this endpoint" }, "maskLogging": { "type": "boolean", "description": "Whether to mask sensitive data in logs for this endpoint" }, "useContactProfiles": { "type": "boolean", "description": "Whether to use contact profiles for this endpoint" }, "useAnalytics": { "type": "boolean", "description": "Whether we should store analytics for this endpoint" }, "useDashbotAnalytics": { "type": "boolean", "description": "Whether we should use Dashbot to collect analytics" }, "dashbotApikey": { "type": "string", "description": "The apikey for the dashbot bot" }, "dashbotPlatform": { "type": "string" }, "disableInputSanitization": { "type": "string", "description": "If true, disables input text sanitization after Input Transformer" }, "disableSkipUriTags": { "type": "string", "description": "If true, disables skipping of uri tags" }, "overrideSnapshotConnections": { "type": "boolean" }, "settings": { "type": "object", "properties": { "accessScope": { "type": "string" }, "accessToken": { "type": "string" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "basicAuthPassword": { "type": "string" }, "basicAuthUser": { "type": "string" }, "botUserId": { "type": "string" }, "businessHours": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" }, "weekDay": { "type": "string" } } } }, "enabled": { "type": "boolean" }, "text": { "type": "string" }, "mode": { "type": "string" }, "timeZone": { "type": "string" }, "title": { "type": "string" } } }, "colorScheme": { "type": "string" }, "connectionName": { "type": "string" }, "customJSON": { "type": "string" }, "designTemplate": { "type": "integer" }, "disableHtmlContentSanitization": { "type": "boolean" }, "disableInputAutocomplete": { "type": "boolean" }, "disableInputAutogrow": { "type": "boolean" }, "disableUrlButtonSanitization": { "type": "boolean" }, "enableGenericHTMLStyling": { "type": "boolean" }, "enableAsyncCommunication": { "type": "boolean" }, "engagementMessageText": { "type": "string" }, "displayGetStartedButton": { "type": "boolean" }, "dynamicImageAspectRatio": { "type": "boolean" }, "enableCollectMetadata": { "type": "boolean" }, "enableConnectionStatusIndicator": { "type": "boolean" }, "enableDemoWebchat": { "type": "boolean" }, "enableFileUpload": { "type": "boolean" }, "enablePersistentMenu": { "type": "boolean" }, "enableRating": { "type": "string", "enum": [ "onRequest", "always", "once" ] }, "enableSTT": { "type": "boolean" }, "enableTTS": { "type": "boolean" }, "enableUnreadMessageBadge": { "type": "boolean" }, "enableUnreadMessagePreview": { "type": "boolean" }, "enableUnreadMessageSound": { "type": "boolean" }, "enableUnreadMessageTitleIndicator": { "type": "boolean" }, "enableTypingIndicator": { "type": "boolean" }, "facebookPageToken": { "type": "string" }, "focusInputAfterPostback": { "type": "boolean" }, "getStartedButtonText": { "type": "string" }, "getStartedPayload": { "type": "string" }, "getStartedText": { "type": "string" }, "getStartedData": { "type": "string" }, "headerLogoUrl": { "type": "string" }, "hubSecret": { "type": "string" }, "inputAutogrowMaxRows": { "type": "number" }, "inputPlaceholder": { "type": "string" }, "language": { "type": "string" }, "lineChannelAccessToken": { "type": "string" }, "lineChannelSecret": { "type": "string" }, "maintenance": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string" }, "text": { "type": "string" }, "title": { "type": "string" } } }, "mergeContactProfiles": { "type": "boolean" }, "messageDelay": { "type": "integer" }, "messageLogoUrl": { "type": "string" }, "overwriteWebchatBundleUrl": { "type": "string" }, "ratingTitleText": { "type": "string" }, "ratingCommentText": { "type": "string" }, "ratingMessageHistoryRatingText": { "type": "string" }, "ratingMessageHistoryCommentText": { "type": "string" }, "reparseAlexaSlots": { "type": "boolean" }, "requestFacebookProfileData": { "type": "boolean" }, "sessionExpiration": { "type": "integer" }, "shouldOverwriteWebchatBundleUrl": { "type": "boolean" }, "showEngagementMessagesInChat": { "type": "boolean" }, "slackOAuthAccessToken": { "type": "string" }, "slackVerifyToken": { "type": "string" }, "sunshineConversationsChannelKeyId": { "type": "string" }, "sunshineConversationsChannelSecret": { "type": "string" }, "sunshineConversationsChannelUri": { "type": "string", "format": "uri" }, "tenantId": { "type": "string" }, "updateContactProfileWithFacebookProfile": { "type": "boolean" }, "voice": { "type": "string" }, "webhookUrl": { "type": "string", "format": "uri" }, "skill": { "type": "object" }, "persistentMenu": { "type": "object" } } }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "boolean", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.\n" }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings.\n" }, "transpiledTransformer": { "type": "string", "description": "The transformer object written by the user, but without typings. This will be executed.\n" }, "inputTransformerEnabled": { "type": "boolean" }, "outputTransformerEnabled": { "type": "boolean" }, "finalPingTransformerEnabled": { "type": "boolean" }, "notifyTransformerEnabled": { "type": "boolean" }, "injectTransformerEnabled": { "type": "boolean" } } }, "handoverSettings": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cognigy", "none", "rce" ] }, "providerSettings": { "type": "object", "properties": { "forwardOnlyHandoverConversations": { "type": "boolean", "description": "(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.\n" }, "getQueueUpdates": { "type": "boolean", "description": "(rce) Indicates if queue updates should be enabled to receive events about the estimated wait time\n" }, "apiVersion": { "type": "string", "description": "(salesforce) Salesforce LiveAgent API Version" }, "baseUrl": { "type": "string", "description": "Base URL of the LiveAgent API Deployment" }, "apiAccessToken": { "type": "string", "description": "(rce) The API access token you can create within RCE" }, "baseApiUrl": { "type": "string", "description": "(rce) The API URL to your RCE installation" }, "realtimeAccessToken": { "type": "string", "description": "(rce) The access token for your rce source sdk source" }, "realtimeEndpointUrl": { "type": "string", "description": "(rce) The endpoint URL of your rce source sdk source" }, "webhookSecret": { "type": "string", "description": "(rce) The secret used to secure webhooks in RCE" }, "botCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "agentCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "organizationId": { "type": "string", "description": "(salesforce) Salesforce Organization ID" }, "deploymentId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Deployment ID" }, "buttonId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Chat Button ID" } } }, "agentAssistSettings": { "type": "object", "properties": { "copilotType": { "type": "string", "enum": [ "none", "workspace", "whisper" ], "description": "Copilot Type" }, "agentAssistFlowId": { "type": "string", "description": "Copilot flow ID" }, "agentAssistConfigId": { "type": "string", "description": "Selected Copilot Config ReferenceId" }, "enableTranscriptTile": { "type": "boolean", "description": "Enable the transcript tile" }, "enableTranscriptTileChatInput": { "type": "boolean", "description": "Enable the chat input for transcript tile" }, "redactTranscriptTileMessages": { "type": "boolean", "description": "Enable redaction of messages in transcript tile" }, "enableAgentCopilotAuthentication": { "type": "boolean", "description": "Enable authentication for agent copilot" }, "blockNonJWTRequests": { "type": "boolean", "description": "Block requests made to the endpoint without a JWT token" }, "agentCopilotAuthentication": { "type": "string", "description": "Authentication connection reference Id for agent copilot" }, "oAuth2Connection": { "type": "string", "description": "OAuth2 Connection for Genesys Cloud" } } } } }, "orgDataPrivacySettings": { "description": "Organisation data privacy settings overwrite the ones defined on endpoint-level", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether or not organisation data privacy settings are enabled" }, "useAnalytics": { "type": "boolean" }, "storeDataPayload": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskIPAddress": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateEndpoint", "summary": "Update an Endpoint", "description": "Updates Endpoint settings in a Project. Allows modifying the Endpoint's activation status, Transformers, handover, analytics, and privacy options.", "tags": [ "Endpoints" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "endpointId", "description": "The Id of the Endpoint", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "foreignId": { "type": "string" }, "channel": { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, "flowId": { "type": "string" }, "localeId": { "type": "string" }, "URLToken": { "type": "string", "description": "The URLToken of the endpoint", "example": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f" }, "name": { "type": "string", "description": "The name of the endpoint", "example": "New Endpoint" }, "entrypoint": { "type": "string", "description": "The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.", "example": "667ed4ae16d66f47dc2a9400" }, "active": { "type": "boolean", "description": "Toggle whether the endpoint is active or not" }, "nluConnectorId": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, { "type": "string" } ] }, "useConversations": { "type": "boolean", "description": "Whether to collect conversations history for this endpoint" }, "maskIPAddress": { "type": "boolean", "description": "Whether to mask sensitive IP address in input object and analytics data for this endpoint" }, "maskAnalytics": { "type": "boolean", "description": "Whether to mask sensitive data in analytics for this endpoint" }, "maskLogging": { "type": "boolean", "description": "Whether to mask sensitive data in logs for this endpoint" }, "useContactProfiles": { "type": "boolean", "description": "Whether to use contact profiles for this endpoint" }, "useAnalytics": { "type": "boolean", "description": "Whether we should store analytics for this endpoint" }, "useDashbotAnalytics": { "type": "boolean", "description": "Whether we should use Dashbot to collect analytics" }, "dashbotApikey": { "type": "string", "description": "The apikey for the dashbot bot" }, "dashbotPlatform": { "type": "string" }, "disableInputSanitization": { "type": "string", "description": "If true, disables input text sanitization after Input Transformer" }, "disableSkipUriTags": { "type": "string", "description": "If true, disables skipping of uri tags" }, "overrideSnapshotConnections": { "type": "boolean" }, "settings": { "type": "object", "properties": { "accessScope": { "type": "string" }, "accessToken": { "type": "string" }, "appId": { "type": "string" }, "appSecret": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "basicAuthPassword": { "type": "string" }, "basicAuthUser": { "type": "string" }, "botUserId": { "type": "string" }, "businessHours": { "type": "object", "properties": { "businessHours": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" }, "weekDay": { "type": "string" } } } }, "enabled": { "type": "boolean" }, "text": { "type": "string" }, "mode": { "type": "string" }, "timeZone": { "type": "string" }, "title": { "type": "string" } } }, "colorScheme": { "type": "string" }, "connectionName": { "type": "string" }, "customJSON": { "type": "string" }, "designTemplate": { "type": "integer" }, "disableHtmlContentSanitization": { "type": "boolean" }, "disableInputAutocomplete": { "type": "boolean" }, "disableInputAutogrow": { "type": "boolean" }, "disableUrlButtonSanitization": { "type": "boolean" }, "enableGenericHTMLStyling": { "type": "boolean" }, "enableAsyncCommunication": { "type": "boolean" }, "engagementMessageText": { "type": "string" }, "displayGetStartedButton": { "type": "boolean" }, "dynamicImageAspectRatio": { "type": "boolean" }, "enableCollectMetadata": { "type": "boolean" }, "enableConnectionStatusIndicator": { "type": "boolean" }, "enableDemoWebchat": { "type": "boolean" }, "enableFileUpload": { "type": "boolean" }, "enablePersistentMenu": { "type": "boolean" }, "enableRating": { "type": "string", "enum": [ "onRequest", "always", "once" ] }, "enableSTT": { "type": "boolean" }, "enableTTS": { "type": "boolean" }, "enableUnreadMessageBadge": { "type": "boolean" }, "enableUnreadMessagePreview": { "type": "boolean" }, "enableUnreadMessageSound": { "type": "boolean" }, "enableUnreadMessageTitleIndicator": { "type": "boolean" }, "enableTypingIndicator": { "type": "boolean" }, "facebookPageToken": { "type": "string" }, "focusInputAfterPostback": { "type": "boolean" }, "getStartedButtonText": { "type": "string" }, "getStartedPayload": { "type": "string" }, "getStartedText": { "type": "string" }, "getStartedData": { "type": "string" }, "headerLogoUrl": { "type": "string" }, "hubSecret": { "type": "string" }, "inputAutogrowMaxRows": { "type": "number" }, "inputPlaceholder": { "type": "string" }, "language": { "type": "string" }, "lineChannelAccessToken": { "type": "string" }, "lineChannelSecret": { "type": "string" }, "maintenance": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string" }, "text": { "type": "string" }, "title": { "type": "string" } } }, "mergeContactProfiles": { "type": "boolean" }, "messageDelay": { "type": "integer" }, "messageLogoUrl": { "type": "string" }, "overwriteWebchatBundleUrl": { "type": "string" }, "ratingTitleText": { "type": "string" }, "ratingCommentText": { "type": "string" }, "ratingMessageHistoryRatingText": { "type": "string" }, "ratingMessageHistoryCommentText": { "type": "string" }, "reparseAlexaSlots": { "type": "boolean" }, "requestFacebookProfileData": { "type": "boolean" }, "sessionExpiration": { "type": "integer" }, "shouldOverwriteWebchatBundleUrl": { "type": "boolean" }, "showEngagementMessagesInChat": { "type": "boolean" }, "slackOAuthAccessToken": { "type": "string" }, "slackVerifyToken": { "type": "string" }, "sunshineConversationsChannelKeyId": { "type": "string" }, "sunshineConversationsChannelSecret": { "type": "string" }, "sunshineConversationsChannelUri": { "type": "string", "format": "uri" }, "tenantId": { "type": "string" }, "updateContactProfileWithFacebookProfile": { "type": "boolean" }, "voice": { "type": "string" }, "webhookUrl": { "type": "string", "format": "uri" }, "skill": { "type": "object" }, "persistentMenu": { "type": "object" } } }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "boolean", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.\n" }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings.\n" }, "transpiledTransformer": { "type": "string", "description": "The transformer object written by the user, but without typings. This will be executed.\n" }, "inputTransformerEnabled": { "type": "boolean" }, "outputTransformerEnabled": { "type": "boolean" }, "finalPingTransformerEnabled": { "type": "boolean" }, "notifyTransformerEnabled": { "type": "boolean" }, "injectTransformerEnabled": { "type": "boolean" } } }, "handoverSettings": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cognigy", "none", "rce" ] }, "providerSettings": { "type": "object", "properties": { "forwardOnlyHandoverConversations": { "type": "boolean", "description": "(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.\n" }, "getQueueUpdates": { "type": "boolean", "description": "(rce) Indicates if queue updates should be enabled to receive events about the estimated wait time\n" }, "apiVersion": { "type": "string", "description": "(salesforce) Salesforce LiveAgent API Version" }, "baseUrl": { "type": "string", "description": "Base URL of the LiveAgent API Deployment" }, "apiAccessToken": { "type": "string", "description": "(rce) The API access token you can create within RCE" }, "baseApiUrl": { "type": "string", "description": "(rce) The API URL to your RCE installation" }, "realtimeAccessToken": { "type": "string", "description": "(rce) The access token for your rce source sdk source" }, "realtimeEndpointUrl": { "type": "string", "description": "(rce) The endpoint URL of your rce source sdk source" }, "webhookSecret": { "type": "string", "description": "(rce) The secret used to secure webhooks in RCE" }, "botCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "agentCategoryId": { "type": "string", "description": "(rce) The ID of the category you use as the 'bot category' within RCE" }, "organizationId": { "type": "string", "description": "(salesforce) Salesforce Organization ID" }, "deploymentId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Deployment ID" }, "buttonId": { "type": "string", "description": "(salesforce) Salesforce LiveAgent Chat Button ID" } } }, "agentAssistSettings": { "type": "object", "properties": { "copilotType": { "type": "string", "enum": [ "none", "workspace", "whisper" ], "description": "Copilot Type" }, "agentAssistFlowId": { "type": "string", "description": "Copilot flow ID" }, "agentAssistConfigId": { "type": "string", "description": "Selected Copilot Config ReferenceId" }, "enableTranscriptTile": { "type": "boolean", "description": "Enable the transcript tile" }, "enableTranscriptTileChatInput": { "type": "boolean", "description": "Enable the chat input for transcript tile" }, "redactTranscriptTileMessages": { "type": "boolean", "description": "Enable redaction of messages in transcript tile" }, "enableAgentCopilotAuthentication": { "type": "boolean", "description": "Enable authentication for agent copilot" }, "blockNonJWTRequests": { "type": "boolean", "description": "Block requests made to the endpoint without a JWT token" }, "agentCopilotAuthentication": { "type": "string", "description": "Authentication connection reference Id for agent copilot" }, "oAuth2Connection": { "type": "string", "description": "OAuth2 Connection for Genesys Cloud" } } } } }, "orgDataPrivacySettings": { "description": "Organisation data privacy settings overwrite the ones defined on endpoint-level", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether or not organisation data privacy settings are enabled" }, "useAnalytics": { "type": "boolean" }, "storeDataPayload": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskIPAddress": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" } } } } } } } }, "responses": { "200": { "description": "The Endpoint was updated successfully." }, "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/extensions": { "get": { "operationId": "indexExtensions_2_0", "summary": "Get Extensions", "description": "Gets Extensions from a Project. By default, 25 Extensions are returned. To change this value, use the `limit` query parameter.", "tags": [ "Extensions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the Extension to filter the records." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns an array of Extension metadata objects.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Extension", "example": "new-extension" }, "label": { "type": "string", "description": "Optional human readable extension name", "example": "New Extension" }, "version": { "type": "string", "description": "The version of the Extension", "example": "1.0.0" }, "imageUrlToken": { "type": "string", "format": "alphanum-64", "description": "A fully qualified URL to an image/icon for the extension." }, "description": { "type": "string", "description": "Optional description of the extension", "example": "This is a fancy extension" }, "trustedCode": { "type": "boolean", "description": "NodeDescriptors trusted flag." }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/extensions/{extensionId}": { "delete": { "operationId": "deleteExtension_2_0", "summary": "Delete an Extension", "description": "Deletes an Extension from a Project.", "tags": [ "Extensions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "extensionId", "description": "The Id of the Extension", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "The Extension was deleted successfully." }, "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": [] } ] }, "get": { "operationId": "readExtension_2_0", "summary": "Get an Extension", "description": "Gets an Extension from a Project.", "tags": [ "Extensions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "extensionId", "description": "The Id of the Extension", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Extension Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Extension", "example": "New Extension" }, "label": { "type": "string", "description": "The label of the Extension", "example": "New Extension" }, "version": { "type": "string", "description": "The version of the Extension", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", "example": "1.0.0" }, "imageUrlToken": { "type": "string", "format": "alphanum-64", "description": "A fully qualified URL to an image/icon for the extension." }, "description": { "type": "string", "description": "Optional description of the extension" }, "tags": { "type": "array", "description": "Optional list of tags to find the extension", "items": { "type": "string" } }, "author": { "type": "string", "description": "Author of the extension" }, "extensionType": { "type": "string", "description": "Type of this extension", "enum": [ "nodes" ] }, "trustedCode": { "type": "boolean", "description": "Whether the code of the extension is trusted and runs without isolation" }, "nodes": { "type": "object", "properties": { "type": { "type": "string" }, "parentType": { "type": "string", "description": "The type of the node parent, if there is one" }, "defaultLabel": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Node of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Node of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Node is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "extension": { "type": "string" }, "extensionImg": { "type": "string" }, "appearance": { "type": "object", "properties": { "logo": { "type": "string" }, "textColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "contrastTextColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "color": { "type": "string", "example": "red", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "variant": { "type": "string", "enum": [ "regular", "mini", "hexagon" ] } } }, "behavior": { "type": "object", "properties": { "stopping": { "type": "boolean" }, "entrypoint": { "type": "boolean" } } }, "constraints": { "type": "object", "properties": { "editable": { "type": "boolean", "description": "Should this node be editable" }, "deletable": { "type": "boolean", "description": "Should this node be deletable" }, "creatable": { "type": "boolean", "description": "Should this node be manually creatable" }, "collapsable": { "type": "boolean", "description": "Should this node be collapsable" }, "childFlowCreatable": { "type": "boolean", "description": "Should it be possible to create child flow from this node" }, "movable": { "type": "boolean", "description": "Should this node be movable" }, "placement": { "type": "object", "description": "Additional placement information", "properties": { "predecessor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "successor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "children": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } } } } } }, "dependencies": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "string" } } } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "previews": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message", "image", "code" ] }, "key": { "type": "string" } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 30, "example": "word count" }, "script": { "type": "string", "maxLength": 500, "example": "ci.text.split(' ').length" }, "type": { "type": "string", "enum": [ "profile", "input", "context", "custom", "answer", "flow-output", "flow-input" ], "example": "input" } } } }, "tags": { "type": "string", "enum": [ "basic", "logic", "message", "profile", "service", "nlu", "data" ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "connections": { "type": "object", "properties": { "extension": { "type": "string", "description": "The package name of the extension", "example": "azure" }, "type": { "type": "string", "description": "The type of the connection within the extension", "example": "oauth-2" }, "label": { "type": "string", "description": "The label for the connection type", "example": "OAuth-2" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "The name of the field", "example": "client_secret" } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, "knowledge": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Knowledge of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Knowledge of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Knowledge is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule", "json", "checkbox", "time", "date", "datetime", "select", "xml", "textArray", "chipInput", "toggle", "slider", "number", "daterange", "connection", "condition", "description" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateExtension_2_0", "summary": "Update Extension Settings", "description": "Updates Extension settings, such as enabling or disabling trusted code behavior.", "tags": [ "Extensions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "extensionId", "description": "The Id of the Extension", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "trustedCode": { "type": "boolean", "description": "Whether to trust the code within this extension. This will reduce isolation but increase performance.", "example": true } } } } } }, "responses": { "204": { "description": "Successfully updated Extension" }, "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/extensions/update": { "post": { "operationId": "updateExtensionPackage_2_0", "summary": "Update an Extension", "description": "Updates an existing uploaded Extension in a Project by replacing it with a new version. You can provide the Extension either as a file upload or via a URL. The method creates a Task to process the update, and the response returns the task status and progress so you can track when the replacement is completed.", "tags": [ "Extensions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "projectId", "url", "extension" ], "properties": { "file": { "type": "string", "format": "binary" }, "projectId": { "type": "string", "description": "The Id of the project." }, "extension": { "type": "string", "description": "The Id or name of the extension to update." } } }, "encoding": { "file": { "contentType": "application/gzip" } } }, "application/json": { "schema": { "type": "object", "required": [ "projectId", "url", "extension" ], "properties": { "url": { "type": "string", "format": "url", "description": "The url to an extension. The Extension will then loaded by the system.", "example": "https://github.com/Cognigy/Extensions/releases/download/random-cat-image400/random-cat-image.tar.gz" }, "projectId": { "type": "string", "description": "The Id of the project." }, "extension": { "type": "string", "description": "The name of the extension to update." } } } } } }, "responses": { "202": { "description": "Create a Task to delete the Extension if already present and replace it with the uploaded Extension.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/extensions/upload": { "post": { "operationId": "uploadExtension_2_0", "summary": "Upload an Extension", "description": "Upload an Extension to a Project. The Extension can be provided as a file or via a URL. The method creates a Task to process the creation, and the response includes the task status and progress so you can track completion. This upload always creates a new Extension and doesn't replace any existing ones.", "tags": [ "Extensions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "contentType": "application/gzip" } } }, "application/json": { "schema": { "type": "object", "required": [ "projectId", "url" ], "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "url": { "type": "string", "format": "url", "description": "The URL to an Extension. The system will then load the Extension.", "example": "https://github.com/Cognigy/Extensions/releases/download/random-cat-image400/random-cat-image.tar.gz" }, "name": { "type": "string", "description": "The name of the extension you are trying to upload. This is needed only to fill in the task metadata." } } } } } }, "responses": { "202": { "description": "Successfully uploaded the Extension and created a Task to process it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/files/{fileId}": { "get": { "operationId": "readFile_2_0", "summary": "Get File Metadata", "description": "Gets file metadata without the binary content.", "tags": [ "Files" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "fileId", "description": "The Id of the File", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the File object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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/files/{fileToken}": { "get": { "operationId": "readFileBlob_2_0", "summary": "Get Binary Data of a File", "description": "Gets the binary data of a file object using its file token.", "tags": [ "Files" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "fileToken", "description": "The token of the File", "required": true, "schema": { "type": "string", "pattern": "/[a-fA-F0-9]{64}/" } } ], "responses": { "200": { "description": "Binary data of the file object" }, "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/flows": { "patch": { "operationId": "batchFlows_2_0", "summary": "Perform Batch Operations on Flows", "description": "Performs batch operations on Flows.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" }, "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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": [] } ] }, "post": { "operationId": "createFlow_2_0", "summary": "Create a Flow", "description": "Creates a Flow in a Project.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "resourceId", "description": "An Id of a resource within the corresponding project to copy from", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns Flow object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "intentTrainGroupReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "isTrainingOutOfDate": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexFlows_2_0", "summary": "Get Flows", "description": "Gets Flows from a Project. By default, 25 Flows are returned. To change this value, use the `limit` query parameter. Additionally, use `withAiAgents=true` to include AI Agent information for each Flow.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the Flow to filter the records." }, { "in": "query", "name": "withAiAgents", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to include AI agent information and filtering" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns array of a Flow metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "referenceId": { "type": "string", "format": "uuid" }, "isTrainingOutOfDate": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/flows/{flowId}": { "delete": { "operationId": "deleteFlow_2_0", "summary": "Delete a Flow", "description": "Deletes a Flow from a Project.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted Flow" }, "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": [] } ] }, "get": { "operationId": "readFlow_2_0", "summary": "Get a Flow", "description": "Gets a Flow from a Project.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Flow Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "intentTrainGroupReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "isTrainingOutOfDate": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateFlow", "summary": "Update a Flow", "description": "Updates a Flow in a Project. Allows modifying of a Flow's name, description, and locale.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" }, "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "The Flow was successfully updated." }, "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/flows/{flowId}/addlocalization": { "post": { "operationId": "addFlowLocalization_2_0", "summary": "Add a Locale to a Flow", "description": "Adds a Locale to a Flow.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inheritFromLocaleId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "The Locale was added to the Node successfully." }, "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/flows/{flowId}/chart": { "get": { "operationId": "readFlowChart_2_0", "summary": "Get the Chart of specified Flow", "description": "Gets the Chart of the specified Flow.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Chart of the Flow", "content": { "application/json": { "schema": { "type": "object", "properties": { "nodes": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "type": { "type": "string", "example": "if" }, "referenceId": { "type": "string", "format": "uuid" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node" }, "analyticsLabel": { "type": "string", "example": "Step name" }, "comment": { "type": "string", "example": "this is a very important node" }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isCollapsed": { "type": "boolean", "example": false }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false } } } }, "relations": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "node": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "children": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "next": { "nullable": true, "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } } }, "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/flows/{flowId}/chart/nodes/childflow": { "post": { "operationId": "createFlowFromChildren_2_0", "summary": "Create a Flow from a Child Node", "description": "Creates a Flow from a child Node. Moves the Nodes following the child Node to the newly created Flow. The original Flow receives an Execute Flow Node pointing to the new Flow. This method only works if the child Node is followed by other Nodes.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "nodeId", "newFlowName" ], "properties": { "nodeId": { "type": "string" }, "newFlowName": { "type": "string" } } } } } }, "responses": { "201": { "description": "Returns the created child Flow metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "intentTrainGroupReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "isTrainingOutOfDate": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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/flows/{flowId}/clone": { "post": { "operationId": "cloneFlow_2_0", "summary": "Clone a Flow", "description": "Creates a copy of an existing Flow in a Project.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the cloned flow object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "referenceId": { "type": "string", "format": "uuid" }, "intentTrainGroupReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorAccuracy", "fairAccuracy", "goodAccuracy", "lowDataIntents" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } }, "isTrainingOutOfDate": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "object" }, "attachedFlows": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "attachedLexicons": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "img": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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/flows/{flowId}/removelocalization": { "post": { "operationId": "removeFlowLocalization_2_0", "summary": "Remove a Locale from a Flow", "description": "Removes a Locale from a Flow in a Project.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "Successfully removed localization for flow" }, "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/flows/{flowId}/settings": { "get": { "operationId": "readFlowSettings_2_0", "summary": "Get Flow Settings", "description": "Gets Flow settings, including execution behavior, Slot parsing, Intent mapping, default replies, locale settings, thresholds, Yes/No logic, and Slot usage. All metadata, such as creation and modification timestamps and user information, is also included.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the Flow Settings object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "continueExecutionAfterAttachedFlow": { "type": "boolean" }, "continueExecutionAterDefaultReply": { "type": "boolean" }, "continueExecutionAfterNegativeConfirmation": { "type": "boolean" }, "passDefaultRepliesIntoFlow": { "type": "boolean" }, "flowIntentMappingOrder": { "type": "string", "enum": [ "joint", "main", "attached" ] }, "useAttachedFlowThresholds": { "type": "boolean" }, "useAttachedFlowContinueAfterDefaultReply": { "type": "boolean" }, "useAttachedFlowPassDefaultRepliesIntoFlow": { "type": "boolean" }, "implicitSlotParsing": { "type": "string", "enum": [ "disabled", "full", "system", "lexicon" ] }, "useAttachedFlowImplicitSlotParsing": { "type": "boolean" }, "lexiconSlotsWithSubMatches": { "type": "boolean" }, "useIntentDefaultRepliesAsExamples": { "description": "Enable/Disable using default replies as training examples.", "type": "boolean" }, "localeSettings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inheritFallbackLocaleModel": { "type": "boolean" } } } } } }, "intentThreshold": { "type": "object", "properties": { "lower": { "type": "number", "example": 0.4 }, "upper": { "type": "number", "example": 0.5 } } }, "learnNewExampleSentences": { "type": "boolean" }, "learnNewExampleSentencesThreshold": { "type": "integer" }, "negativeConfirmationWords": { "type": "array", "items": { "type": "string" } }, "positiveConfirmationWords": { "type": "array", "items": { "type": "string" } }, "systemSlots": { "type": "object", "properties": { "useAgeSlots": { "type": "boolean" }, "useDateSlots": { "type": "boolean" }, "useDistanceSlots": { "type": "boolean" }, "useDurationSlots": { "type": "boolean" }, "useEmailSlots": { "type": "boolean" }, "useMoneySlots": { "type": "boolean" }, "useNumberSlots": { "type": "boolean" }, "usePercentageSlots": { "type": "boolean" }, "useTemperatureSlots": { "type": "boolean" }, "useURLSlots": { "type": "boolean" } } }, "yesNoLogic": { "type": "string", "enum": [ "yesNoIntents", "yesNoIntentsWithRules", "confirmationWords" ] }, "yesNoIntentThreshold": { "type": "integer" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateFlowSettings_2_0", "summary": "Update Flow Settings", "description": "Updates Flow settings, including execution behavior, Slot parsing, Intent mapping, default replies, Locale settings, thresholds, Yes/No logic, and Slot usage.", "tags": [ "Flows" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "continueExecutionAfterAttachedFlow": { "type": "boolean" }, "continueExecutionAterDefaultReply": { "type": "boolean" }, "continueExecutionAfterNegativeConfirmation": { "type": "boolean" }, "passDefaultRepliesIntoFlow": { "type": "boolean" }, "flowIntentMappingOrder": { "type": "string", "enum": [ "joint", "main", "attached" ] }, "useAttachedFlowThresholds": { "type": "boolean" }, "useAttachedFlowContinueAfterDefaultReply": { "type": "boolean" }, "useAttachedFlowPassDefaultRepliesIntoFlow": { "type": "boolean" }, "implicitSlotParsing": { "type": "string", "enum": [ "disabled", "full", "system", "lexicon" ] }, "useAttachedFlowImplicitSlotParsing": { "type": "boolean" }, "lexiconSlotsWithSubMatches": { "type": "boolean" }, "useIntentDefaultRepliesAsExamples": { "description": "Enable/Disable using default replies as training examples.", "type": "boolean" }, "localeSettings": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inheritFallbackLocaleModel": { "type": "boolean" } } } } } } } }, "responses": { "204": { "description": "Successfully updated the FlowSettings" }, "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/functions": { "post": { "operationId": "createFunction_2_0", "summary": "Create a Function", "description": "Creates a Function in a Project.", "tags": [ "Functions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "isDisabled": { "type": "boolean" }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns Function metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "isDisabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexFunctions_2_0", "summary": "Get Functions", "description": "Gets Functions from a Project. By default, 25 Functions are returned. To change this value, use the `limit` query parameter.", "tags": [ "Functions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the Function to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns an array of Function metadata objects.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the function", "example": "New Function" }, "code": { "type": "string", "description": "The code of the function", "example": "console.log('Hello World');" }, "referenceId": { "type": "string", "format": "uuid" }, "isDisabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/functions/{functionId}": { "delete": { "operationId": "deleteFunction_2_0", "summary": "Delete a Function", "description": "Deletes a Function from a Project.", "tags": [ "Functions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "functionId", "description": "The Id of the Function", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Successfully kicked-off the delete function operation" }, "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": [] } ] }, "get": { "operationId": "readFunction_2_0", "summary": "Get a Function", "description": "Gets a Function from a Project.", "tags": [ "Functions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "functionId", "description": "The Id of the Function", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Function Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "isDisabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateFunction", "summary": "Update a Function", "description": "Updates a Function in a Project. Allows modifying of a Function’s name, source code, or enabled state. You can also disable the Function without deleting it.", "tags": [ "Functions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "functionId", "description": "The Id of the Function", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "isDisabled": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Successfully updated Function" }, "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/functions/{functionId}/instances": { "get": { "operationId": "indexFunctionInstances_2_0", "summary": "Get Function Instances", "description": "Gets Function instances from a Function. By default, 25 Function instances are returned. To change this value, use the `limit` query parameter.", "tags": [ "Functions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "functionId", "description": "The Id of the Function", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns an array of Function Instance metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "trigger": { "type": "string", "enum": [ "flow", "manual" ], "description": "How was this function instance triggered, e.g. was it spawned while executing a Flow?", "example": "flow" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "error" ], "description": "The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.", "example": "active" }, "error": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "finishedAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/functions/{functionId}/instances/{functionInstanceId}": { "get": { "operationId": "readFunctionInstance_2_0", "summary": "Get a Function Instance", "description": "Gets a Function instance from a Function.", "tags": [ "Functions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "functionId", "description": "The Id of the Function", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "functionInstanceId", "description": "The Id of the Function Instance", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns a Function Instance object", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "functionReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "trigger": { "type": "string", "enum": [ "flow", "manual" ], "description": "How was this function instance triggered, e.g. was it spawned while executing a Flow?", "example": "flow" }, "status": { "type": "string", "enum": [ "queued", "active", "done", "error" ], "description": "The current state of the instance. New instances are in the 'queued' state, while running ones are in 'active' state.", "example": "active" }, "error": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "finishedAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } } } } }, "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/functions/{functionId}/instances/{functionInstanceId}/stop": { "post": { "operationId": "stopFunctionInstance_2_0", "summary": "Stop a Function Instance", "description": "Stops a Function instance. This method immediately halts the running function.", "tags": [ "Functions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "functionId", "description": "The Id of the Function", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "functionInstanceId", "description": "The Id of the Function Instance", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "The stop operation was accepted." }, "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/functions/{functionId}/trigger": { "post": { "operationId": "triggerFunction_2_0", "summary": "Create a Function Instance", "description": "Creates a Function instance. This method triggers the function scheduler to execute the Function immediately.", "tags": [ "Functions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "functionId", "description": "The Id of the Function", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Object with the function instance id.", "content": { "application/json": { "schema": { "type": "object", "properties": { "functionInstanceId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/handover/provider": { "post": { "operationId": "createHandoverProvider", "summary": "Create a Handover Provider", "description": "Creates a handover provider in a Project.", "tags": [ "Handover Providers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "format": "mongoId", "description": "The object id of the handover provider" }, "referenceId": { "type": "string", "description": "The referenceId of the handover provider" }, "organisationId": { "type": "string", "description": "The organisation Id associated with the handover provider" }, "serviceId": { "type": "string", "description": "The id of the service" }, "service": { "type": "string", "description": "The handover provider's specified service; e.g., Live Agent, Genesys" }, "localeId": { "type": "string", "description": "The referenceId of the locale to use" }, "name": { "type": "string", "description": "The name of the handover provider resource" }, "createdAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was created initially" }, "lastChangedAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was last modified" }, "createdBy": { "type": "string", "format": "mongoId", "description": "Id of the user who created the entity initially" }, "lastChangedBy": { "type": "string", "format": "mongoId", "description": "Id of the user who made the last modification" }, "properties": { "type": "array", "items": { "type": "object", "description": "Properties associated with the handover provider", "additionalProperties": { "type": "string" } }, "description": "A list of properties associated with the handover provider" }, "settings": { "type": "object", "description": "Settings related to the handover provider", "additionalProperties": { "type": "string" } }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns the handover provider object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "format": "mongoId", "description": "The object id of the handover provider" }, "referenceId": { "type": "string", "description": "The referenceId of the handover provider" }, "organisationId": { "type": "string", "description": "The organisation Id associated with the handover provider" }, "serviceId": { "type": "string", "description": "The id of the service" }, "service": { "type": "string", "description": "The handover provider's specified service; e.g., Live Agent, Genesys" }, "localeId": { "type": "string", "description": "The referenceId of the locale to use" }, "name": { "type": "string", "description": "The name of the handover provider resource" }, "createdAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was created initially" }, "lastChangedAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was last modified" }, "createdBy": { "type": "string", "format": "mongoId", "description": "Id of the user who created the entity initially" }, "lastChangedBy": { "type": "string", "format": "mongoId", "description": "Id of the user who made the last modification" }, "properties": { "type": "array", "items": { "type": "object", "description": "Properties associated with the handover provider", "additionalProperties": { "type": "string" } }, "description": "A list of properties associated with the handover provider" }, "settings": { "type": "object", "description": "Settings related to the handover provider", "additionalProperties": { "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/handover/provider/{providerId}": { "get": { "operationId": "readHandoverProvider", "summary": "Get a Handover Provider", "description": "Gets a handover provider from a Project.", "tags": [ "Handover Providers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "providerId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns a Handover Provider object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "format": "mongoId", "description": "The object id of the handover provider" }, "referenceId": { "type": "string", "description": "The referenceId of the handover provider" }, "organisationId": { "type": "string", "description": "The organisation Id associated with the handover provider" }, "serviceId": { "type": "string", "description": "The id of the service" }, "service": { "type": "string", "description": "The handover provider's specified service; e.g., Live Agent, Genesys" }, "localeId": { "type": "string", "description": "The referenceId of the locale to use" }, "name": { "type": "string", "description": "The name of the handover provider resource" }, "createdAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was created initially" }, "lastChangedAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was last modified" }, "createdBy": { "type": "string", "format": "mongoId", "description": "Id of the user who created the entity initially" }, "lastChangedBy": { "type": "string", "format": "mongoId", "description": "Id of the user who made the last modification" }, "properties": { "type": "array", "items": { "type": "object", "description": "Properties associated with the handover provider", "additionalProperties": { "type": "string" } }, "description": "A list of properties associated with the handover provider" }, "settings": { "type": "object", "description": "Settings related to the handover provider", "additionalProperties": { "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/handover/providers": { "get": { "operationId": "indexHandoverProvider_2_0", "summary": "Get Handover Providers", "description": "Gets handover providers for a Project.", "tags": [ "Handover Providers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns an array of Handover Provider objects.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "format": "mongoId", "description": "The object id of the handover provider" }, "referenceId": { "type": "string", "description": "The referenceId of the handover provider" }, "organisationId": { "type": "string", "description": "The organisation Id associated with the handover provider" }, "serviceId": { "type": "string", "description": "The id of the service" }, "service": { "type": "string", "description": "The handover provider's specified service; e.g., Live Agent, Genesys" }, "localeId": { "type": "string", "description": "The referenceId of the locale to use" }, "name": { "type": "string", "description": "The name of the handover provider resource" }, "createdAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was created initially" }, "lastChangedAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was last modified" }, "createdBy": { "type": "string", "format": "mongoId", "description": "Id of the user who created the entity initially" }, "lastChangedBy": { "type": "string", "format": "mongoId", "description": "Id of the user who made the last modification" }, "properties": { "type": "array", "items": { "type": "object", "description": "Properties associated with the handover provider", "additionalProperties": { "type": "string" } }, "description": "A list of properties associated with the handover provider" }, "settings": { "type": "object", "description": "Settings related to the handover provider", "additionalProperties": { "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/handover/providers/{providerId}": { "delete": { "operationId": "deleteHandoverProvider", "summary": "Delete a Handover Provider", "description": "Deletes a handover provider from a Project.", "tags": [ "Handover Providers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "providerId", "description": "The Id of handover providers", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The handover provider was successfully deleted." }, "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": [] } ] }, "patch": { "operationId": "updateHandoverProvider", "summary": "Update a Handover Provider", "description": "Updates a handover provider in a Project.", "tags": [ "Handover Providers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "providerId", "description": "The Id of handover providers", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "format": "mongoId", "description": "The object id of the handover provider" }, "referenceId": { "type": "string", "description": "The referenceId of the handover provider" }, "organisationId": { "type": "string", "description": "The organisation Id associated with the handover provider" }, "serviceId": { "type": "string", "description": "The id of the service" }, "service": { "type": "string", "description": "The handover provider's specified service; e.g., Live Agent, Genesys" }, "localeId": { "type": "string", "description": "The referenceId of the locale to use" }, "name": { "type": "string", "description": "The name of the handover provider resource" }, "createdAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was created initially" }, "lastChangedAt": { "type": "integer", "format": "int64", "description": "Unix-timestamp when the entity was last modified" }, "createdBy": { "type": "string", "format": "mongoId", "description": "Id of the user who created the entity initially" }, "lastChangedBy": { "type": "string", "format": "mongoId", "description": "Id of the user who made the last modification" }, "properties": { "type": "array", "items": { "type": "object", "description": "Properties associated with the handover provider", "additionalProperties": { "type": "string" } }, "description": "A list of properties associated with the handover provider" }, "settings": { "type": "object", "description": "Settings related to the handover provider", "additionalProperties": { "type": "string" } } } } } } }, "responses": { "204": { "description": "The handover provider was successfully updated" }, "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/handover/services": { "get": { "operationId": "indexHandoverServices", "summary": "Get Handover Services", "description": "Gets handover services.", "tags": [ "Handover Services" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns an array of Handover Service objects.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "format": "mongoId", "description": "The object id of the handover service" }, "referenceId": { "type": "string", "format": "uuid", "description": "The referenceId of the handover service" }, "version": { "type": "string", "description": "The version of the handover service" }, "name": { "type": "string", "description": "The name of the handover service" }, "serviceUrl": { "type": "string", "format": "uri", "description": "The service URL of the handover service" }, "logoUrl": { "type": "string", "format": "uri", "description": "The logo URL of the handover service" }, "properties": { "type": "array", "items": { "type": "object", "description": "Properties associated with the handover service", "additionalProperties": { "type": "string" } }, "description": "A list of properties for the handover service" } } } } } } } } }, "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/handover/services/{serviceId}": { "get": { "operationId": "readHandoverService", "summary": "Get a Handover Service", "description": "Gets a handover service from a Project.", "tags": [ "Handover Services" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "serviceId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns a Handover Service object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "format": "mongoId", "description": "The object id of the handover service" }, "referenceId": { "type": "string", "format": "uuid", "description": "The referenceId of the handover service" }, "version": { "type": "string", "description": "The version of the handover service" }, "name": { "type": "string", "description": "The name of the handover service" }, "serviceUrl": { "type": "string", "format": "uri", "description": "The service URL of the handover service" }, "logoUrl": { "type": "string", "format": "uri", "description": "The logo URL of the handover service" }, "properties": { "type": "array", "items": { "type": "object", "description": "Properties associated with the handover service", "additionalProperties": { "type": "string" } }, "description": "A list of properties for the handover service" } } } } } }, "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/identityprovider/configure": { "post": { "operationId": "configureIdentityProvider_2_0", "summary": "Set Up an Identity Provider", "description": "Sets up an identity provider (SAML or OIDC) for your organization, including login/logout URLs, certificates, client credentials, and security settings, enabling Single Sign-On (SSO) authentication.", "tags": [ "Identity Providers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "saml" ] }, "idpIssuer": { "type": "string", "description": "The value that will be in the issuer field in the SAML request.", "format": "url" }, "idpLoginEndpoint": { "type": "string", "description": "The URL to use to login in the IDP. Used in the SP initiated Flow.", "format": "url" }, "idpLogoutEndpoint": { "type": "string", "description": "The URL to send SLO requests against. Not all identity providers support this.", "format": "url" }, "idpCertificate": { "type": "string", "description": "The certificate from the ID used to sign the SAML requests. It is base64 encoded." }, "wantAuthnResponseSigned": { "type": "boolean", "description": "If the SAML authentification response should be signed, not all providers support this." }, "decryptionPrivateKey": { "type": "string", "description": "An optional decryption key. This is necessary if the SAML request is encoded." }, "idpDisableRequestedAuthnContext": { "type": "boolean", "description": "For some providers, e.g. Azure on-prem, it might be necessary to disable the authn context field in the SAML request.", "default": false } } }, { "type": "object", "properties": { "idpType": { "type": "string", "enum": [ "oidc" ] }, "idpIssuer": { "type": "string", "description": "The URL of the OIDC identity provider. Must include `https://` to ensure a secure connection. Example `https://accounts.google.com`.", "format": "url" }, "idpClientId": { "type": "string", "description": "The client identifier issued to the client during\nthe registration process.\n\nThe authorization server issues the registered client a client\nidentifier -- a unique string representing the registration\ninformation provided by the client. The client identifier is not\na secret; it is exposed to the resource owner and MUST NOT be\nused alone for client authentication.\n\nThe client identifier is unique to the authorization server.\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\n" }, "idpClientSecret": { "type": "string", "description": "This value is used by Confidential Clients to authenticate to the\nToken Endpoint, as described in Section 2.3.1 of OAuth 2.0, and\nfor the derivation of symmetric encryption key values, as\ndescribed in Section 10.2 of OpenID Connect Core 1.0\n[OpenID.Core].\n\nhttps://tools.ietf.org/html/rfc6749#section-2.3.1\nhttps://openid.net/specs/openid-connect-core-1_0.html#Encryption\n" }, "idpAdditionalScope": { "type": "string", "default": "openid profile email offline_access", "description": "The scopes associated with Access Tokens determine what resources\nwill be available when they are used to access OAuth 2.0\nprotected endpoints.\nFor OpenID Connect, scopes can be used to request that specific\nsets of information be made available as Claim Values.\nThe scopes openid, profile, email and offline_access are always\nrequested.\n" }, "idpFrontChannelLogoutUrl": { "type": "string", "format": "url" }, "idpIdTokenSignedResponseAlg": { "type": "string", "description": "The Algorithm used to sign the ID Token issued to this Client.\n", "enum": [ "RS256", "RS384", "RS512", "HS256", "HS384", "HS512" ], "default": "RS256", "example": "RS256" }, "idpTokenEndpointAuthMethod": { "type": "string", "description": "Requested Client Authentication method for the Token Endpoint.\n\nhttps://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication\n", "enum": [ "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt", "tls_client_auth", "self_signed_tls_client_auth", "none" ], "default": "client_secret_basic", "example": "client_secret_basic" } } } ] } } } }, "responses": { "204": { "description": "The identity provider was configured for your organisation." }, "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/identityprovider/reset": { "post": { "operationId": "resetIdentityProvider_2_0", "summary": "Reset an Identity Provider Setup", "description": "Resets an identity provider setup for the organization by removing the configured identity provider and all related authentication settings. Use this method to clear the existing SSO configuration.", "tags": [ "Identity Providers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "204": { "description": "The identity provider configuration was successfully reset." }, "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/trainer": { "get": { "operationId": "indexTrainerRecords_2_0", "summary": "Get Trainer Records", "description": "Gets [Intent Trainer records](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer) in a Project. By default, 25 Trainer Records are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Intent Trainer" ], "parameters": [ { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 text of the trainer record to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "query", "name": "understood", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, { "in": "query", "name": "intentFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, { "in": "query", "name": "slotFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, { "in": "query", "name": "userSlotsFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, { "in": "query", "name": "systemSlotsFound", "required": false, "schema": { "type": "string", "enum": [ false, true ] } }, { "in": "query", "name": "type", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "Greeting", "pAnswer", "nAnswer", "BGreeting" ] } } }, { "in": "query", "name": "scoreRange", "required": false, "description": "A minimum and maximum range to filter with intent score. Example [0.3,0.6]", "schema": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 } } ], "responses": { "200": { "description": "Returns the Trainer Records with pagination", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the user", "example": "I want a Pizza" }, "count": { "type": "number", "description": "How often the text was used as an input", "example": 2 }, "flowReferenceId": { "type": "string", "format": "uuid" }, "handled": { "type": "boolean" }, "handleAction": { "type": "string", "enum": [ "addedToIntent", "skip", "ignored" ] }, "nlu": { "type": "object", "description": "The last NLU object that was created (from InputObject) based on the message" }, "meta": { "type": "object" }, "snapshotReference": { "type": "string", "description": "Reference to a snapshot in case this record was created because a user talked to a snapshot" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/trainer/{recordId}": { "get": { "operationId": "readTrainerRecord_2_0", "summary": "Get an Intent Trainer Record", "description": "Gets an [Intent Trainer record](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer) from a Project.", "tags": [ "Intent Trainer" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "recordId", "description": "The Id of the Record", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns TrainerRecord Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the user", "example": "I want a Pizza" }, "count": { "type": "number", "description": "How often the text was used as an input", "example": 2 }, "flowReferenceId": { "type": "string", "format": "uuid" }, "handled": { "type": "boolean" }, "handleAction": { "type": "string", "enum": [ "addedToIntent", "skip", "ignored" ] }, "nlu": { "type": "object", "description": "The last NLU object that was created (from InputObject) based on the message" }, "meta": { "type": "object" }, "snapshotReference": { "type": "string", "description": "Reference to a snapshot in case this record was created because a user talked to a snapshot" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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/trainer/batch": { "post": { "operationId": "batchTrainerRecords_2_0", "summary": "Perform Batch Operations on Intent Trainer Records", "description": "Performs batch operations on [Intent Trainer records](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer).", "tags": [ "Intent Trainer" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "operations": { "type": "array", "items": { "type": "object" } } } } } } }, "responses": { "204": { "description": "Successfully run the batch operations." }, "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/trainer/downloadlink": { "post": { "operationId": "composeTrainerRecordsDownloadLink_2_0", "summary": "Create a Download Link for Intent Trainer Records", "description": "Creates a link to download packaged [Intent Trainer records](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer).", "tags": [ "Intent Trainer" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "taskId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "200": { "description": "Returning a link to download the TrainerRecord-Package", "content": { "application/json": { "schema": { "type": "object", "properties": { "downloadLink": { "type": "string", "format": "uri" } } } } } }, "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/trainer/package": { "post": { "operationId": "packageTrainerRecords_2_0", "summary": "Package Intent Trainer Records", "description": "Creates a task that packages [Intent Trainer records](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer).", "tags": [ "Intent Trainer" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "202": { "description": "Successfully created a Task to package TrainerRecords.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/trainer/upload": { "post": { "operationId": "uploadTrainerRecordsPackage_2_0", "summary": "Upload an Intent Trainer Records Package", "description": "Uploads a package with [Intent Trainer records](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer).", "tags": [ "Intent Trainer" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "contentType": "application/gzip" } } } } }, "responses": { "202": { "description": "Succesfully uploaded the TrainerRecords and queued a processing Task.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/flows/{flowId}/intents": { "patch": { "operationId": "batchIntents_2_0", "summary": "Perform Batch Operations on Intents", "description": "Performs batch operations on Intents in a Flow. Use this method to create, update, or delete multiple Intents in a request by specifying the operation type (`create`, `update`, or `delete`) for each item in the operations array.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "properties": { "name": { "type": "string", "example": "OrderFood" }, "description": { "type": "string", "example": "Intent to order food" }, "condition": { "type": "string" }, "rules": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmationSentences": { "type": "array", "items": { "type": "string" } }, "disambiguationSentence": { "type": "string" }, "data": { "type": "object" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "childFeatures": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "example": false }, "biasTowardsParentOrChildIntents": { "type": "string", "enum": [ "parents", "children" ] }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "analyticsLabel": { "type": "string" }, "overrideIntentDefaultRepliesAsExamples": { "type": "string", "description": "Toggle overriding the flow setting for using default replies as training examples", "enum": [ "on", "off", "useFlowSettings" ] } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "properties": { "name": { "type": "string", "example": "OrderFood" }, "description": { "type": "string", "example": "Intent to order food" }, "condition": { "type": "string" }, "rules": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmationSentences": { "type": "array", "items": { "type": "string" } }, "disambiguationSentence": { "type": "string" }, "data": { "type": "object" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "childFeatures": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "example": false }, "biasTowardsParentOrChildIntents": { "type": "string", "enum": [ "parents", "children" ] }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "analyticsLabel": { "type": "string" }, "overrideIntentDefaultRepliesAsExamples": { "type": "string", "description": "Toggle overriding the flow setting for using default replies as training examples", "enum": [ "on", "off", "useFlowSettings" ] } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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": [] } ] }, "post": { "operationId": "createIntent_2_0", "summary": "Create an Intent", "description": "Creates an Intent in a Flow.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "shouldGenerateSentences", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "generateSentenceLimit", "required": false, "schema": { "type": "integer", "minimum": 5, "maximum": 20 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "OrderFood" }, "description": { "type": "string", "example": "Intent to order food" }, "condition": { "type": "string" }, "rules": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmationSentences": { "type": "array", "items": { "type": "string" } }, "disambiguationSentence": { "type": "string" }, "data": { "type": "object" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "childFeatures": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "example": false }, "biasTowardsParentOrChildIntents": { "type": "string", "enum": [ "parents", "children" ] }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "analyticsLabel": { "type": "string" }, "overrideIntentDefaultRepliesAsExamples": { "type": "string", "description": "Toggle overriding the flow setting for using default replies as training examples", "enum": [ "on", "off", "useFlowSettings" ] } } } } } }, "responses": { "201": { "description": "Returns Intent metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "OrderFood" }, "description": { "type": "string", "example": "Intent to order food" }, "condition": { "type": "string" }, "rules": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmationSentences": { "type": "array", "items": { "type": "string" } }, "disambiguationSentence": { "type": "string" }, "data": { "type": "object" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "childFeatures": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "example": false }, "biasTowardsParentOrChildIntents": { "type": "string", "enum": [ "parents", "children" ] }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "analyticsLabel": { "type": "string" }, "overrideIntentDefaultRepliesAsExamples": { "type": "string", "description": "Toggle overriding the flow setting for using default replies as training examples", "enum": [ "on", "off", "useFlowSettings" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexIntents_2_0", "summary": "Get Intents", "description": "Gets Intents from a Flow. By default, 25 Intents are returned. To change this value, use the `limit` query parameter.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the intent to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "query", "name": "parent", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "includeChildren", "required": false, "schema": { "type": "boolean" }, "example": true }, { "in": "query", "name": "includeFeedbackReport", "required": false, "schema": { "type": "boolean" }, "example": false }, { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns array of a Intents metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "referenceId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "example": "OrderFood" }, "description": { "type": "string", "example": "Intent to order food" }, "tags": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorFScore", "fairFScore", "goodFScore", "fewSentences", "unclearIntent", "noSiblings" ] } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "someOverlap", "strongOverlap" ] }, "overlappingIntentReferenceId": { "type": "string" }, "overlappingIntentName": { "type": "string" }, "overlappingIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "overlappingFlowName": { "type": "string" }, "overlappingFlowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lowDataIntents" ] }, "intents": { "type": "array", "items": { "properties": { "intentReferenceId": { "type": "string" }, "intentName": { "type": "string" }, "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "flowName": { "type": "string" }, "flowId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } }, "info": { "type": "object", "properties": { "fScore": { "type": "number" } } } } } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/flows/{flowId}/intents/{intentId}": { "delete": { "operationId": "deleteIntent_2_0", "summary": "Delete an Intent", "description": "Deletes an Intent from a Flow.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The Intent was deleted successfully." }, "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": [] } ] }, "get": { "operationId": "readIntent_2_0", "summary": "Get an Intent", "description": "Gets an Intent from a Flow.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns an Intent object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "OrderFood" }, "description": { "type": "string", "example": "Intent to order food" }, "condition": { "type": "string" }, "rules": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmationSentences": { "type": "array", "items": { "type": "string" } }, "disambiguationSentence": { "type": "string" }, "data": { "type": "object" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "childFeatures": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "example": false }, "biasTowardsParentOrChildIntents": { "type": "string", "enum": [ "parents", "children" ] }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "analyticsLabel": { "type": "string" }, "overrideIntentDefaultRepliesAsExamples": { "type": "string", "description": "Toggle overriding the flow setting for using default replies as training examples", "enum": [ "on", "off", "useFlowSettings" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateIntent_2_0", "summary": "Update an Intent", "description": "Update an Intent in a Flow. Allows modifying of an Intent's name, description, rules, tags, and status. You can also enable or disable the Intent, mark it as a reject Intent, adjust child/parent intent relationships, and override default reply settings.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "OrderFood" }, "description": { "type": "string", "example": "Intent to order food" }, "condition": { "type": "string" }, "rules": { "type": "array", "items": { "type": "string" } }, "isRejectIntent": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "confirmationSentences": { "type": "array", "items": { "type": "string" } }, "disambiguationSentence": { "type": "string" }, "data": { "type": "object" }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "childFeatures": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "example": false }, "biasTowardsParentOrChildIntents": { "type": "string", "enum": [ "parents", "children" ] }, "parentIntentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "analyticsLabel": { "type": "string" }, "overrideIntentDefaultRepliesAsExamples": { "type": "string", "description": "Toggle overriding the flow setting for using default replies as training examples", "enum": [ "on", "off", "useFlowSettings" ] } } } } } }, "responses": { "204": { "description": "Successfully updated Intent" }, "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/flows/{flowId}/intents/{intentId}/addlocalization": { "post": { "operationId": "addIntentLocalization_2_0", "summary": "Localize an Intent", "description": "Adds a localized version of an Intent in a Flow. You can specify the target Locale, optionally inherit content from another Locale, and provide translation settings to adapt the Intent for different languages or regions.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "inheritFromLocaleId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "intentTranslationSettings": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Successfully added localization for the intent" }, "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/flows/{flowId}/intents/{intentId}/removelocalization": { "post": { "operationId": "removeIntentLocalization_2_0", "summary": "Delete Intent Localization", "description": "Deletes a localization from an Intent. Use this method to delete translations or Locale-specific data associated with the Intent.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "localeId": { "type": "string" } } } } } }, "responses": { "204": { "description": "Successfully removed localization for the intent" }, "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/flows/{flowId}/intents/export": { "post": { "operationId": "exportIntents_2_0", "summary": "Export Intents", "description": "Exports the Intents of a Flow. You can specify a Locale and select the export format, CSV or JSON file.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "format": { "type": "string", "enum": [ "csv", "json" ] } } } } } }, "responses": { "200": { "description": "Returns exported lexicon data in specified type.", "content": { "text/csv": { "schema": { "type": "string", "description": "Stringified CSV or JSON.", "example": "" } } } }, "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/flows/{flowId}/intents/import": { "post": { "operationId": "importIntents_2_0", "summary": "Upload Intents", "description": "Uploads Intents and creates a Task to import the Intents. The supported file format is CSV.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "localeId": { "type": "string" }, "mode": { "type": "string", "enum": [ "skip", "overwrite", "merge" ] } } } } } }, "responses": { "202": { "description": "Successfully uploaded the Intents and created a Task to import the Intents.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/flows/{flowId}/intents/train": { "post": { "operationId": "trainIntents_2_0", "summary": "Train Intents", "description": "Starts a Task to train the Intents of a Flow.", "tags": [ "Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "Filter records by specific field eg:name." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "mode": { "type": "string", "enum": [ "full", "quick" ] } } } } } }, "responses": { "202": { "description": "The Intents were successfully queued for training.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/knowledgestores/{knowledgeStoreId}/sources/{sourceId}/chunks": { "post": { "operationId": "createKnowledgeChunk_2_0", "summary": "Create a Knowledge Chunk", "description": "Creates a Knowledge Chunk in a Knowledge Resource.", "tags": [ "Knowledge Chunks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sourceId", "description": "The Id of the KnowledgeSource", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "number", "example": 1, "description": "The name of the KnowledgeChunk" }, "text": { "type": "string", "example": "This is a paragraph from an article", "description": "The text that is the actual content of the chunk" }, "data": { "type": "object", "description": "The extended data of KnowledgeChunk" } } } } } }, "responses": { "201": { "description": "Returns KnowledgeChunk metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "number", "example": 1, "description": "The name of the KnowledgeChunk" }, "text": { "type": "string", "example": "This is a paragraph from an article", "description": "The text that is the actual content of the chunk" }, "data": { "type": "object", "description": "The extended data of KnowledgeChunk" }, "disabled": { "type": "boolean", "enum": [ false, true ], "description": "The status to check if knowledge chunk is disabled" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexKnowledgeChunks_2_0", "summary": "Get Knowledge Chunks", "description": "Gets Knowledge Chunks from a Knowledge Source. By default, 25 Knowledge Chunks are returned. To change this value, use the `limit` query parameter.", "tags": [ "Knowledge Chunks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sourceId", "description": "The Id of the KnowledgeSource", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The text of the knowledge chunk to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns an array of KnowledgeChunk metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number", "example": 1, "description": "The name of the KnowledgeChunk" }, "text": { "type": "string", "example": "This is a paragraph from an article", "description": "The text that is the actual content of the chunk" }, "data": { "type": "object", "description": "The extended data of KnowledgeChunk" }, "disabled": { "type": "boolean", "enum": [ false, true ], "description": "The status to check if knowledge chunk is disabled" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/knowledgestores/{knowledgeStoreId}/sources/{sourceId}/chunks/{chunkId}": { "delete": { "operationId": "deleteKnowledgeChunk_2_0", "summary": "Delete a Knowledge Chunk", "description": "Deletes a Knowledge Chunk from a Knowledge Source.", "tags": [ "Knowledge Chunks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sourceId", "description": "The Id of the KnowledgeSource", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "chunkId", "description": "The Id of the KnowledgeChunk", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted KnowledgeChunk" }, "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": [] } ] }, "get": { "operationId": "readKnowledgeChunk_2_0", "summary": "Get a Knowledge Chunk", "description": "Gets a Knowledge Chunk from a Knowledge Source.", "tags": [ "Knowledge Chunks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sourceId", "description": "The Id of the KnowledgeSource", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "chunkId", "description": "The Id of the KnowledgeChunk", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns KnowledgeChunk object", "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "number", "example": 1, "description": "The name of the KnowledgeChunk" }, "text": { "type": "string", "example": "This is a paragraph from an article", "description": "The text that is the actual content of the chunk" }, "data": { "type": "object", "description": "The extended data of KnowledgeChunk" }, "disabled": { "type": "boolean", "enum": [ false, true ], "description": "The status to check if knowledge chunk is disabled" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateKnowledgeChunk_2_0", "summary": "Update a Knowledge Chunk", "description": "Updates a Knowledge Chunk in a Knowledge Source. Allows modifying the Chunk's text, data, order, and status.", "tags": [ "Knowledge Chunks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sourceId", "description": "The Id of the KnowledgeSource", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "chunkId", "description": "The Id of the KnowledgeChunk", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "type": "number", "example": 1, "description": "The name of the KnowledgeChunk" }, "text": { "type": "string", "example": "This is a paragraph from an article", "description": "The text that is the actual content of the chunk" }, "data": { "type": "object", "description": "The extended data of KnowledgeChunk" }, "disabled": { "type": "boolean", "enum": [ false, true ], "description": "The status to check if knowledge chunk is disabled" } } } } } }, "responses": { "204": { "description": "Successfully updated knowledge source" }, "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/knowledgestores/{knowledgeStoreId}/connectors": { "post": { "operationId": "createKnowledgeConnector_2_0", "summary": "Create a Knowledge Connector", "description": "Creates a Knowledge Connector.", "tags": [ "Knowledge Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "extension": { "type": "string", "description": "The name of the extension", "example": "confluence" }, "version": { "type": "string", "description": "The version of extension identifier", "example": "1.1.0" }, "type": { "type": "string", "description": "The Knowledge Connector type identifier within an extension", "example": "MyConfluenceConnector" }, "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } } } } } } }, "responses": { "201": { "description": "Returns KnowledgeSource metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "extension": { "type": "string", "description": "The name of the extension", "example": "confluence" }, "version": { "type": "string", "description": "The version of extension identifier", "example": "1.1.0" }, "type": { "type": "string", "description": "The Knowledge Connector type identifier within an extension", "example": "MyConfluenceConnector" }, "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "start": { "description": "Start date and time to calculate scheduled execution, set internally", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "totalMinutes": { "type": "number", "description": "Total minutes for the scheduled execution, set internally", "example": 1 }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "timezone": { "type": "string", "description": "Timezone for the scheduled execution in UTC, set internally", "example": "UTC" }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } }, "lastExecution": { "description": "Unix-timestamp when the last execution was triggered or null if never executed", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastExecutionStatus": { "type": "string", "description": "Last execution status of the KnowledgeConnector", "enum": [ "none", "queued", "active", "done", "error" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexKnowledgeConnector_2_0", "summary": "Get Knowledge Connectors", "description": "Gets a list of Knowledge Connectors.", "tags": [ "Knowledge Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the knowledge connector to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a KnowledgeStore metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "extension": { "type": "string", "description": "The name of the extension", "example": "confluence" }, "version": { "type": "string", "description": "The version of extension identifier", "example": "1.1.0" }, "type": { "type": "string", "description": "The Knowledge Connector type identifier within an extension", "example": "MyConfluenceConnector" }, "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "start": { "description": "Start date and time to calculate scheduled execution, set internally", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "totalMinutes": { "type": "number", "description": "Total minutes for the scheduled execution, set internally", "example": 1 }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "timezone": { "type": "string", "description": "Timezone for the scheduled execution in UTC, set internally", "example": "UTC" }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } }, "lastExecution": { "description": "Unix-timestamp when the last execution was triggered or null if never executed", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastExecutionStatus": { "type": "string", "description": "Last execution status of the KnowledgeConnector", "enum": [ "none", "queued", "active", "done", "error" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/knowledgestores/{knowledgeStoreId}/connectors/{connectorId}": { "delete": { "operationId": "deleteKnowledgeConnector_2_0", "summary": "Delete a Knowledge Connector", "description": "Deletes a Knowledge Connector from a Knowledge Store.", "tags": [ "Knowledge Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "connectorId", "description": "The Id of the KnowledgeConnector", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The Knowledge Connector was successfully deleted." }, "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": [] } ] }, "get": { "operationId": "readKnowledgeConnector_2_0", "summary": "Get a Knowledge Connector", "description": "Gets a Knowledge Connector from a Project.", "tags": [ "Knowledge Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "connectorId", "description": "The Id of the KnowledgeConnector", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the Knowledge Connector object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "extension": { "type": "string", "description": "The name of the extension", "example": "confluence" }, "version": { "type": "string", "description": "The version of extension identifier", "example": "1.1.0" }, "type": { "type": "string", "description": "The Knowledge Connector type identifier within an extension", "example": "MyConfluenceConnector" }, "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "start": { "description": "Start date and time to calculate scheduled execution, set internally", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "totalMinutes": { "type": "number", "description": "Total minutes for the scheduled execution, set internally", "example": 1 }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "timezone": { "type": "string", "description": "Timezone for the scheduled execution in UTC, set internally", "example": "UTC" }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } }, "lastExecution": { "description": "Unix-timestamp when the last execution was triggered or null if never executed", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastExecutionStatus": { "type": "string", "description": "Last execution status of the KnowledgeConnector", "enum": [ "none", "queued", "active", "done", "error" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateKnowledgeConnector_2_0", "summary": "Update a Knowledge Connector", "description": "Updates a Knowledge Connector resource in a Project. Allows modifying a Knowledge Connector’s configuration and name.", "tags": [ "Knowledge Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "connectorId", "description": "The Id of the KnowledgeConnector", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } } } } } } }, "responses": { "204": { "description": "Successfully updated knowledge connector" }, "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/knowledgestores/{knowledgeStoreId}/connectors/{connectorId}/run": { "post": { "operationId": "runKnowledgeConnector_2_0", "summary": "Run a Knowledge Connector", "description": "Runs a Knowledge Connector to extract and import knowledge from external sources.", "tags": [ "Knowledge Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "connectorId", "description": "The Id of the KnowledgeConnector", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "201": { "description": "Returns the Knowledge Connector metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "extension": { "type": "string", "description": "The name of the extension", "example": "confluence" }, "version": { "type": "string", "description": "The version of extension identifier", "example": "1.1.0" }, "type": { "type": "string", "description": "The Knowledge Connector type identifier within an extension", "example": "MyConfluenceConnector" }, "config": { "type": "object", "description": "The configuration of the KnowledgeConnector" }, "name": { "type": "string", "description": "The name of the KnowledgeConnector", "example": "My Knowledge Connector" }, "schedule": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If scheduled execution is enabled or not", "example": true }, "start": { "description": "Start date and time to calculate scheduled execution, set internally", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "totalMinutes": { "type": "number", "description": "Total minutes for the scheduled execution, set internally", "example": 1 }, "hour": { "type": "number", "description": "Hour to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "minute": { "type": "number", "description": "Minute to start the scheduled execution, in UTC, set 0 or any value if schedule is disabled", "example": 1 }, "timezone": { "type": "string", "description": "Timezone for the scheduled execution in UTC, set internally", "example": "UTC" }, "weekDays": { "type": "array", "items": { "type": "number" }, "description": "Repeat x days of the week, Sunday = 0 ... Saturday = 6", "example": [ 0, 3 ] } } }, "lastExecution": { "description": "Unix-timestamp when the last execution was triggered or null if never executed", "type": "integer", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastExecutionStatus": { "type": "string", "description": "Last execution status of the KnowledgeConnector", "enum": [ "none", "queued", "active", "done", "error" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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/knowledgestores/{knowledgeStoreId}/descriptors": { "get": { "operationId": "indexKnowledgeDescriptors_2_0", "summary": "Get Knowledge Connectors", "description": "Gets information about the Knowledge Connectors from a Project.", "tags": [ "Knowledge Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns an array of Knowledge Connector metadata objects.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "label": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Knowledge of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Knowledge of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Knowledge is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule", "json", "checkbox", "time", "date", "datetime", "select", "xml", "textArray", "chipInput", "toggle", "slider", "number", "daterange", "connection", "condition", "description" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } }, "extension": { "type": "string", "description": "The extension name that this knowledge descriptor belongs to" }, "version": { "type": "string", "description": "The version of the extension that this knowledge descriptor belongs to" }, "extensionImg": { "type": "string", "description": "The image URL of the extension that this knowledge descriptor belongs to" } } } }, "total": { "type": "integer", "example": 1 }, "next": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previous": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/knowledgestores/{knowledgeStoreId}/extensions/run": { "post": { "operationId": "runKnowledgeExtension_2_0", "summary": "Run a Knowledge Extension", "description": "Runs a Knowledge Extension to extract and import knowledge from external sources.", "tags": [ "Knowledge Sources", "Knowledge Stores" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "extension": { "type": "string" }, "type": { "type": "string" }, "updateKnowledge": { "type": "boolean" }, "config": { "type": "object" } } } } } }, "responses": { "201": { "description": "Returns KnowledgeSource metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "type": { "type": "string", "enum": [ "url", "manual", "pdf", "txt", "ctxt", "extension" ], "description": "The type of source for the Knowledge store" }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "example": "tag1" } } } }, "data": { "type": "object", "additionalProperties": true, "description": "Custom metadata object to store additional information in the KnowledgeSource", "example": { "_id": "x4xU6hMntv23p", "sys_CreatedAt": "2019-12-16T11:40:45.7212", "sys_UpdatedAt": "2025-10-01T07:46:04.5932", "Type": "FAQ" } }, "chunkCount": { "type": "integer" }, "status": { "type": "string", "enum": [ "ready", "ingesting", "disabled" ] }, "connectorReference": { "type": "string", "format": "uuid", "description": "The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type \"extension\"" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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/knowledgestores/{knowledgeStoreId}/sources": { "post": { "operationId": "createKnowledgeSource_2_0", "summary": "Create a Knowledge Source", "description": "Creates a Knowledge Source in a Knowledge Store. You define the source metadata and type—no file is uploaded. Use this method for manual sources, URL sources (for web scraping), or when creating the source first and ingesting content later (pdf, txt, ctxt).", "tags": [ "Knowledge Sources" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "type": { "type": "string", "enum": [ "url", "manual", "pdf", "txt", "ctxt", "extension" ], "description": "The type of source for the Knowledge store" }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "example": "tag1" } } } }, "url": { "type": "string", "example": "https://www.some-article.com", "description": "The url of the website to scrape the data from. This is only applicable for KnowledgeSources of type \"url\"" } } }, { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "type": { "type": "string", "enum": [ "url", "manual", "pdf", "txt", "ctxt", "extension" ], "description": "The type of source for the Knowledge store" }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "example": "tag1" } } } }, "connectorId": { "type": "string", "format": "uuid", "description": "The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type \"extension\"" } }, "example": { "name": "mysource", "description": "mysource description", "type": "extension", "metaData": { "tags": [ "tag1" ] }, "connectorId": "uuid" } } ] } } } }, "responses": { "201": { "description": "Returns KnowledgeSource metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "knowledgeSource": { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "type": { "type": "string", "enum": [ "url", "manual", "pdf", "txt", "ctxt", "extension" ], "description": "The type of source for the Knowledge store" }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "example": "tag1" } } } }, "data": { "type": "object", "additionalProperties": true, "description": "Custom metadata object to store additional information in the KnowledgeSource", "example": { "_id": "x4xU6hMntv23p", "sys_CreatedAt": "2019-12-16T11:40:45.7212", "sys_UpdatedAt": "2025-10-01T07:46:04.5932", "Type": "FAQ" } }, "chunkCount": { "type": "integer" }, "status": { "type": "string", "enum": [ "ready", "ingesting", "disabled" ] }, "connectorReference": { "type": "string", "format": "uuid", "description": "The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type \"extension\"" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } } } }, "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": [] } ] }, "get": { "operationId": "indexKnowledgeSources_2_0", "summary": "Get Knowledge Sources", "description": "Gets Knowledge Sources from a Knowledge Store. By default, 25 Knowledge Sources are returned. You can change this number using the `limit` parameter.", "tags": [ "Knowledge Sources" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the knowledge source to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a KnowledgeSource metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "type": { "type": "string", "enum": [ "url", "manual", "pdf", "txt", "ctxt", "extension" ], "description": "The type of source for the Knowledge store" }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "example": "tag1" } } } }, "data": { "type": "object", "additionalProperties": true, "description": "Custom metadata object to store additional information in the KnowledgeSource", "example": { "_id": "x4xU6hMntv23p", "sys_CreatedAt": "2019-12-16T11:40:45.7212", "sys_UpdatedAt": "2025-10-01T07:46:04.5932", "Type": "FAQ" } }, "chunkCount": { "type": "integer" }, "status": { "type": "string", "enum": [ "ready", "ingesting", "disabled" ] }, "connectorReference": { "type": "string", "format": "uuid", "description": "The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type \"extension\"" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/knowledgestores/{knowledgeStoreId}/sources/{sourceId}": { "delete": { "operationId": "deleteKnowledgeSource_2_0", "summary": "Delete a Knowledge Source", "description": "Deletes a Knowledge Source from a Knowledge Store.", "tags": [ "Knowledge Sources" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sourceId", "description": "The Id of the KnowledgeSource", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted KnowledgeSource" }, "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": [] } ] }, "get": { "operationId": "readKnowledgeSource_2_0", "summary": "Get a Knowledge Source", "description": "Gets a Knowledge Source from a Knowledge Store.", "tags": [ "Knowledge Sources" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sourceId", "description": "The Id of the KnowledgeSource", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns KnowledgeSource object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "type": { "type": "string", "enum": [ "url", "manual", "pdf", "txt", "ctxt", "extension" ], "description": "The type of source for the Knowledge store" }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "example": "tag1" } } } }, "data": { "type": "object", "additionalProperties": true, "description": "Custom metadata object to store additional information in the KnowledgeSource", "example": { "_id": "x4xU6hMntv23p", "sys_CreatedAt": "2019-12-16T11:40:45.7212", "sys_UpdatedAt": "2025-10-01T07:46:04.5932", "Type": "FAQ" } }, "chunkCount": { "type": "integer" }, "status": { "type": "string", "enum": [ "ready", "ingesting", "disabled" ] }, "connectorReference": { "type": "string", "format": "uuid", "description": "The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type \"extension\"" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateKnowledgeSource_2_0", "summary": "Updates a Knowledge Source", "description": "Updates a Knowledge Source in a Knowledge Store. Allows modifying a Source's name, description, status, and metadata.", "tags": [ "Knowledge Sources" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sourceId", "description": "The Id of the KnowledgeSource", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "mysource", "description": "The name of the KnowledgeSource" }, "description": { "type": "string", "example": "mysource description", "description": "The description about what the knowledge source contains" }, "status": { "type": "string", "enum": [ "ready", "ingesting", "disabled" ] }, "metaData": { "type": "object", "properties": { "tags": { "type": "array", "description": "Array of tags to replace the existing tags", "items": { "type": "string", "example": "tag1" } } } } } } } } }, "responses": { "204": { "description": "Successfully updated knowledge source" }, "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/knowledgestores/{knowledgeStoreId}/sources/upload": { "post": { "operationId": "uploadKnowledgeSourceFile_2_0", "summary": "Create a Knowledge Source from a File", "description": "Creates a Knowledge Source in the Knowledge Store by uploading a file and asynchronously ingesting its content. Supported file formats pdf, txt, ctxt.", "tags": [ "Knowledge Sources" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "tags": { "type": "string", "description": "A comma separated list of tags for the KnowledgeSource" }, "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "202": { "description": "Successfully uploaded the file and created a Task to process it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/knowledgestores": { "post": { "operationId": "createKnowledgeStore_2_0", "summary": "Create a Knowledge Store", "description": "Creates a Knowledge Store in a Project.", "tags": [ "Knowledge Stores" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "mystore", "description": "The name of the KnowledgeStore" }, "description": { "type": "string", "example": "mystore description", "description": "The description about what the knowledge store contains" }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns KnowledgeStore metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "mystore", "description": "The name of the KnowledgeStore" }, "description": { "type": "string", "example": "mystore description", "description": "The description about what the knowledge store contains" }, "language": { "type": "string", "example": "en-US", "description": "The language code" }, "status": { "type": "string", "enum": [ "ready", "warning" ] }, "documents": { "type": "array", "items": { "type": "string", "example": "https://some-website.com/knowledgebase.txt", "description": "The document url or the file name ingested for the knowledge store" } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexKnowledgeStores_2_0", "summary": "Get Knowledge Stores", "description": "Gets Knowledge Stores from a Project. By default, 25 Knowledge Stores are returned. To change this value, use the `limit` query parameter.", "tags": [ "Knowledge Stores" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the knowledge store to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns an array of Knowledge Store metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "mystore", "description": "The name of the KnowledgeStore" }, "description": { "type": "string", "example": "mystore description", "description": "The description about what the knowledge store contains" }, "language": { "type": "string", "example": "en-US", "description": "The language code" }, "status": { "type": "string", "enum": [ "ready", "warning" ] }, "documents": { "type": "array", "items": { "type": "string", "example": "https://some-website.com/knowledgebase.txt", "description": "The document url or the file name ingested for the knowledge store" } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/knowledgestores/{knowledgeStoreId}": { "delete": { "operationId": "deleteKnowledgeStore_2_0", "summary": "Delete a Knowledge Store", "description": "Deletes a Knowledge Store from a Project.", "tags": [ "Knowledge Stores" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "documentUrl", "required": false, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully deleted the Knowledge Store." }, "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": [] } ] }, "get": { "operationId": "readKnowledgeStore_2_0", "summary": "Get a Knowledge Store", "description": "Gets a Knowledge Store from a Project.", "tags": [ "Knowledge Stores" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the Knowledge Store object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "mystore", "description": "The name of the KnowledgeStore" }, "description": { "type": "string", "example": "mystore description", "description": "The description about what the knowledge store contains" }, "language": { "type": "string", "example": "en-US", "description": "The language code" }, "status": { "type": "string", "enum": [ "ready", "warning" ] }, "documents": { "type": "array", "items": { "type": "string", "example": "https://some-website.com/knowledgebase.txt", "description": "The document url or the file name ingested for the knowledge store" } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateKnowledgeStore_2_0", "summary": "Update a Knowledge Store", "description": "Updates a Knowledge Store in a Project. Allows modifying a Store's name and description.", "tags": [ "Knowledge Stores" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "knowledgeStoreId", "description": "The Id of the KnowledgeStore", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "mystore", "description": "The name of the KnowledgeStore" }, "description": { "type": "string", "example": "mystore description", "description": "The description about what the knowledge store contains" } } } } } }, "responses": { "204": { "description": "Successfully updated knowledge store" }, "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/largelanguagemodels": { "post": { "operationId": "createLargeLanguageModel_2_0", "summary": "Create an LLM", "description": "Creates an LLM. The LLM can have the following scopes:\n- Project (`resourceLevel: 'project'`)\n- Global (`resourceLevel: 'organisation'`)\n\nDepending on the scope, different fields are required or must be excluded:\n- **Project-level resources**: `projectId` is required.\n- **Global resources**: `isDefault` and `fallback` must be excluded.\n", "tags": [ "Large Language Models" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "discriminator": { "propertyName": "resourceLevel", "mapping": { "project": "#/components/schemas/projectResource", "organisation": "#/components/schemas/globalResource" } }, "oneOf": [ { "title": " Global LLM Resource", "type": "object", "required": [ "name", "modelType", "provider", "connectionId", "resourceLevel" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] } } }, { "title": " Project Level LLM Resource", "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "fallbacks": { "type": "array", "description": "(alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.", "items": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" } }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } ] } } } }, "responses": { "201": { "description": "Returns LargeLanguageModel metadata object.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "name", "modelType", "provider", "connectionId", "resourceLevel" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, { "oneOf": [ { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "fallbacks": { "type": "array", "description": "(alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.", "items": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" } }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, { "type": "object", "required": [ "name", "modelType", "provider", "connectionId", "resourceLevel" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } ] } ] } } } }, "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": [] } ] }, "get": { "operationId": "indexLargeLanguageModels_2_0", "summary": "Get LLMs", "description": "Gets [LLMs](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms) in a Project. By default, 25 LLMs are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Large Language Models" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "Filter records by specific field eg:name." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "query", "name": "resourceLevel", "description": "Scope of the resource (global \"organisation\" or project).", "required": false, "schema": { "type": "string", "enum": [ "organisation", "project" ], "description": "General scope of the resource.", "default": "project" } } ], "responses": { "200": { "description": "Returns array of a LargeLanguageModel metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "fallbacks": { "type": "array", "description": "(alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.", "items": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" } }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, { "type": "object", "required": [ "name", "modelType", "provider", "connectionId", "resourceLevel" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } ] } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/largelanguagemodels/{largeLanguageModelId}": { "delete": { "operationId": "deleteLargeLanguageModel_2_0", "summary": "Delete an LLM", "description": "Deletes an [LLM](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms) from a Project.", "tags": [ "Large Language Models" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "largeLanguageModelId", "description": "Id for the LargeLanguageModel", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted LargeLanguageModel" }, "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": [] } ] }, "get": { "operationId": "readLargeLanguageModel_2_0", "summary": "Get an LLM", "description": "Gets data about an [LLM](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms).", "tags": [ "Large Language Models" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "largeLanguageModelId", "description": "Id for the LargeLanguageModel", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns LargeLanguageModel object", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "fallbacks": { "type": "array", "description": "(alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.", "items": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" } }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, { "type": "object", "required": [ "name", "modelType", "provider", "connectionId", "resourceLevel" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } ] } } } }, "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": [] } ] }, "patch": { "operationId": "updateLargeLanguageModel_2_0", "summary": "Update an LLM", "description": "Updates an [LLM](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms#large-language-models-llms).", "tags": [ "Large Language Models" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "largeLanguageModelId", "description": "Id for the LargeLanguageModel", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false } } } } } }, "responses": { "204": { "description": "Successfully updated LLM" }, "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/largelanguagemodels/{largeLanguageModelId}/availablemodels": { "get": { "operationId": "getAvailableModelsForLLM_2_0", "summary": "Get Models for an LLM Provider", "description": "Gets the available models for an LLM provider. Returns an empty array if the provider doesn't support model listing.", "tags": [ "Large Language Models" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "largeLanguageModelId", "description": "Id for the LargeLanguageModel", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "connectionRefId", "required": true, "schema": { "type": "string" }, "description": "Connection reference id." } ], "responses": { "200": { "description": "List with all the available models for that LLM.", "content": { "application/json": { "schema": { "type": "object", "properties": { "availableModels": { "type": "array", "items": { "type": "object", "properties": { "modelName": { "type": "string" }, "modelId": { "type": "string" }, "providerName": { "type": "array" } } } } } } } } }, "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/largelanguagemodels/{largeLanguageModelId}/clone": { "post": { "operationId": "cloneLargeLanguageModel_2_0", "summary": "Clone an LLM", "description": "Clones an [LLM](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms) in a Project.", "tags": [ "Large Language Models" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "largeLanguageModelId", "description": "Id for the LargeLanguageModel", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "201": { "description": "Returns the cloned largeLanguageModel object.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "name", "modelType", "provider", "connectionId" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "project" ], "description": "Scope for project-level resources." }, "isDefault": { "type": "boolean", "description": "Sets the LLM to default (fallback) if no other LLM is set", "example": false }, "fallbacks": { "type": "array", "description": "(alpha feature) specifies a fallback LLM that will be used when the current LLM stops working.", "items": { "type": "object", "properties": { "isFallbackEnabled": { "type": "boolean", "description": "A flag that indicates whether the fallback configuration should be considered at all" }, "fallbackLLMReferenceId": { "type": "string", "description": "The reference id of an existing largeLanguageModel" }, "immediateFallBack": { "type": "object", "properties": { "failedRequests": { "type": "number", "description": "Number of failed requests to trigger the fallback LLM as 1st choice" }, "durationInMinutes": { "type": "number", "description": "Duration in minutes for which the fallback LLM should be used as 1st choice" }, "emailNotificationList": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses to notify when fallback is triggered" } } } }, "description": "Configuration for LLM fallback" } }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" }, { "type": "object", "required": [ "name", "modelType", "provider", "connectionId", "resourceLevel" ], "properties": { "name": { "type": "string", "example": "LLM Name" }, "description": { "type": "string", "example": "LLM meaningful description" }, "modelType": { "type": "string", "enum": [ "gpt-3.5-turbo", "gpt-3.5-turbo-instruct", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-5", "gpt-5-nano", "gpt-5-mini", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5-chat-latest", "gpt-5.1", "gpt-5.2", "gpt-5.4", "text-embedding-ada-002", "luminous-extended-control", "luminous-embedding-128", "Pharia-1-Embedding-4608", "gemini-embedding-001", "claude-3-opus-20240229", "claude-sonnet-4-6", "custom-model", "custom-embedding-model", "gemini-2.0-flash", "gemini-2.0-flash-lite", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "mistral-large-2411", "mistral-small-2503", "pixtral-large-2411", "pixtral-12b-2409" ] }, "modelGroup": { "type": "string", "enum": [ "chat", "completion", "embedding" ] }, "isCustomModel": { "type": "boolean", "example": true }, "provider": { "type": "string", "enum": [ "azureOpenAI", "openAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] }, "connectionId": { "type": "string", "description": "The reference id of the GenerativeAI Provider Connection", "format": "uuid" }, "openAI": { "type": "object", "description": "OpenAI specific meta data", "properties": { "customModel": { "type": "string", "example": "gpt-4-32k-0613", "description": "The custom model name. This does not work with embedding models" } } }, "anthropic": { "type": "object", "description": "Anthropic specific meta data", "properties": { "customModel": { "type": "string", "example": "claude-opus-4-0", "description": "The custom model name. This does not work with embedding models" } } }, "azureOpenAI": { "type": "object", "description": "Azure OpenAI specific meta data", "properties": { "resourceName": { "type": "string" }, "deploymentName": { "type": "string" }, "apiVersion": { "type": "string" }, "baseCustomUrl": { "type": "string", "example": [ "https://.openai.azure.com/openai/deployments//chat/completions?api-version=", "https://.openai.azure.com/openai/deployments//completions?api-version=", "https://.openai.azure.com/openai/deployments//embeddings?api-version=" ] } } }, "googleVertexAI": { "type": "object", "description": "Google VertexAI specific meta data", "properties": { "location": { "type": "string" }, "apiEndpoint": { "type": "string" }, "publisher": { "type": "string" } } }, "googleGemini": { "type": "object", "description": "Google Gemini specific meta data", "properties": { "location": { "type": "string" } } }, "alephAlpha": { "type": "object", "description": "Aleph Alpha specific meta data", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://api.aleph-alpha.com" } } }, "openAICompatible": { "type": "object", "description": "OpenAI compatible provider", "properties": { "customModel": { "type": "string", "example": "luminous-003", "description": "The custom model name. This does not work with embedding models" }, "baseCustomUrl": { "type": "string", "example": "https://own-llm-deployment.company.com/openai/v1" }, "customAuthHeader": { "type": "string", "example": "Ocp-Apim-Subscription-Key", "description": "The api key will be sent via this http header if specified" } } }, "resourceLevel": { "type": "string", "enum": [ "organisation" ], "description": "Scope for globally scoped resources." }, "assignedToProjects": { "type": "array", "items": { "type": "string", "description": "MongoDB ObjectId representing a project" }, "example": [ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ] }, "referenceId": { "type": "string", "description": "The reference id of the LargeLanguageModel", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } ] } } } }, "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/largelanguagemodels/{largeLanguageModelId}/test": { "post": { "operationId": "testLargeLanguageModel_2_0", "summary": "Test LLM Connection", "description": "Tests the connection to the LLM provider by validating the credentials.", "tags": [ "Large Language Models" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "largeLanguageModelId", "description": "Id for the LargeLanguageModel", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "projectId" ], "properties": { "projectId": { "type": "string" } } } } } }, "responses": { "200": { "description": "Credentials have been validated and the connection was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "voiceProvider": { "type": "string" }, "isCredentialsValid": { "type": "boolean" }, "msg": { "type": "string" }, "msgErr": { "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/lexicons": { "patch": { "operationId": "batchLexicons_2_0", "summary": "Perform Batch Operations on Lexicons", "description": "Performs batch create, update, or delete operations on Lexicons in a single request.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "EU countries" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "EU countries" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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": [] } ] }, "post": { "operationId": "createLexicon_2_0", "summary": "Create a New Lexicon", "description": "Creates a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) in a Project.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "resourceId", "description": "An Id of a resource within the corresponding project to copy from", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "shouldGenerateLexiconEntries", "description": "Flag to allow the Lexicon creation to use the generative AI to generate entries.", "example": true, "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "languageCode", "description": "Language code.", "required": false, "schema": { "type": "string", "example": "en-US" } }, { "in": "query", "name": "shouldGenerateSynonyms", "description": "Flag to allow the Lexicon creation to use the generative AI to generate synonyms.", "example": false, "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "generateLexiconEntriesLimit", "description": "Number of entries to be generated by the Generative AI.", "example": 8, "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "defaultSlot", "description": "Default Slot where to associate the generated Lexicon entries.", "example": "testSlot", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "EU countries" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns Lexicon metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "EU countries" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" }, "referenceId": { "type": "string", "format": "uuid" }, "values": { "deprecated": true }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexLexicons_2_0", "summary": "Get Lexicons", "description": "Gets [Lexicons](https://docs.cognigy.com/ai/resources/build/lexicons/) in a Project. By default, 25 Lexicons are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the lexicon to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a Lexicons", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "New Lexicon" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "previousCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "nextCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/lexicons/{lexiconId}": { "delete": { "operationId": "deleteLexicon_2_0", "summary": "Delete a Lexicon", "description": "Deletes a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Project.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted the resource." }, "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": [] } ] }, "get": { "operationId": "readLexicon_2_0", "summary": "Get a Lexicon", "description": "Gets a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Project.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "metaOnly", "description": "Return only the lexicon meta data if set to true", "required": false, "schema": { "type": "boolean", "enum": [ true, false ] } } ], "responses": { "200": { "description": "Returns Lexicon Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "EU countries" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" }, "referenceId": { "type": "string", "format": "uuid" }, "values": { "deprecated": true }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateLexicon_2_0", "summary": "Update a Lexicon", "description": "Updates a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) in a Project.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lexicon", "example": "EU countries" }, "description": { "type": "string", "description": "A meaningful description of the lexicon", "example": "Countries members of the European Union, e.g. Spain" } } } } } }, "responses": { "204": { "description": "Successfully updated Lexicon." }, "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/lexicons/{lexiconId}/downloadlink": { "post": { "operationId": "composeLexiconDownloadLink_2_0", "summary": "Create a Download Link for a Lexicon", "description": "Creates a link to download a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) as a CSV file.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returning a link to download the Lexicon", "content": { "application/json": { "schema": { "type": "object", "properties": { "downloadLink": { "type": "string", "format": "uri" } } } } } }, "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/lexicons/{lexiconId}/entries": { "patch": { "operationId": "batchLexiconEntries_2_0", "summary": "Perform Batch Operations in a Lexicon", "description": "Performs batch create, update, or delete operations on Keyphrases and Lexicon Slots in a single request.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "required": [ "mainKeyphrase" ], "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": "{\"key1\": \"value1\" }" }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "required": [ "mainKeyphrase" ], "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": "{\"key1\": \"value1\" }" }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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": [] } ] }, "post": { "operationId": "createLexiconEntry_2_0", "summary": "Create a Lexicon Entry", "description": "Creates a Lexicon entry with a Keyphrase and optional Lexicon Slots.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "required": [ "mainKeyphrase" ], "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": "{\"key1\": \"value1\" }" }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" } } } } } }, "responses": { "201": { "description": "Created Entry Object.", "content": { "application/json": { "schema": { "type": "object", "required": [ "mainKeyphrase" ], "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": "{\"key1\": \"value1\" }" }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexLexiconEntries_2_0", "summary": "Get Lexicon Entries", "description": "Gets entries from a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon). By default, 25 entries are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a Lexicon Entries", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "mainKeyphrase": { "description": "the keyphrase value", "example": "pizza" }, "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": {} }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } }, "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/lexicons/{lexiconId}/entries/{entryId}": { "delete": { "operationId": "deleteLexiconEntry_2_0", "summary": "Delete a Lexicon Entry", "description": "Deletes a [Lexicon entry](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "entryId", "description": "The id of an entry in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted the entry." }, "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": [] } ] }, "get": { "operationId": "readLexiconEntry_2_0", "summary": "Get a Lexicon Entry", "description": "Gets a Lexicon entry from a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon).", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "entryId", "description": "The id of an entry in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Lexicon Entry Object", "content": { "application/json": { "schema": { "type": "object", "required": [ "mainKeyphrase" ], "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": "{\"key1\": \"value1\" }" }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateLexiconEntry_2_0", "summary": "Update a Lexicon Entry", "description": "Updates a [Lexicon entry](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon).", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "entryId", "description": "The id of an entry in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "mainKeyphrase" ], "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": "{\"key1\": \"value1\" }" }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" } } } } } }, "responses": { "204": { "description": "Successfully updated Entry." }, "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/lexicons/{lexiconId}/entries/{entryId}/keyphrases": { "post": { "operationId": "addKeyphraseToLexiconEntry_2_0", "summary": "Add a Keyphrase to a Lexicon", "description": "Adds a [Keyphrase](https://docs.cognigy.com/ai/platform-features/nlu/slots/overview#keyphrases) to a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon).", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "entryId", "description": "The id of an entry in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "a Keyphrase", "example": "pizza" } } } } } }, "responses": { "201": { "description": "Successfully created the Keyphrase." }, "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": [] } ] }, "get": { "operationId": "indexLexiconEntryKeyphrases_2_0", "summary": "Get Keyphrases from a Lexicon Entry", "description": "Gets [Keyphrases](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon entry. By default, 25 Keyphrases are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "entryId", "description": "The id of an entry in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The `value` field to filter the lexicon keyphrases" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a Keyphrases of a Lexicon Entry", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "mainKeyphrase": { "description": "the keyphrase value", "example": "pizza" }, "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": {} }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } }, "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/lexicons/{lexiconId}/entries/{entryId}/keyphrases/{keyphraseId}": { "post": { "operationId": "removeKeyphraseFromLexiconEntry_2_0", "summary": "Delete a Keyphrase", "description": "Deletes a [Keyphrase](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon entry.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "entryId", "description": "The id of an entry in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "keyphraseId", "description": "The id of a keyphrase in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully removed the keyphrase from the entry." }, "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/lexicons/{lexiconId}/entries/{entryId}/slots": { "post": { "operationId": "addSlotToLexiconEntry_2_0", "summary": "Add a Slot to a Lexicon", "description": "Adds a [Slot](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) to a Lexicon.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "entryId", "description": "The id of an entry in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "a Lexicon Slot", "example": "food" } } } } } }, "responses": { "201": { "description": "Successfully created the Slot." }, "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/lexicons/{lexiconId}/entries/{entryId}/slots/{slotId}": { "post": { "operationId": "removeSlotFromLexiconEntry_2_0", "summary": "Delete a Lexicon Slot", "description": "Deletes a [Lexicon Slot](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon entry.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "entryId", "description": "The id of an entry in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "slotId", "description": "The id of a slot in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully removed the slot from the entry." }, "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/lexicons/{lexiconId}/export": { "get": { "operationId": "exportFromLexicon_2_0", "summary": "Export a Lexicon", "description": "Creates a task to export a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) as a CSV file.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Successfully started downloading the lexicon data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/lexicons/{lexiconId}/import": { "post": { "operationId": "importIntoLexicon_2_0", "summary": "Import a Lexicon", "description": "Create a task to import a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a CSV file.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "example": "skip", "enum": [ "skip", "overwrite", "merge" ] }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "contentType": "text/csv" } } } } }, "responses": { "202": { "description": "Successfully uploaded your Lexicon data and created a Task for importing it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/lexicons/{lexiconId}/keyphrases": { "get": { "operationId": "indexLexiconKeyphrases_2_0", "summary": "Get Keyphrases in a Lexicon", "description": "Gets [Keyphrases](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon. By default, 25 Keyphrases are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The `value` field to filter the lexicon keyphrases" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a Lexicon Keyphrases", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "mainKeyphrase": { "description": "the keyphrase value", "example": "pizza" }, "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": {} }, "keyphrases": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "string", "description": "the keyphrase value", "example": "pizza" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicator if the Keyphrase is the mainKeyphrase", "example": true } } }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } }, "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/lexicons/{lexiconId}/keyphrases/{keyphraseId}": { "patch": { "operationId": "updateLexiconKeyphrase_2_0", "summary": "Update a Keyphrase", "description": "Updates a [Keyphrase](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) in a Lexicon.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "keyphraseId", "description": "The id of a keyphrase in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "isMainKeyphrase": { "type": "boolean", "description": "Indicates if it is main", "example": true } } } } } }, "responses": { "204": { "description": "Successfully updated Keyphrase." }, "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/lexicons/{lexiconId}/slots": { "patch": { "operationId": "batchLexiconSlots_2_0", "summary": "Perform Batch Operations in a Lexicon", "description": "Performs batch create, update, or delete operations on Lexicon Slots in a single request.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "required": [ "mainKeyphrase" ], "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": "{\"key1\": \"value1\" }" }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "required": [ "mainKeyphrase" ], "properties": { "data": { "type": "string", "description": "Additional JSON-data of the lexicon entry", "example": "{\"key1\": \"value1\" }" }, "slotReferences": { "type": "array", "description": "The used slots by the lexicon entry", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "mainKeyphrase": { "type": "string", "description": "the keyphrase value", "example": "pizza" } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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": [] } ] }, "post": { "operationId": "createLexiconSlot_2_0", "summary": "Create a Lexicon Slot", "description": "Creates a [Lexicon Slot](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) in a Lexicon. You can assign Slots to Keyphrases.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" } } } } } }, "responses": { "201": { "description": "The created Slot", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexLexiconSlots_2_0", "summary": "Get Lexicon Slots", "description": "Gets [Lexicon Slots](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon. By default, 25 Lexicon Slots are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the lexicon slot to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns an array of a lexicon slots objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "previousCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "nextCursor": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/lexicons/{lexiconId}/slots/{slotId}": { "delete": { "operationId": "deleteLexiconSlot_2_0", "summary": "Delete a Lexicon Slot", "description": "Deletes a [Lexicon Slot](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "slotId", "description": "The id of a slot in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted slot." }, "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": [] } ] }, "patch": { "operationId": "updateLexiconSlot_2_0", "summary": "Update a Lexicon Slot", "description": "Updates a [Lexicon Slot](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) in a Lexicon.", "tags": [ "Lexicons" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "lexiconId", "description": "The Id of the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "slotId", "description": "The id of a slot in the Lexicon", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the slot", "example": "food" } } } } } }, "responses": { "204": { "description": "Successfully updated Slot." }, "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/organisations/liveagentaccount": { "get": { "operationId": "readLiveAgentAccount_2_0", "summary": "Get the Live Agent Account", "description": "Gets the Live Agent Account for the organization.", "tags": [ "Live Agent" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Returns the Live Agent Account for the organisation." }, "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/organisations/setupliveagent": { "post": { "operationId": "setupCognigyLiveAgent_2_0", "summary": "Set Up Live Agent", "description": "Sets up Cognigy Live Agent for the organization.", "tags": [ "Live Agent" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Cognigy Live Agent was successfully setup for the organisation and returns the LiveAgent account Id or an error message." }, "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}/inbox": { "get": { "operationId": "readProjectInbox_2_0", "summary": "Get the Default Live Agent Inbox", "description": "Gets the default Live Agent Inbox from a Project.", "tags": [ "Live Agent" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the default Live Agent Inbox Id of the project or an error message." }, "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}/setupinbox": { "post": { "operationId": "setupCognigyLiveAgentInbox_2_0", "summary": "Set Up a Live Agent Inbox", "description": "Sets up a default Live Agent Inbox for a Project.", "tags": [ "Live Agent" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Cognigy Live agent Inbox was successfully setup for the project and returns the inbox id or an error message." }, "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": [] } ] }, "patch": { "operationId": "updateCognigyLiveAgentInbox_2_0", "summary": "Update a Live Agent Inbox", "description": "Updates the default Live Agent Inbox assigned to a Project.", "tags": [ "Live Agent" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inboxId": { "type": "number" } } } } } }, "responses": { "200": { "description": "Cognigy Live agent Inbox was successfully updated for the project and returns the inbox id or an error message." }, "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/locales": { "post": { "operationId": "createLocale_2_0", "summary": "Create a Locale", "description": "Creates a [Locale](https://docs.cognigy.com/ai/platform-features/translation-and-localization/localization) in a Project.", "tags": [ "Locales" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "primary": { "type": "boolean" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns Locale metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "primary": { "type": "boolean" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexLocales_2_0", "summary": "Get Locales", "description": "Gets [Locales](https://docs.cognigy.com/ai/resources/manage/localization/) in a Project. By default, 25 Locales are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Locales" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the locale to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a Locale metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "primary": { "type": "boolean" }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/locales/{localeId}": { "delete": { "operationId": "deleteLocale_2_0", "summary": "Delete a Locale", "description": "Deletes a non-primary [Locale](https://docs.cognigy.com/ai/platform-features/translation-and-localization/localization) in a Project.", "tags": [ "Locales" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Sucessfully deleted the locale." }, "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": [] } ] }, "get": { "operationId": "readLocale_2_0", "summary": "Get a Locale", "description": "Gets a [Locale](https://docs.cognigy.com/ai/platform-features/translation-and-localization/localization).", "tags": [ "Locales" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the Locale object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "primary": { "type": "boolean" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateLocale_2_0", "summary": "Update a Locale", "description": "Updates a [Locale](https://docs.cognigy.com/ai/platform-features/translation-and-localization/localization).", "tags": [ "Locales" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "primary": { "type": "boolean" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "200": { "description": "Returns the Locale object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Locale", "example": "English" }, "primary": { "type": "boolean" }, "nluLanguage": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "fallbackLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": { "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", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 type, msg or traceId of the log entry to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "query", "name": "type", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } }, { "in": "query", "name": "userId", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "flowName", "required": false, "schema": { "type": "string" } }, { "description": "The start date for filtering log entries", "in": "query", "name": "startDate", "required": false, "schema": { "type": "string" } }, { "description": "The end date for filtering log entries", "in": "query", "name": "endDate", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns array of Log Entries", "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", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "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", "description": "Gets a [log entry](https://docs.cognigy.com/ai/agents/test/logs) in a Project.", "tags": [ "Logs" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "logEntryId", "description": "The Id of the Log Entry", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns LogEntry Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "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", "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 200 rows by `_id`, then sorts by timestamp and returns the 100 most recent rows. Supports `cursor`-based pagination using the `_id` field. If you provide an invalid `cursor` value, a 400 error will be returned.", "tags": [ "Logs" ], "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of the latest Log Entries", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "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.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.", "tags": [ "Logs v2.1" ], "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 type, msg or traceId of the log entry to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "query", "name": "type", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "fatal", "error", "warn", "info", "debug", "trace" ] } } }, { "in": "query", "name": "userId", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "flowName", "required": false, "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 (ISO 8601 format). If not provided, defaults to 1 hour before endDate." }, { "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 (ISO 8601 format). If not provided, defaults to the current time." } ], "responses": { "200": { "description": "Returns array of Log Entries", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "timestamp": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "meta": { "type": "object" }, "traceId": { "type": "string" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "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": [] } ] } }, "/management/v2.0/billing": { "get": { "operationId": "getBillingInformation_2_0", "summary": "Get Billing Information", "description": "Gets the billing information of organizations from Management UI. By default, 25 organizations are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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": "filter billing info by organisation name" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Billing relevant information per organisation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "organisationId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "isDisabled": { "type": "boolean" }, "conversations": { "type": "array", "items": { "type": "object", "properties": { "conversations": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "channel": { "type": "string" } } } } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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": [ { "BasicAuth": [] } ] } }, "/management/v2.0/organisations": { "post": { "operationId": "createOrganisation_2_0", "summary": "Create an Organization", "description": "Creates an organization in Management UI.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "quotaMaxKnowledgeChunks": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "billingTimezone": { "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" ] }, "dataPrivacySettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "voiceConfigurations": { "type": "object", "properties": { "enableNiceSharedProviders": { "type": "boolean", "description": "[Deprecated] Derived from niceProvidedSpeechEntitlements" }, "orgVoiceGatewayEnabled": { "type": "boolean", "description": "Whether Voice Gateway is enabled for this organisation" }, "niceProvidedSpeechEntitlements": { "type": "array", "items": { "type": "object", "required": [ "vendor", "stt", "tts" ], "properties": { "vendor": { "type": "string", "description": "Speech vendor identifier (e.g. 'nice-stt', 'microsoft', 'deepgram')" }, "stt": { "type": "boolean", "description": "Whether STT is enabled for this vendor" }, "tts": { "type": "boolean", "description": "Whether TTS is enabled for this vendor" } } }, "description": "Per-vendor, per-capability entitlements for NiCE-provided speech providers" } } }, "aiOpsCenterEnabled": { "type": "boolean" }, "businessUnitId": { "type": "string", "description": "The business unit ID" }, "tenantId": { "type": "string", "description": "The tenant ID" } }, "required": [ "name" ], "type": "object" } } } }, "responses": { "201": { "description": "Returns the new organisation.", "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "quotaMaxKnowledgeChunks": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "billingTimezone": { "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" ] }, "dataPrivacySettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "voiceConfigurations": { "type": "object", "properties": { "enableNiceSharedProviders": { "type": "boolean", "description": "[Deprecated] Derived from niceProvidedSpeechEntitlements" }, "orgVoiceGatewayEnabled": { "type": "boolean", "description": "Whether Voice Gateway is enabled for this organisation" }, "niceProvidedSpeechEntitlements": { "type": "array", "items": { "type": "object", "required": [ "vendor", "stt", "tts" ], "properties": { "vendor": { "type": "string", "description": "Speech vendor identifier (e.g. 'nice-stt', 'microsoft', 'deepgram')" }, "stt": { "type": "boolean", "description": "Whether STT is enabled for this vendor" }, "tts": { "type": "boolean", "description": "Whether TTS is enabled for this vendor" } } }, "description": "Per-vendor, per-capability entitlements for NiCE-provided speech providers" } } }, "aiOpsCenterEnabled": { "type": "boolean" }, "businessUnitId": { "type": "string", "description": "The business unit ID" }, "tenantId": { "type": "string", "description": "The tenant ID" } }, "required": [ "name" ], "type": "object" } } } }, "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": [ { "BasicAuth": [] } ] }, "get": { "operationId": "indexOrganisations_2_0", "summary": "Get Organizations", "description": "Gets organizations from Management UI. By default, 25 organizations are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 name of the organisation to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns metadata objects for each organisation in the system.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "businessUnitId": { "type": "string", "description": "The business unit ID" }, "tenantId": { "type": "string", "description": "The tenant ID" }, "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "quotaMaxKnowledgeChunks": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "liveAgentAccount": { "type": "number" }, "billingTimezone": { "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" ] }, "dataPrivacySettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "aiOpsCenterEnabled": { "type": "boolean" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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": [ { "BasicAuth": [] } ] } }, "/management/v2.0/organisations/{organisationId}": { "delete": { "operationId": "deleteOrganisation_2_0", "summary": "Delete an Organization", "description": "Deletes an organization and the associated data.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "organisationId", "description": "The Id of the Organisation", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "verificationToken", "required": true, "schema": { "type": "string" } } ], "security": [ { "BasicAuth": [] } ], "responses": { "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": {} } } } } } } } }, "get": { "operationId": "readOrganisation_2_0", "summary": "Get an Organization", "description": "Gets information about an organization.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "organisationId", "description": "The Id of the Organisation", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the Organisation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "businessUnitId": { "type": "string", "description": "The business unit ID" }, "tenantId": { "type": "string", "description": "The tenant ID" }, "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "quotaMaxKnowledgeChunks": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "liveAgentAccount": { "type": "number" }, "billingTimezone": { "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" ] }, "dataPrivacySettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "aiOpsCenterEnabled": { "type": "boolean" } } } } } }, "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": [ { "BasicAuth": [] } ] }, "patch": { "operationId": "updateOrganisation_2_0", "summary": "Update an Organization", "description": "Updates information of an organization.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "organisationId", "description": "The Id of the Organisation", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "description": "The name of this organisation" }, "disabled": { "type": "boolean", "description": "Flag whether this organisation is currently disabled" }, "quotaMaxProjects": { "type": "number" }, "quotaMaxUsers": { "type": "number" }, "quotaMaxChannelsPerProject": { "type": "number" }, "quotaMaxMessagesPerDay": { "type": "number" }, "quotaMaxKnowledgeChunks": { "type": "number" }, "passwordPolicy": { "type": "object", "properties": { "minLength": { "type": "integer" }, "maxLength": { "type": "integer" }, "minAmountLowerCase": { "type": "integer" }, "minAmountUpperCase": { "type": "integer" }, "minAmountSpecialCharacters": { "type": "integer" }, "minAmountNumbers": { "type": "integer" }, "maxAmountIdenticalCharacters": { "type": "integer" }, "minAmountFailedAttemptsAutoDisable": { "type": "integer" } } }, "sessionStateTTLInMinutes": { "type": "number" }, "contactProfileTTLInMinutes": { "type": "number" }, "conversationTTLInMinutes": { "type": "number" }, "billingTimezone": { "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" ] }, "dataPrivacySettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useAnalytics": { "type": "boolean" }, "useContactProfiles": { "type": "boolean" }, "useConversations": { "type": "boolean" }, "maskAnalytics": { "type": "boolean" }, "maskLogging": { "type": "boolean" }, "ignoreList": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "voiceConfigurations": { "type": "object", "properties": { "enableNiceSharedProviders": { "type": "boolean", "description": "[Deprecated] Derived from niceProvidedSpeechEntitlements" }, "orgVoiceGatewayEnabled": { "type": "boolean", "description": "Whether Voice Gateway is enabled for this organisation" }, "niceProvidedSpeechEntitlements": { "type": "array", "items": { "type": "object", "required": [ "vendor", "stt", "tts" ], "properties": { "vendor": { "type": "string", "description": "Speech vendor identifier (e.g. 'nice-stt', 'microsoft', 'deepgram')" }, "stt": { "type": "boolean", "description": "Whether STT is enabled for this vendor" }, "tts": { "type": "boolean", "description": "Whether TTS is enabled for this vendor" } } }, "description": "Per-vendor, per-capability entitlements for NiCE-provided speech providers" } } }, "aiOpsCenterEnabled": { "type": "boolean" }, "businessUnitId": { "type": "string", "description": "The business unit ID" }, "tenantId": { "type": "string", "description": "The tenant ID" } }, "type": "object" } } } }, "security": [ { "BasicAuth": [] } ], "responses": { "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": {} } } } } } } } } }, "/management/v2.0/organisations/{organisationId}/apikeys": { "post": { "operationId": "createApiKeyManagement_2_0", "summary": "Create an API Key", "description": "Creates an API Key with admin permissions. The API Key is valid for 15 minutes. To activate this feature, set the FEATURE_USE_SUPERAPIKEY_API to \"true\".\n", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "organisationId", "description": "The Id of the Organisation", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "201": { "description": "Returns the created api-key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 }, "apiKey": { "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": [ { "BasicAuth": [] } ] } }, "/management/v2.0/organisations/{organisationId}/enforcepasswordpolicy": { "post": { "operationId": "enforcePasswordPolicy_2_0", "summary": "Enforce Password Policy", "description": "Enforces a password policy and requests all users to reset their passwords.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "organisationId", "description": "The Id of the Organisation", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully enforced PasswordPolicy." }, "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": [ { "BasicAuth": [] } ] } }, "/management/v2.0/system/createsystemmessage": { "post": { "operationId": "createSystemMessage_2_0", "summary": "Create a System Message", "description": "Creates a system message or overwrites the existing one.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "until" ], "properties": { "until": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "message": { "type": "string", "example": "Next great Update will be released next Monday." }, "showOnLogin": { "type": "boolean" } } } } } }, "responses": { "201": { "description": "The system message was created." }, "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": [ { "BasicAuth": [] } ] } }, "/management/v2.0/users": { "post": { "operationId": "management_createUser_2_0", "summary": "Create a User", "description": "Creates a user in Management UI.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "password", "organisation" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "cxoneEmail": { "type": "string", "description": "The email address of the CXOne user, only required for NiCE CXOne users" }, "cxoneId": { "type": "string", "description": "The CXOne ID of the user, only required for NiCE CXOne users" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" } } } } } }, "responses": { "201": { "description": "Returns the created user.", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "password", "organisation" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "cxoneEmail": { "type": "string", "description": "The email address of the CXOne user, only required for NiCE CXOne users" }, "cxoneId": { "type": "string", "description": "The CXOne ID of the user, only required for NiCE CXOne users" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [ { "BasicAuth": [] } ] }, "get": { "operationId": "management_indexUsers_2_0", "summary": "Get Users", "description": "Gets users of the organization. By default, 25 users are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 name or id of the user to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns metadata objects for each user in the system.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "cxoneEmail": { "type": "string", "description": "The email address of the CXOne user, only required for NiCE CXOne users" }, "cxoneId": { "type": "string", "description": "The CXOne ID of the user, only required for NiCE CXOne users" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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": [ { "BasicAuth": [] } ] } }, "/management/v2.0/users/{userId}": { "delete": { "operationId": "management_deleteUser_2_0", "summary": "Delete a User", "description": "Deletes a user from Management UI.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The user was removed successfully." }, "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": [ { "BasicAuth": [] } ] }, "get": { "operationId": "management_readUser_2_0", "summary": "Get a User", "description": "Gets information about a user.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns User object", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [ { "BasicAuth": [] } ] }, "patch": { "operationId": "management_updateUser_2_0", "summary": "Update a User", "description": "Updates information of a user.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "cxoneEmail": { "type": "string", "description": "The email address of the CXOne user, only required for NiCE CXOne users" }, "cxoneId": { "type": "string", "description": "The CXOne ID of the user, only required for NiCE CXOne users" }, "newPassword": { "type": "string" } } } } } }, "responses": { "204": { "description": "The user is updated successfully." }, "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": [ { "BasicAuth": [] } ] } }, "/management/v2.0/users/{userId}/impersonate": { "post": { "operationId": "management_impersonateUser_2_0", "summary": "Impersonate a User", "description": "Creates an access and refresh token pair to log in as a user.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Token pair for the user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "number" }, "refresh_token": { "type": "string" }, "token_type": { "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": [ { "BasicAuth": [] } ] } }, "/management/v2.0/vendor": { "get": { "operationId": "readVendor_2_0", "summary": "Get Vendor Information", "description": "Gets information about a vendor from Management UI.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Returns some product information like the version etc.", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "The product version we are running" }, "frontendBaseUrl": { "type": "string", "description": "Base URL to the frontend UI" }, "hasLicenseAgreement": { "type": "string", "description": "Flag whether users need to agree the license agreement within this env" }, "maxContactProfileTTL": { "type": "number" }, "maxConversationTTL": { "type": "number" }, "maxSessionStateTTL": { "type": "number" } } } } } }, "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": [ { "BasicAuth": [] } ] } }, "/management/v3.0/billing": { "get": { "operationId": "getBillingInformation_3_0", "summary": "Get Billing Information", "description": "Gets the billing information of organizations from Management UI. By default, 25 organizations are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Management UI" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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": "filter billing info by organisation name" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Billing relevant information per organisation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "organisationId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "isDisabled": { "type": "boolean" }, "conversations": { "type": "array", "items": { "type": "object", "properties": { "conversations": { "type": "number" }, "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" }, "perChannel": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string" }, "conversations": { "type": "number" } } } } } } } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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": [ { "BasicAuth": [] } ] } }, "/v2.0/nluconnectors": { "patch": { "operationId": "batchNLUConnectors_2_0", "summary": "Perform Batch Operations", "description": "Performs batch operations on [NLU Connectors](https://docs.cognigy.com/ai/platform-features/nlu/external/nlu-connectors/overview#nlu-connectors).", "tags": [ "NLU Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "settings": { "oneOf": [ { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } }, { "type": "object", "description": "Settings used by the Lex NLUConnector", "properties": { "accessKeyId": { "type": "string", "description": "Apikey for accessing the Lex NLU Api" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key for accessing the Lex NLU Api" }, "awsRegion": { "type": "string", "description": "The AWS region the Lex bot is deployed to" }, "botId": { "type": "string", "description": "Id of the Lex bot" }, "botAliasId": { "type": "string", "description": "Alias of the Lex bot" } } } ] }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "settings": { "oneOf": [ { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } }, { "type": "object", "description": "Settings used by the Lex NLUConnector", "properties": { "accessKeyId": { "type": "string", "description": "Apikey for accessing the Lex NLU Api" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key for accessing the Lex NLU Api" }, "awsRegion": { "type": "string", "description": "The AWS region the Lex bot is deployed to" }, "botId": { "type": "string", "description": "Id of the Lex bot" }, "botAliasId": { "type": "string", "description": "Alias of the Lex bot" } } } ] }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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": [] } ] }, "post": { "operationId": "createNLUConnector_2_0", "summary": "Create an NLU Connector", "description": "Creates an [NLU Connector](https://docs.cognigy.com/ai/platform-features/nlu/external/nlu-connectors/overview#nlu-connectors) in a Project.", "tags": [ "NLU Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "resourceId", "description": "An Id of a resource within the corresponding project to copy from", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "settings": { "oneOf": [ { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } }, { "type": "object", "description": "Settings used by the Lex NLUConnector", "properties": { "accessKeyId": { "type": "string", "description": "Apikey for accessing the Lex NLU Api" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key for accessing the Lex NLU Api" }, "awsRegion": { "type": "string", "description": "The AWS region the Lex bot is deployed to" }, "botId": { "type": "string", "description": "Id of the Lex bot" }, "botAliasId": { "type": "string", "description": "Alias of the Lex bot" } } } ] }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "201": { "description": "Returns NLUConnector metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "settings": { "oneOf": [ { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } }, { "type": "object", "description": "Settings used by the Lex NLUConnector", "properties": { "accessKeyId": { "type": "string", "description": "Apikey for accessing the Lex NLU Api" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key for accessing the Lex NLU Api" }, "awsRegion": { "type": "string", "description": "The AWS region the Lex bot is deployed to" }, "botId": { "type": "string", "description": "Id of the Lex bot" }, "botAliasId": { "type": "string", "description": "Alias of the Lex bot" } } } ] }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexNLUConnectors_2_0", "summary": "Get NLU Connectors", "description": "Gets NLU Connectors in a Project. By default, 25 NLU Connectors are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "NLU Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the NLU connector to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a NLUConnector metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "referenceId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/nluconnectors/{nluConnectorId}": { "delete": { "operationId": "deleteNLUConnector_2_0", "summary": "Delete an NLU Connector", "description": "Deletes an NLU Connector.", "tags": [ "NLU Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "nluConnectorId", "description": "The Id of the NLUConnector", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted nluconnector" }, "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": [] } ] }, "get": { "operationId": "readNLUConnector_2_0", "summary": "Get an NLU Connector", "description": "Gets information about an NLU Connector in a Project.", "tags": [ "NLU Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "nluConnectorId", "description": "The Id of the NLUConnector", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns NLUConnector Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "settings": { "oneOf": [ { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } }, { "type": "object", "description": "Settings used by the Lex NLUConnector", "properties": { "accessKeyId": { "type": "string", "description": "Apikey for accessing the Lex NLU Api" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key for accessing the Lex NLU Api" }, "awsRegion": { "type": "string", "description": "The AWS region the Lex bot is deployed to" }, "botId": { "type": "string", "description": "Id of the Lex bot" }, "botAliasId": { "type": "string", "description": "Alias of the Lex bot" } } } ] }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateNLUConnector", "summary": "Update an NLU Connector", "description": "Updates an NLU Connector in a Project.", "tags": [ "NLU Connectors" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "nluConnectorId", "description": "The Id of the NLUConnector", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the NLUConnector", "example": "New NLUConnector" }, "type": { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, "settings": { "oneOf": [ { "type": "object", "description": "Settings used by the Alexa NLUConnector", "properties": { "invocationName": { "type": "string", "description": "The invocation name of the Alexa skill. Necessary to start Alexa simulations." }, "reparseAlexaSlots": { "type": "boolean", "description": "Whether to reparse slots from Alexa with our own keyphrase mapper. Used by Alexa." }, "skill": { "type": "object", "properties": { "lastUpdated": { "type": "string", "description": "When the skill was last updated" }, "nameByLocale": { "type": "object", "description": "Gives the name of the skill for different locales", "properties": { "en-US": { "type": "string" }, "de-DE": { "type": "string" }, "ja-JP": { "type": "string" }, "en-GB": { "type": "string" }, "en-IN": { "type": "string" } } }, "skillId": { "type": "string", "description": "The unique id of the skill" }, "stage": { "type": "string", "description": "The current stage of the skills life cycle (e.g. is it in development, production..)" } } } } }, { "type": "object", "description": "Settings used by the DialogFlow NLUConnector", "properties": { "dialogflowApiVersion": { "type": "integer", "description": "The version of the dialogflow API to use.", "enum": [ 1, 2 ] }, "dialogflowProjectId": { "type": "string", "description": "The projectId of the Dialogflow Agent." }, "accessToken": { "description": "The access token used to authenticate requests. Used by DialogFlow.", "type": "string" }, "privateKey": { "type": "string", "description": "The private key of a Google Service Account that has the access right to use the Dialogflow API. It is stored as a string." } } }, { "type": "object", "description": "Settings used by the LUIS NLUConnector", "properties": { "authenticationURL": { "type": "string", "description": "The URL Used to authenticate requests by LUIS." } } }, { "type": "object", "description": "Settings used by the Watson NLUConnector", "properties": { "apikey": { "type": "string", "description": "Apikey for accessing the Watson NLU Api" }, "workspaceid": { "type": "string", "description": "Skill ID for accessing the Assistant skill" }, "serviceURL": { "type": "string", "description": "The URL used to authenticate requests by Watson" } } }, { "type": "object", "description": "Settings used by the Lex NLUConnector", "properties": { "accessKeyId": { "type": "string", "description": "Apikey for accessing the Lex NLU Api" }, "secretAccessKey": { "type": "string", "description": "Secret Access Key for accessing the Lex NLU Api" }, "awsRegion": { "type": "string", "description": "The AWS region the Lex bot is deployed to" }, "botId": { "type": "string", "description": "Id of the Lex bot" }, "botAliasId": { "type": "string", "description": "Alias of the Lex bot" } } } ] }, "transformer": { "type": "object", "properties": { "abortOnError": { "type": "string", "description": "If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.", "example": false }, "transformerStackEnabled": { "type": "string", "description": "If true, then we will write the transformer stack in the input object, when the channel is adminconsole.", "example": false }, "transformer": { "type": "string", "description": "The transformer object as written by the user. This will be displayed in the UI since it includes typings." }, "preNluTransformerEnabled": { "type": "string", "example": false }, "postNluTransformerEnabled": { "type": "string", "example": false }, "nluCodeTransformerEnabled": { "type": "string", "example": false } } } } } } } }, "responses": { "200": { "description": "Successfully updated NLUConnector" }, "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/flows/{flowId}/chart/descriptors": { "get": { "operationId": "indexNodeDescriptors_2_0", "summary": "Get all Node Descriptors", "description": "Gets all Node descriptors of a Flow. A descriptor defines a node type, its capabilities, appearance, and behavior in the Flow Chart. The descriptor acts as a blueprint for creating Nodes.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns an array of Node descriptors.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "parentType": { "type": "string", "description": "The type of the node parent, if there is one" }, "defaultLabel": { "oneOf": [ { "type": "string", "description": "The label that should be used when a new Node of this type is created" }, { "type": "object", "description": "A localized version of the label that should be used when a new Node of this type is created", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "summary": { "oneOf": [ { "type": "string", "description": "A short line of text that describes what this Node is used for" }, { "type": "object", "description": "A localized version of a short line of text that describes what this Node is used for", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "extension": { "type": "string" }, "extensionImg": { "type": "string" }, "appearance": { "type": "object", "properties": { "logo": { "type": "string" }, "textColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "contrastTextColor": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "color": { "type": "string", "example": "red", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "variant": { "type": "string", "enum": [ "regular", "mini", "hexagon" ] } } }, "behavior": { "type": "object", "properties": { "stopping": { "type": "boolean" }, "entrypoint": { "type": "boolean" } } }, "constraints": { "type": "object", "properties": { "editable": { "type": "boolean", "description": "Should this node be editable" }, "deletable": { "type": "boolean", "description": "Should this node be deletable" }, "creatable": { "type": "boolean", "description": "Should this node be manually creatable" }, "collapsable": { "type": "boolean", "description": "Should this node be collapsable" }, "childFlowCreatable": { "type": "boolean", "description": "Should it be possible to create child flow from this node" }, "movable": { "type": "boolean", "description": "Should this node be movable" }, "placement": { "type": "object", "description": "Additional placement information", "properties": { "predecessor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "successor": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } }, "children": { "type": "object", "properties": { "whitelist": { "items": { "type": "string" } }, "blacklist": { "items": { "type": "string" } } } } } } } }, "dependencies": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "string" } } } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "rule" ] }, "key": { "type": "string" }, "label": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "default": { "type": "string" }, "enUS": { "type": "string" }, "deDE": { "type": "string" }, "esES": { "type": "string" }, "jaJP": { "type": "string" }, "koKR": { "type": "string" } } } ] }, "defaultValue": { "description": "The default value for that field" } } } }, "previews": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message", "image", "code" ] }, "key": { "type": "string" } } } }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 30, "example": "word count" }, "script": { "type": "string", "maxLength": 500, "example": "ci.text.split(' ').length" }, "type": { "type": "string", "enum": [ "profile", "input", "context", "custom", "answer", "flow-output", "flow-input" ], "example": "input" } } } }, "tags": { "type": "string", "enum": [ "basic", "logic", "message", "profile", "service", "nlu", "data" ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the Field whose value should be matched" }, "value": { "description": "The expected value(s) that make this condition match" }, "negate": { "type": "boolean", "description": "If this is true, the condition result will be inverted" } } } }, "form": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "A key either pointing to a 'field -> key' or 'section -> key'" }, "type": { "type": "string", "description": "The type of the pointer, either 'field' or 'section'", "enum": [ "field", "section" ] } } } } } } } } } } } }, "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/flows/{flowId}/chart/nodes": { "post": { "operationId": "createFlowChartNode_2_0", "summary": "Create a Node", "description": "Creates a new Node in a Flow.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "if", "description": "Type of the Node" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node", "description": "Replaces the default name of the Node displayed in the Flow Editor." }, "comment": { "type": "string", "example": "this is a very important node", "description": "Adds additional information about Nodes, for example, a specific of the Node." }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false }, "config": { "type": "object", "example": { "condition": { "type": "rule", "condition": "", "rule": { "left": "1", "operand": "gt", "right": "2" } } } }, "localeReference": { "type": "string", "example": "63bd8ebb648e6e739f1bbd82" }, "analyticsLabel": { "type": "string", "example": "condition" }, "mock": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "example": false }, "code": { "type": "string", "example": "console.log('Hello, world!');", "description": "Mock code to be executed when the mock mode is enabled.", "nullable": false } } }, "target": { "description": "The ID of the previous or parent Node to which the current Node should be attached.", "type": "string", "example": "63c6c16a7e1ef09c81f6075d" }, "mode": { "type": "string", "enum": [ "append", "prepend", "appendChild", "prependChild", "insertChildAt", "insertAfter", "insertBefore" ] }, "position": { "type": "number", "minimum": 0, "maximum": 2147483647, "example": 42, "description": "The desired position. Only used for insertChildAt." } }, "required": [ "target", "mode", "type" ] } } } }, "responses": { "201": { "description": "Returns ChartNode metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "if", "description": "Type of the Node" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node", "description": "Replaces the default name of the Node displayed in the Flow Editor." }, "comment": { "type": "string", "example": "this is a very important node", "description": "Adds additional information about Nodes, for example, a specific of the Node." }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false }, "config": { "type": "object", "example": { "condition": { "type": "rule", "condition": "", "rule": { "left": "1", "operand": "gt", "right": "2" } } } }, "localeReference": { "type": "string", "example": "63bd8ebb648e6e739f1bbd82" }, "analyticsLabel": { "type": "string", "example": "condition" }, "mock": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "example": false }, "code": { "type": "string", "example": "console.log('Hello, world!');", "description": "Mock code to be executed when the mock mode is enabled.", "nullable": false } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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": [] } ] }, "get": { "operationId": "indexFlowChartNodes_2_0", "summary": "Get Nodes", "description": "Gets Nodes from a Flow. By default, 25 Nodes are returned. Use the `limit` query parameter to change this value.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The label or comment of the Node to filter the records." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns array of Node Nodes", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "if", "description": "Type of the Node" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node", "description": "Replaces the default name of the Node displayed in the Flow Editor." }, "comment": { "type": "string", "example": "this is a very important node", "description": "Adds additional information about Nodes, for example, a specific of the Node." }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false }, "config": { "type": "object", "example": { "condition": { "type": "rule", "condition": "", "rule": { "left": "1", "operand": "gt", "right": "2" } } } }, "localeReference": { "type": "string", "example": "63bd8ebb648e6e739f1bbd82" }, "analyticsLabel": { "type": "string", "example": "condition" }, "mock": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "example": false }, "code": { "type": "string", "example": "console.log('Hello, world!');", "description": "Mock code to be executed when the mock mode is enabled.", "nullable": false } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/flows/{flowId}/chart/nodes/{nodeId}": { "delete": { "operationId": "deleteFlowChartNode_2_0", "summary": "Delete a Node", "description": "Delete a Node from a Flow.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "nodeId", "description": "The Id of the Node", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The Node was deleted successfully." }, "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": [] } ] }, "get": { "operationId": "readFlowChartNode_2_0", "summary": "Get a Node", "description": "Gets a Node from a Flow.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "nodeId", "description": "The Id of the Node", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "name": "includeConversionMetadata", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Whether to include conversion metadata in the response. False by default. WIll be available in future releases." } ], "responses": { "200": { "description": "Returns the Node configuartion successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "if", "description": "Type of the Node" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node", "description": "Replaces the default name of the Node displayed in the Flow Editor." }, "comment": { "type": "string", "example": "this is a very important node", "description": "Adds additional information about Nodes, for example, a specific of the Node." }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false }, "config": { "type": "object", "example": { "condition": { "type": "rule", "condition": "", "rule": { "left": "1", "operand": "gt", "right": "2" } } } }, "localeReference": { "type": "string", "example": "63bd8ebb648e6e739f1bbd82" }, "analyticsLabel": { "type": "string", "example": "condition" }, "mock": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "example": false }, "code": { "type": "string", "example": "console.log('Hello, world!');", "description": "Mock code to be executed when the mock mode is enabled.", "nullable": false } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "conversionMetadata": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "added", "removed", "updated" ] }, "description": "Optional conversion metadata included when includeConversionMetadata=true", "example": { "fieldName1": "updated", "fieldName2": "removed" } } } } } } }, "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": [] } ] }, "patch": { "operationId": "updateFlowChartNode_2_0", "summary": "Update a Node", "description": "Updates a Node in a Flow. Allows modifying the Node's type, label, comment, Entrypoint status, and configuration properties.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "nodeId", "description": "The Id of the Node", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "if", "description": "Type of the Node" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node", "description": "Replaces the default name of the Node displayed in the Flow Editor." }, "comment": { "type": "string", "example": "this is a very important node", "description": "Adds additional information about Nodes, for example, a specific of the Node." }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false }, "config": { "type": "object", "example": { "condition": { "type": "rule", "condition": "", "rule": { "left": "1", "operand": "gt", "right": "2" } } } }, "localeReference": { "type": "string", "example": "63bd8ebb648e6e739f1bbd82" }, "analyticsLabel": { "type": "string", "example": "condition" }, "mock": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "example": false }, "code": { "type": "string", "example": "console.log('Hello, world!');", "description": "Mock code to be executed when the mock mode is enabled.", "nullable": false } } }, "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "Successfully updated ChartNode" }, "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/flows/{flowId}/chart/nodes/{nodeId}/addlocalization": { "post": { "operationId": "addFlowChartNodeLocalization_2_0", "summary": "Add a New Locale to a Node", "description": "Adds a new Locale to a Node in a Flow. Use `localeId` to specify the target Locale and `inheritFromLocaleId` to inherit content from an existing Locale.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "nodeId", "description": "The Id of the Node", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "localeId": { "type": "string" }, "inhertFromLocaleId": { "type": "string" }, "nodeTranslationSettings": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Successfully added localization for node" }, "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/flows/{flowId}/chart/nodes/{nodeId}/move": { "post": { "operationId": "moveFlowChartNode_2_0", "summary": "Move a Node", "description": "Moves a Node in a Flow Chart. Allows modifying a Node's position relative to other Nodes using modes such as append, prepend, or insert at a specific position.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "nodeId", "description": "The Id of the Node", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "target", "mode" ], "properties": { "target": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "mode": { "type": "string", "enum": [ "append", "prepend", "appendChild", "prependChild", "insertChildAt", "insertAfter", "insertBefore" ] }, "position": { "type": "number", "minimum": 0, "maximum": 2147483647, "example": 42, "description": "The desired position. The desired position. Only used for insertChildAt." } } } } } }, "responses": { "204": { "description": "Successfully moved ChartNode." }, "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/flows/{flowId}/chart/nodes/{nodeId}/removelocalization": { "post": { "operationId": "removeFlowChartNodeLocalization_2_0", "summary": "Remove a Locale from a Node", "description": "Removes a Locale from a Node in a Flow.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "nodeId", "description": "The Id of the Node", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "localeId": { "type": "string" } } } } } }, "responses": { "204": { "description": "The Locale was removed from the Node successfully." }, "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/flows/{flowId}/chart/nodes/aiagents": { "get": { "operationId": "readFlowChartAiAgents_2_0", "summary": "Get AI Agents Nodes", "description": "Gets all AI Agent Nodes from the Flow with full AI Agent details.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns AI Agents used in the Flow", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "type": { "type": "string", "example": "if" }, "referenceId": { "type": "string", "format": "uuid" }, "extension": { "type": "string", "example": "@cognigy/basic-nodes" }, "label": { "type": "string", "example": "A new Node" }, "analyticsLabel": { "type": "string", "example": "Step name" }, "comment": { "type": "string", "example": "this is a very important node" }, "commentColor": { "oneOf": [ { "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" ] } ] }, { "type": "string", "nullable": false, "enum": [ "" ] } ] }, "isCollapsed": { "type": "boolean", "example": false }, "isEntryPoint": { "type": "boolean", "example": false }, "isDisabled": { "type": "boolean", "example": false }, "name": { "type": "string", "example": "Cognigy AI Agent" }, "image": { "type": "string", "description": "Avatar of the AI Agent.", "example": "https://cognigy.com/ai-agent.png" }, "imageOptimizedFormat": { "type": "boolean", "description": "Whether the optimized image format defined by Cognigy is used.", "example": true }, "knowledgeReferenceId": { "type": "string", "nullable": true, "format": "uuid", "description": "A referenceId of a Knowledge Store this Agent will use as base knowledge or null.", "example": "c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b" }, "description": { "type": "string", "maxLength": 1000, "description": "A short description of the AI Agent, up to 1000 characters.", "example": "I am a virtual assistant that can help you with your questions." }, "speakingStyle": { "type": "object", "properties": { "completeness": { "type": "string" }, "formality": { "type": "string" } }, "example": { "completeness": "concise", "formality": "formal" } }, "voiceConfigs": { "type": "object", "properties": { "ttsVoice": { "type": "string" }, "ttsLanguage": { "type": "string" }, "ttsVendor": { "enum": [ "aws", "deepgram", "elevenlabs", "google", "microsoft", "nuance", "default", "custom", "none" ], "type": "string" }, "ttsModel": { "type": "string" }, "ttsLabel": { "type": "string" }, "ttsDisableCache": { "type": "boolean" } }, "example": { "ttsVoice": "Xb7hH8MSUJpSbSDYk0k2", "ttsLanguage": "zh", "ttsVendor": "Elevenlabs", "ttsModel": "eleven_multilingual_v2", "ttsLabel": "microsoft US", "ttsDisableCache": false } }, "enableVoiceConfigs": { "type": "boolean", "description": "Enables the use of voice configuration.", "example": false }, "enableAutoLanguageDetection": { "type": "boolean", "description": "Whether the AI Agent should automatically detect and respond in the user's language.", "example": true }, "safetySettings": { "type": "object", "properties": { "avoidHarmfulContent": { "type": "boolean" }, "avoidUngroundedContent": { "type": "boolean" }, "avoidCopyrightInfringements": { "type": "boolean" }, "preventJailbreakAndManipulation": { "type": "boolean" } } }, "contactProfilesOption": { "type": "string", "enum": [ "none", "selectedProfileFields", "completeProfile", "profileMemoriesOnly" ], "description": "Option to enable or customize Contact profiles selection for the AI Agent.", "example": "selectedProfileFields" }, "contactProfilesSelected": { "type": "array", "items": { "type": "string" }, "description": "Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.", "example": [ "name", "email" ] }, "instructions": { "type": "string", "description": "Instructions for the AI Agent.", "example": "I can help you with your questions, provide information and much more.", "maxLength": 1000 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "nodeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 2 } } } } } }, "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/flows/{flowId}/chart/nodes/output/generate": { "post": { "operationId": "generateNodeOutput_2_0", "summary": "Generate Output for a Node", "description": "Generates content for a Node using generative AI. The generated output, either text or an adaptive card, is returned in the response and can be copied into the Node for testing or development. No node ID is required.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "userText": { "type": "string", "example": "greetings" }, "outputType": { "type": "string", "example": "text", "enum": [ "text", "adaptiveCard" ] }, "lastOutput": { "type": "string", "description": "Last adaptive card output", "example": "{\"$schema\":\"http://adaptivecards.io/schemas/adaptive-card.json\", ...}" }, "generateContentLimit": { "type": "number", "description": "The number of sentences to be generated", "example": 3 } } } } } }, "responses": { "200": { "description": "Returns output", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "output": { "type": "object", "properties": { "type": { "type": "string", "example": "AdaptiveCard" }, "body": { "type": "array", "items": { "type": "object" } }, "actions": { "type": "array", "items": { "type": "object" } }, "version": { "type": "string", "example": 1 }, "speak": { "type": "string", "example": "create a poll for playing football on saturday at 3pm with the following options: yes, no, maybe" } } }, "outputType": { "type": "string", "example": "adaptiveCard" } } }, { "type": "object", "properties": { "output": { "type": "array", "items": { "type": "string", "example": "Greetings" } }, "outputType": { "type": "string", "example": "text" } } } ] } } } }, "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/flows/{flowId}/chart/nodes/search": { "get": { "operationId": "searchFlowChartNodes_2_0", "summary": "Search for Nodes", "description": "Searches for Nodes in a flow using a given filter word. Fill in the `filter` parameter to search for Nodes.", "tags": [ "Nodes" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "Filter records by specific field eg:name." }, { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns an array of Nodes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "nodeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "nodeReferenceId": { "type": "string", "format": "uuid" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "fieldType": { "type": "string" }, "matchPath": { "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/packages": { "post": { "operationId": "createPackage_beta", "summary": "Create a Package", "description": "Creates a task to create a [Package](https://docs.cognigy.com/ai/resources/build/packages).", "tags": [ "Packages" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" }, "resourceIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "202": { "description": "Created a Task to create the Package.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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": [] } ] }, "get": { "operationId": "indexPackages_beta", "summary": "Get Packages", "description": "Gets Packages in a Project. By default, 25 Packages are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Packages" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the package to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of package metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" }, "hash": { "type": "string", "description": "The hash of the Package identifying the contents of the Package" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/packages/{packageId}": { "delete": { "operationId": "deletePackage_beta", "summary": "Delete a Package", "description": "Creates a task to delete a [Package](https://docs.cognigy.com/ai/resources/build/packages).", "tags": [ "Packages" ], "parameters": [ { "in": "path", "name": "packageId", "description": "The Id of the Package", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Successfully created Task to delete the Package.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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": [] } ] }, "get": { "operationId": "readPackage_beta", "summary": "Get a Package", "description": "Gets information about a [Package](https://docs.cognigy.com/ai/resources/build/packages).", "tags": [ "Packages" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "packageId", "description": "The Id of the Package", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Package Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Package", "example": "New Package" }, "description": { "type": "string", "description": "The description of the Package", "example": "Version 1" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "hash": { "type": "string", "description": "The hash identifying the contents of the Package", "example": "Version 1" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } } } } }, "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/packages/{packageId}/downloadlink": { "post": { "operationId": "composePackageDownloadLink", "summary": "Create a Download Link", "description": "Creates a link to download a [Package](https://docs.cognigy.com/ai/platform-features/packages).", "tags": [ "Packages" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "packageId", "description": "The Id of the Package", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returning a link to download the Package", "content": { "application/json": { "schema": { "type": "object", "properties": { "downloadLink": { "type": "string", "format": "uri" } } } } } }, "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/packages/{packageId}/merge": { "post": { "operationId": "mergePackage_beta", "summary": "Merge a Package", "description": "Creates a task to merge a [Package](https://docs.cognigy.com/ai/resources/build/packages).", "tags": [ "Packages" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "packageId", "description": "The Id of the Package", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "resourceIds" ], "properties": { "resourceIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "strategies": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rename": { "type": "string", "description": "explicitly sets a new name for the imported resource", "example": "new flow" }, "autoRename": { "type": "boolean", "description": "If set to true, will append a \"counter-suffix\" to the name in\ncase the name already exists in the agent.\n", "default": true, "example": true }, "identityConflictStrategy": { "type": "string", "description": "Defines what should be done in case the agent already contains a resource\nwith the same id.\n", "default": "abort", "enum": [ "replace", "re-identify", "abort", "merge" ] }, "mergeStrategy": { "type": "object", "properties": { "replaceContent": { "type": "boolean" }, "replaceStructure": { "type": "boolean" }, "localeOverrides": { "type": "array", "items": { "type": "object", "properties": { "replaceContent": { "type": "boolean" }, "localeId": { "type": "string" } } } } } } } } }, "localeMapping": { "type": "array", "items": { "type": "object", "properties": { "agentLocaleId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "packageLocaleId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } } }, "responses": { "202": { "description": "Successfully created a Task to merge the Package.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/packages/upload": { "post": { "operationId": "uploadPackage_beta", "summary": "Upload a Package", "description": "Uploads a [Package](https://docs.cognigy.com/ai/resources/build/packages) and creates a task to unpack it in the Project.", "tags": [ "Packages" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "202": { "description": "Successfully uploaded the Package and created a Task to process it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/playbooks": { "patch": { "operationId": "batchPlaybooks_2_0", "summary": "Perform Batch Operations", "description": "Performs batch operations on Playbooks.", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Playbook", "example": "New Playbook" }, "abortOnError": { "type": "boolean", "description": "Flag whether to stop Playbook execution when an assert-error occurred" }, "timeout": { "type": "integer", "description": "A time (in ms) after which a playbook step is 'invalid/failed'", "example": 2000, "minimum": 1 } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Playbook", "example": "New Playbook" }, "abortOnError": { "type": "boolean", "description": "Flag whether to stop Playbook execution when an assert-error occurred" }, "timeout": { "type": "integer", "description": "A time (in ms) after which a playbook step is 'invalid/failed'", "example": 2000, "minimum": 1 } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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": [] } ] }, "post": { "operationId": "createPlaybook_2_0", "summary": "Create a Playbook", "description": "Creates a [Playbook](https://docs.cognigy.com/ai/agents/build/playbooks) in a Project.", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "resourceId", "description": "An Id of a resource within the corresponding project to copy from", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "projectId", "abortOnError", "timeout" ], "properties": { "name": { "type": "string", "description": "The name of the Playbook", "example": "New Playbook" }, "projectId": { "type": "string", "description": "The id of the project", "example": "66e06026706e6e0016a30e12" }, "abortOnError": { "type": "boolean", "description": "Flag whether to stop Playbook execution when an assert-error occurred", "example": false }, "timeout": { "type": "integer", "description": "A time (in ms) after which a playbook step is 'invalid/failed'", "example": 2000, "minimum": 1 } } } } } }, "responses": { "201": { "description": "Returns created Playbook object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Playbook", "example": "New Playbook" }, "abortOnError": { "type": "boolean", "description": "Flag whether to stop Playbook execution when an assert-error occurred" }, "timeout": { "type": "integer", "description": "A time (in ms) after which a playbook step is 'invalid/failed'", "example": 2000, "minimum": 1 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "object", "description": "The data of this playbook step" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "asserts": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexPlaybooks_2_0", "summary": "Get Playbooks", "description": "Gets [Playbooks](https://docs.cognigy.com/ai/agents/test/playbooks) in a Project. By default, 25 Playbooks are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the playbook to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns paginated array of Playbooks.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the playbook", "example": "New Playbook" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/playbooks/{playbookId}": { "delete": { "operationId": "deletePlaybook_2_0", "summary": "Delete a Playbook", "description": "Deletes a [Playbook](https://docs.cognigy.com/ai/agents/test/playbooks) from a Project.", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted the Playbook" }, "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": [] } ] }, "get": { "operationId": "readPlaybook_2_0", "summary": "Get a Playbook", "description": "Gets data about a [Playbook](https://docs.cognigy.com/ai/agents/test/playbooks).", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Playbook Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Playbook", "example": "New Playbook" }, "abortOnError": { "type": "boolean", "description": "Flag whether to stop Playbook execution when an assert-error occurred" }, "timeout": { "type": "integer", "description": "A time (in ms) after which a playbook step is 'invalid/failed'", "example": 2000, "minimum": 1 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "steps": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "object", "description": "The data of this playbook step" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "asserts": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updatePlaybook_2_0", "summary": "Update a Playbook", "description": "Updates Playbook data in a Project.", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Playbook", "example": "New Playbook" }, "abortOnError": { "type": "boolean", "description": "Flag whether to stop Playbook execution when an assert-error occurred" }, "timeout": { "type": "integer", "description": "A time (in ms) after which a playbook step is 'invalid/failed'", "example": 2000, "minimum": 1 } } } } } }, "responses": { "204": { "description": "Successfully updated the Playbook." }, "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/playbooks/{playbookId}/runs": { "get": { "operationId": "indexPlaybookRuns_2_0", "summary": "List Playbook Runs", "description": "Lists runs from a Playbook.", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "Filter records by specific field eg:name." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns paginated array of Playbook Runs.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Status of the whole Playbook Run", "example": "successful" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/playbooks/{playbookId}/runs/{playbookRunId}": { "delete": { "operationId": "deletePlaybookRun_2_0", "summary": "Delete a Playbook Run", "description": "Deletes a [Playbook run](https://docs.cognigy.com/ai/agents/test/playbooks) from a Project.", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "playbookRunId", "description": "The Id of the Playbook Run", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted the Playbook Run" }, "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": [] } ] }, "get": { "operationId": "readPlaybookRun_2_0", "summary": "Retrieve a Playbook Run", "description": "Retrieves data about a [Playbook run](https://docs.cognigy.com/ai/agents/test/playbooks).", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "playbookRunId", "description": "The Id of the Playbook Run", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Playbook Run object", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether the playbook run was successful or failed", "example": "successful" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "stepResults": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether this playbook step was successful or failed", "example": "failed" }, "text": { "type": "string", "description": "Text which we shoot into the system", "example": "Hello, how are you?" }, "data": { "type": "object", "description": "Data which we shoot into the system" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "asserts": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the assert", "example": "assertText" }, "status": { "type": "string", "enum": [ "successful", "failed" ], "description": "Whether this playbook step was successful or failed", "example": "failed" }, "params": { "type": "object", "description": "Parameters for the assert" }, "negate": { "type": "boolean", "description": "Whether the assert was negated", "example": false }, "actual": { "type": "object", "description": "Actual output" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "timeout": { "type": "boolean", "description": "Whether the step timed out" } } } }, "flowId": { "type": "string", "description": "Reference Id of the flow", "example": "uuid" }, "localeId": { "type": "string", "description": "Reference Id of the locale", "example": "uuid" }, "entrypoint": { "type": "string", "description": "snapshot or project ID", "example": "^[a-z0-9]{24}$" } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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/playbooks/{playbookId}/schedule": { "post": { "operationId": "schedulePlaybookRun_2_0", "summary": "Schedule a Playbook Run", "description": "Schedules a Playbook Run.", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entrypoint": { "type": "string", "description": "snapshot or project ID", "example": "61f25579055c2f43c249a181" }, "flowId": { "type": "string", "description": "The reference ID of the flow", "example": "010d1970-89b9-4012-892b-53c78ef6c117" }, "localeId": { "type": "string", "description": "The reference ID of locale", "example": "8b3b45e2-48f9-446d-a4c5-35d8284a01b2" } } } } } }, "responses": { "200": { "description": "Successfully scheduled the Playbook Run. Returns the created task (run) metadata.", "content": { "application/json": { "schema": { "type": "object", "description": "Created task metadata (same shape as ITaskReturnValue).", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "Task status (e.g. queued, active, done)", "example": "queued" }, "type": { "type": "string", "description": "Task type (e.g. runPlaybook)", "example": "runPlaybook" }, "parameters": { "type": "object", "description": "Task payload (playbookId, projectId, entrypoint, flowId, localeId, etc.)" }, "createdAt": { "type": "number", "description": "Unix timestamp in seconds when the task was created" }, "lastChangedAt": { "type": "number", "description": "Unix timestamp in seconds when the task was last updated" }, "progress": { "type": "integer", "minimum": 0, "maximum": 100, "description": "Task progress (0-100)" }, "job": { "type": "object", "description": "Present only when the task runs as a Kubernetes job", "properties": { "name": { "type": "string" }, "namespace": { "type": "string" }, "timeoutInMs": { "type": "number" } } } } } } } }, "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/playbooks/{playbookId}/steps": { "post": { "operationId": "createPlaybookStep_2_0", "summary": "Create a Playbook Step", "description": "Creates a step in a [Playbook](https://docs.cognigy.com/ai/agents/test/playbooks).", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "object", "description": "The data of this playbook step" } } } } } }, "responses": { "201": { "description": "Returns created Playbook Step object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "object", "description": "The data of this playbook step" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "asserts": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } } }, "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/playbooks/{playbookId}/steps/{stepId}": { "delete": { "operationId": "deletePlaybookStep_2_0", "summary": "Delete a Playbook Step", "description": "Deletes a step from a [Playbook](https://docs.cognigy.com/ai/agents/test/playbooks).", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "stepId", "description": "The Id of the Playbook Step", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted the Playbook Step" }, "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": [] } ] }, "patch": { "operationId": "updatePlaybookStep_2_0", "summary": "Update a Playbook Step", "description": "Updates a step in a [Playbook](https://docs.cognigy.com/ai/agents/test/playbooks).", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "stepId", "description": "The Id of the Playbook Step", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "description": "The text of the playbook step", "example": "hello world!" }, "data": { "type": "object", "description": "The data of this playbook step" } } } } } }, "responses": { "204": { "description": "Successfully updated the Playbook Step." }, "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/playbooks/{playbookId}/steps/{stepId}/asserts": { "post": { "operationId": "createPlaybookStepAssert_2_0", "summary": "Create an Assertion", "description": "Creates an [assertion](https://docs.cognigy.com/ai/agents/test/assertions) for a Playbook step.", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "stepId", "description": "The Id of the Playbook Step", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" } } } } } }, "responses": { "201": { "description": "Returns created Playbook Step Assert object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/playbooks/{playbookId}/steps/{stepId}/asserts/{assertId}": { "delete": { "operationId": "deletePlaybookStepAssert_2_0", "summary": "Delete a Playbook Step Assert", "description": "Deletes an assertion from a [Playbook step](https://docs.cognigy.com/ai/agents/test/playbooks).", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "stepId", "description": "The Id of the Playbook Step", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "assertId", "description": "The Id of the Playbook Step Assert", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted the Playbook Step Assert" }, "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": [] } ] }, "patch": { "operationId": "updatePlaybookStepAssert_2_0", "summary": "Update a Playbook Step Assert", "description": "Updates an [assertion](https://docs.cognigy.com/ai/agents/test/assertions) from a [Playbook step](https://docs.cognigy.com/ai/agents/test/playbooks).", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "stepId", "description": "The Id of the Playbook Step", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "assertId", "description": "The Id of the Playbook Step Assert", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the Assert", "enum": [ "assertText", "assertData", "assertState", "assertContext", "assertIntent", "assertSlot" ] }, "params": { "type": "object" } } } } } }, "responses": { "204": { "description": "Successfully updated the PlaybookStepAssert" }, "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/playbooks/{playbookId}/steps/order": { "post": { "operationId": "changePlaybookStepOrder_2_0", "summary": "Change Step Order", "description": "Changes the order of [Playbook steps](https://docs.cognigy.com/ai/agents/test/playbooks).", "tags": [ "Playbooks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "playbookId", "description": "The Id of the Playbook", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "stepIds" ], "properties": { "stepIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "description": "All Playbook Step ids in the new order (must include every step of the playbook exactly once)" } } } } } }, "responses": { "204": { "description": "Successfully changed the order of the Playbook steps." }, "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": { "post": { "operationId": "createProject_2_0", "summary": "Create a Project", "description": "Creates a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects).", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } }, "locale": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] } } } } } }, "responses": { "201": { "description": "Returns Project", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } }, "liveAgentDefaultInbox": { "type": "number", "description": "Live agent default inbox Id for the project" }, "primaryLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexProjects_2_0", "summary": "Get Projects", "description": "Gets [Projects](https://docs.cognigy.com/ai/resources/agents/agents/) in an organization. By default, 25 Projects are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 name of the project to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "query", "description": "If the requester is admin, then with ignoreOwnership true all projects within the organisation will be listed", "name": "ignoreOwnership", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "Returns an array of Projects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } }, "liveAgentDefaultInbox": { "type": "number", "description": "Live agent default inbox Id for the project" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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}": { "delete": { "operationId": "deleteProject_2_0", "summary": "Delete a Project", "description": "Deletes a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects).", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Successfully deleted the Project." }, "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": [] } ] }, "get": { "operationId": "readProject_2_0", "summary": "Get a Project", "description": "Gets data from a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects).", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Project Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } }, "liveAgentDefaultInbox": { "type": "number", "description": "Live agent default inbox Id for the project" }, "primaryLocaleReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateProject_2_0", "summary": "Update a Project", "description": "Updates the data of a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects).", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } } } } } } }, "responses": { "201": { "description": "Successfully updated the Project." }, "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}/graph": { "get": { "operationId": "projectGraph_2_0", "summary": "Get a Graph", "description": "Gets a graph showing all resources of a Project, Snapshot or Package.", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "snapshots", "schema": { "type": "string", "default": false, "enum": [ false, true ] } }, { "in": "query", "name": "packages", "schema": { "type": "string", "default": false, "enum": [ false, true ] } } ], "responses": { "200": { "description": "Returns a Graph of the Project.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "example": "project", "enum": [ "project", "snapshot" ] }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "resources": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "lexicon" }, "properties": { "type": "object" } } } } } } ] } } } } }, "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}/nlu/scores": { "post": { "operationId": "generateNluScores", "summary": "Generate NLU Scores", "description": "Generate a NLU score for an sentence by analyzing Intents in a Flow and Locale.", "tags": [ "Projects" ], "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "flowReferenceId", "localeReferenceId", "sentence" ], "properties": { "flowReferenceId": { "type": "string", "format": "uuid", "description": "UUID of the flow reference." }, "localeReferenceId": { "type": "string", "format": "uuid", "description": "UUID of the locale reference." }, "sentence": { "type": "string", "description": "Sentence to analyze for NLU scoring." } } } } } }, "responses": { "200": { "description": "Returns a collection of matching NLU Intents and Scores for the given sentence.", "content": { "application/json": { "schema": { "type": "object", "properties": { "scores": { "type": "array", "description": "NLU scores based on the analysis.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the score." }, "name": { "type": "string", "description": "Name of the score type." }, "score": { "type": "number", "description": "Numerical value of the score." }, "negated": { "type": "boolean", "description": "Indicates if the score is negated." }, "confirmationSentence": { "type": "string", "description": "Sentence used to confirm the score." }, "confirmationSentences": { "type": "array", "items": { "type": "string" }, "description": "Multiple sentences for confirmation if applicable." }, "disambiguationSentence": { "type": "string", "description": "Sentence used for disambiguation." }, "flow": { "type": "string", "description": "UUID of the flow associated with the score." } } } } } }, "example": { "scores": [ { "id": "8870303c-2934-4145-a9c4-e2d89f05e3cf", "name": "food", "score": 0.6269008375746541, "negated": false, "confirmationSentence": null, "confirmationSentences": null, "disambiguationSentence": null, "flow": "43b8f152-f82c-4d0b-b7ae-04db34de8b68" } ] } } } }, "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}/settings": { "get": { "operationId": "readAgentSettings_2_0", "summary": "Get Project Settings", "description": "Gets the settings of a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects).", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the Settings of the Project", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone according to IANA Timezone Database (2020a)", "example": "Europe/Berlin", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ] }, "useCaseSensitiveIntentMapping": { "type": "boolean" }, "collectAnalytics": { "type": "boolean" }, "trackDataOnlyInputs": { "type": "boolean" }, "translationSettings": { "type": "object", "properties": { "provider": { "type": "string", "description": "Supported Translation Providers", "enum": [ "none", "microsoft", "google", "deepl" ] }, "connections": { "type": "object", "properties": { "microsoft": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "deepl": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "google": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } } } } } }, "audioPreviewSettings": { "type": "object", "properties": { "provider": { "type": "string", "description": "Supported AudioPreview Providers", "enum": [ null, "microsoft", "google", "aws" ] }, "connections": { "type": "object", "properties": { "microsoft": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "aws": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "google": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } } } } } }, "generativeAISettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useCasesSettings": { "type": "object", "properties": { "designTimeGeneration": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "aiEnhancedOutputs": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "gptConversation": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "gptPromptNode": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "knowledgeSearch": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } } } } } }, "currencySettings": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" } } }, "knowledgeAISettings": { "type": "object", "properties": { "fileExtractor": { "type": "string", "description": "Options for the Knowledge AI File Extractor", "enum": [ "default", "legacy", "azure" ] }, "azureDIConnectionId": { "type": "string", "description": "ReferenceId of the Azure AI Document Intelligence Connection", "example": "f66e99eb-db8f-433c-977f-69160d9a6bdb" } } }, "piiDataRedactionSettings": { "type": "object", "properties": { "emailAddress": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "phoneNumber": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "creditCard": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ssn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ipAddressV4": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ipAddressV6": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "customTypes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the custom PII field type" }, "regex": { "type": "string", "description": "Regular expression pattern to match custom PII data (RE2 syntax)", "minLength": 1, "maxLength": 2000 } }, "required": [ "behavior", "scope", "name", "regex" ] }, "description": "User-defined custom PII patterns with regex matching" } }, "required": [ "emailAddress", "phoneNumber", "creditCard", "ssn", "ipAddressV4", "ipAddressV6" ] }, "intentThreshold": { "type": "object", "properties": { "lower": { "type": "number", "example": 0.4 }, "upper": { "type": "number", "example": 0.5 } } }, "learnNewExampleSentences": { "type": "boolean" }, "learnNewExampleSentencesThreshold": { "type": "integer" }, "negativeConfirmationWords": { "type": "array", "items": { "type": "string" } }, "positiveConfirmationWords": { "type": "array", "items": { "type": "string" } }, "systemSlots": { "type": "object", "properties": { "useAgeSlots": { "type": "boolean" }, "useDateSlots": { "type": "boolean" }, "useDistanceSlots": { "type": "boolean" }, "useDurationSlots": { "type": "boolean" }, "useEmailSlots": { "type": "boolean" }, "useMoneySlots": { "type": "boolean" }, "useNumberSlots": { "type": "boolean" }, "usePercentageSlots": { "type": "boolean" }, "useTemperatureSlots": { "type": "boolean" }, "useURLSlots": { "type": "boolean" } } }, "yesNoLogic": { "type": "string", "enum": [ "yesNoIntents", "yesNoIntentsWithRules", "confirmationWords" ] }, "yesNoIntentThreshold": { "type": "integer" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateAgentSettings_2_0", "summary": "Update Project Settings", "description": "Updates the settings of a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects).", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone according to IANA Timezone Database (2020a)", "example": "Europe/Berlin", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ] }, "useCaseSensitiveIntentMapping": { "type": "boolean" }, "collectAnalytics": { "type": "boolean" }, "trackDataOnlyInputs": { "type": "boolean" }, "translationSettings": { "type": "object", "properties": { "provider": { "type": "string", "description": "Supported Translation Providers", "enum": [ "none", "microsoft", "google", "deepl" ] }, "connections": { "type": "object", "properties": { "microsoft": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "deepl": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } }, "google": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" }, "retries": { "type": "string", "description": "Number of retries", "default": 1 }, "timeout": { "type": "string", "description": "Timeout in milliseconds", "default": 3000 }, "cacheExpiry": { "type": "string", "description": "Cache expiry in milliseconds", "default": 0 }, "customBaseUrl": { "type": "string", "description": "Custom base url", "default": "" } } } } } } }, "audioPreviewSettings": { "type": "object", "properties": { "provider": { "type": "string", "description": "Supported AudioPreview Providers", "enum": [ null, "microsoft", "google", "aws" ] }, "connections": { "type": "object", "properties": { "microsoft": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "aws": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } }, "google": { "type": "object", "properties": { "connecionId": { "type": "string", "description": "ReferenceId to the connection provider" } } } } } } }, "generativeAISettings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "useCasesSettings": { "type": "object", "properties": { "designTimeGeneration": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "aiEnhancedOutputs": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "gptConversation": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "gptPromptNode": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } }, "knowledgeSearch": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/Disable the usecase." }, "largeLanguageModelId": { "type": "string", "description": "reference Id to the LargeLanguageModel object" }, "temperature": { "type": "integer", "minimum": 0, "maximum": 1, "description": "Defines the creativity of the model" } } } } } } }, "currencySettings": { "type": "object", "properties": { "currency": { "type": "string", "example": "USD" } } }, "knowledgeAISettings": { "type": "object", "properties": { "fileExtractor": { "type": "string", "description": "Options for the Knowledge AI File Extractor", "enum": [ "default", "legacy", "azure" ] }, "azureDIConnectionId": { "type": "string", "description": "ReferenceId of the Azure AI Document Intelligence Connection", "example": "f66e99eb-db8f-433c-977f-69160d9a6bdb" } } }, "piiDataRedactionSettings": { "type": "object", "properties": { "emailAddress": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "phoneNumber": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "creditCard": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ssn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ipAddressV4": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "ipAddressV6": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether PII redaction is enabled for this field type" }, "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the PII field type" } }, "required": [ "enabled", "behavior", "scope", "name" ] }, "customTypes": { "type": "object", "additionalProperties": { "type": "object", "properties": { "behavior": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "predefined-alias" ] }, "customAlias": { "type": "string", "nullable": true } }, "required": [ "type", "customAlias" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "custom-alias" ] }, "customAlias": { "type": "string", "description": "Custom alias to replace PII data with" } }, "required": [ "type", "customAlias" ] } ] }, "scope": { "type": "object", "properties": { "logs": { "type": "boolean", "description": "Whether to redact PII in logs" }, "analytics": { "type": "boolean", "description": "Whether to redact PII in analytics" } }, "required": [ "logs", "analytics" ] }, "name": { "type": "string", "description": "Display name for the custom PII field type" }, "regex": { "type": "string", "description": "Regular expression pattern to match custom PII data (RE2 syntax)", "minLength": 1, "maxLength": 2000 } }, "required": [ "behavior", "scope", "name", "regex" ] }, "description": "User-defined custom PII patterns with regex matching" } }, "required": [ "emailAddress", "phoneNumber", "creditCard", "ssn", "ipAddressV4", "ipAddressV6" ] }, "intentThreshold": { "type": "object", "properties": { "lower": { "type": "number", "example": 0.4 }, "upper": { "type": "number", "example": 0.5 } } }, "learnNewExampleSentences": { "type": "boolean" }, "learnNewExampleSentencesThreshold": { "type": "integer" }, "negativeConfirmationWords": { "type": "array", "items": { "type": "string" } }, "positiveConfirmationWords": { "type": "array", "items": { "type": "string" } }, "systemSlots": { "type": "object", "properties": { "useAgeSlots": { "type": "boolean" }, "useDateSlots": { "type": "boolean" }, "useDistanceSlots": { "type": "boolean" }, "useDurationSlots": { "type": "boolean" }, "useEmailSlots": { "type": "boolean" }, "useMoneySlots": { "type": "boolean" }, "useNumberSlots": { "type": "boolean" }, "usePercentageSlots": { "type": "boolean" }, "useTemperatureSlots": { "type": "boolean" }, "useURLSlots": { "type": "boolean" } } }, "yesNoLogic": { "type": "string", "enum": [ "yesNoIntents", "yesNoIntentsWithRules", "confirmationWords" ] }, "yesNoIntentThreshold": { "type": "integer" } } } } } }, "responses": { "204": { "description": "Successfully updated the AgentSettings" }, "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}/settings/setupgenerativeai": { "post": { "operationId": "setupCognigyGenerativeAI", "summary": "Set Up Cognigy Generative AI", "description": "Sets up Cognigy Generative AI for a Project.", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Cognigy GenerativeAI was successfully setup for the project and returns the full project settings with generativeAI configuration or an error message." }, "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}/settings/translation/test": { "post": { "operationId": "testTranslationSettings_2_0", "summary": "Test a Translation Provider Connection", "description": "Validates the connection with a translation provider.", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Translation configuration have been validated and the connection was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "language": { "type": "string" }, "error": { "type": "object" }, "msg": { "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}/trainallflows": { "post": { "operationId": "trainallflows_2_0", "summary": "Train Flow Models", "description": "Trains the NLU model of all Flows in a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects).", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Successfully created Task to train all Flows in the Project.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/createbytemplate": { "post": { "operationId": "createProjectByTemplate_2_0", "summary": "Create a Project from a Template", "description": "Creates a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects) from a template.", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Project", "example": "New Project" }, "color": { "type": "string", "example": "blue", "oneOf": [ { "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" ] }, { "type": "string", "example": "cognigyGrey", "enum": [ "amber", "blueGrey", "cognigyBlue", "cognigyGrey", "deepOrange", "deepPurple", "lightBlue", "lightGreen" ] } ] }, "handoverConfiguration": { "type": "object", "properties": { "setupLiveAgentInbox": { "type": "boolean" }, "whisperAssistConfiguration": { "type": "string", "enum": [ "none", "basic", "template" ] } } }, "locale": { "type": "string", "example": "en-US", "enum": [ "ge-GE", "da-DK", "en-AU", "en-CA", "en-IN", "en-GB", "en-US", "de-DE", "ja-JP", "ko-KR", "es-ES", "nl-NL", "ar-AE", "fi-FI", "fr-FR", "it-IT", "nn-NO", "pl-PL", "sv-SE", "th-TH", "zh-CN", "vi-VN", "pt-BR", "ru-RU", "pt-PT", "tr-TR", "hi-IN", "bn-IN", "ta-IN" ] }, "templateConfiguration": { "type": "object", "properties": { "endpoints": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string" } } } }, "skills": { "type": "array", "items": { "type": "string" } }, "template": { "type": "string" } } } } } } } }, "responses": { "202": { "description": "Successfully created Task to create Project by template", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/validateprojectname": { "post": { "operationId": "validateProjectName_2_0", "summary": "Validate a Project Name", "description": "Checks whether Project name is already used in the organization.", "tags": [ "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "204": { "description": "The project name can be used." }, "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 project name can't be used as it is already being used." }, "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/search": { "get": { "operationId": "searchResources_2_0", "summary": "Search Resources", "description": "Searches resources across the organization and list the first 25 results by default. This endpoint searches only for Extensions, Projects, Lexicons, Endpoints, Flows, Functions, Playbooks, NLU Connectors, Snapshots, and Simulations. To change the default number of listed results, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Search" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "Filter records by specific field eg:name." }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of search results", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "pizza-endpoint" }, "type": { "type": "string", "description": "The type of a resource", "example": "endpoint", "enum": [ "endpoint", "extension", "flow", "function", "lexicon", "goal", "handoverProvider", "nluconnector", "playbook", "project", "snapshot" ] }, "subType": { "oneOf": [ { "type": "string", "description": "The NLUConnector type", "example": "cognigy", "enum": [ "alexa", "dialogflow", "dialogflowBuiltIn", "amazonLexBuiltIn", "luis", "watson", "noNlu", "cognigy", "code", "generativeAI", "lex" ] }, { "type": "string", "example": "webchat3", "enum": [ "facebook", "alexa", "slack", "generic", "inject", "rest", "realtime", "socket", "adminconsole", "webchat2", "dialogflow", "twilio", "twilio-sms", "line", "intercom", "microsoftBotFramework", "microsoftTeams", "sunshineConversations", "admin-webchat", "avaya", "nonConversational", "voiceGateway2", "amazonLex", "workplace", "webhook", "abstractRest", "userlike", "ringCentralEngage", "audioCodes", "bandwidth", "whatsapp", "eightByEight", "genesysBotConnector", "niceCXOne", "agentAssistVoice", "webchat3", "niceCXOneAAH", "zoomContactCenter", "mcpServer" ] }, { "type": "string", "description": "Supported Generative AI Providers", "enum": [ "openAI", "openAICompatible", "azureOpenAI", "anthropic", "googleVertexAI", "googleGemini", "alephAlpha", "awsBedrock", "mistral" ] } ] }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/flows/{flowId}/intents/{intentId}/sentences": { "patch": { "operationId": "batchSentences_2_0", "summary": "Perform Batch Operations", "description": "Performs batch operations on [Sentences](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) in an Intent.", "tags": [ "Sentences" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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": [] } ] }, "post": { "operationId": "createSentence_2_0", "summary": "Create an Example Sentence", "description": "Creates an [Example Sentence](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) for an Intent.", "tags": [ "Sentences" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } } } } } } }, "responses": { "201": { "description": "Returns Sentence metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexSentences_2_0", "summary": "Get Example Sentences", "description": "Gets [Example Sentences](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) from an Intent. By default, 25 Example Sentences are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Sentences" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The text of the sentence to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "query", "name": "preferredLocaleId", "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns array of a Sentence metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slots": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "tagReference": { "type": "string" }, "lexiconReference": { "type": "string" } } } }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/flows/{flowId}/intents/{intentId}/sentences/{sentenceId}": { "delete": { "operationId": "deleteSentence_2_0", "summary": "Delete an Example Sentence", "description": "Deletes an [Example Sentence](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) from an Intent.", "tags": [ "Sentences" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sentenceId", "description": "The Id of the Sentence", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted sentence" }, "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": [] } ] }, "get": { "operationId": "readSentence_2_0", "summary": "Get an Example Sentence", "description": "Gets an [Example Sentence](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) from an Intent.", "tags": [ "Sentences" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sentenceId", "description": "The Id of the Sentence", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Sentence Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateSentence", "summary": "Update an Example Sentence", "description": "Updates an [Example Sentence](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) for an Intent.", "tags": [ "Sentences" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sentenceId", "description": "The Id of the Sentence", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } } } } } } }, "responses": { "204": { "description": "Successfully updated Sentence" }, "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/flows/{flowId}/intents/{intentId}/sentences/generate": { "post": { "operationId": "generateSentences_2_0", "summary": "Generate Example Sentences", "description": "Generates [Example Sentences](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) for an Intent using generative AI.", "tags": [ "Sentences" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "localeId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 5, "maximum": 20 } } ], "responses": { "200": { "description": "Returns array of sentences", "content": { "application/json": { "schema": { "type": "array", "items": { "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/sessions/{sessionId}/context/inject": { "post": { "operationId": "injectContext_2_0", "summary": "Inject a Context", "description": "Injects a context into a session.", "tags": [ "Sessions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "sessionId", "description": "The Id of the Session", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "context" ], "properties": { "userId": { "type": "string", "format": "email", "example": "user@example.com" }, "context": { "type": "object" } } } } } }, "responses": { "200": { "description": "Returns the injected context.", "content": { "application/json": { "schema": { "type": "object", "example": { "key": "value" } } } } }, "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/sessions/{sessionId}/context/reset": { "post": { "operationId": "resetContext_2_0", "summary": "Reset a Context", "description": "Resets a context in a session.", "tags": [ "Sessions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "sessionId", "description": "The Id of the Session", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "flowReferenceId", "entryPoint", "userId" ], "properties": { "flowReferenceId": { "type": "string", "format": "uuid" }, "entryPoint": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "example": "mail@example.com" } } } } } }, "responses": { "200": { "description": "Returns the resetted context.", "content": { "application/json": { "schema": { "type": "object", "example": { "key": "value" } } } } }, "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/sessions/{sessionId}/state/inject": { "post": { "operationId": "injectState_2_0", "summary": "Inject a State", "description": "Injects a State into a session.\n**Deprecated.** The \"State\" feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.\n", "deprecated": true, "tags": [ "Sessions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "sessionId", "description": "The Id of the Session", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "state", "userId" ], "properties": { "state": { "type": "string", "example": "default" }, "userId": { "type": "string", "example": "mail@example.com" } } } } } }, "responses": { "200": { "description": "Returns the injected state.", "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "type": "string", "example": "default" } } } } } }, "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/sessions/{sessionId}/state/reset": { "post": { "operationId": "resetState_2_0", "summary": "Reset a State", "description": "Resets a State in a session.\n**Deprecated.** The \"State\" feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.\n", "deprecated": true, "tags": [ "Sessions" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "sessionId", "description": "The Id of the Session", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "example": "mail@example.com" } } } } } }, "responses": { "204": { "description": "Successfully resetted the state" }, "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/flow/{flowId}/slotfillers": { "patch": { "operationId": "batchSlotFillers_2_0", "summary": "Perform Batch Operations", "description": "Performs batch operations on Slot Fillers.", "tags": [ "Slot Fillers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "usePositiveOnly": { "type": "boolean" }, "removeNegated": { "type": "boolean" }, "storeResultInContext": { "type": "boolean" }, "contextKey": { "type": "string" }, "storeInContactProfile": { "type": "boolean" }, "profileKey": { "type": "string" }, "storeDetailedResults": { "type": "boolean" }, "skipIfResultInContext": { "type": "boolean" }, "additionalValidation": { "type": "string" }, "resultLocation": { "type": "string" }, "regex": { "type": "string" }, "slot": { "type": "string" } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "usePositiveOnly": { "type": "boolean" }, "removeNegated": { "type": "boolean" }, "storeResultInContext": { "type": "boolean" }, "contextKey": { "type": "string" }, "storeInContactProfile": { "type": "boolean" }, "profileKey": { "type": "string" }, "storeDetailedResults": { "type": "boolean" }, "skipIfResultInContext": { "type": "boolean" }, "additionalValidation": { "type": "string" }, "resultLocation": { "type": "string" }, "regex": { "type": "string" }, "slot": { "type": "string" } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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/flows/{flowId}/slotfillers": { "post": { "operationId": "createSlotFiller_2_0", "summary": "Create a Slot Filler", "description": "Creates a Slot Filler in the Project.", "tags": [ "Slot Fillers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "usePositiveOnly": { "type": "boolean" }, "removeNegated": { "type": "boolean" }, "storeResultInContext": { "type": "boolean" }, "contextKey": { "type": "string" }, "storeInContactProfile": { "type": "boolean" }, "profileKey": { "type": "string" }, "storeDetailedResults": { "type": "boolean" }, "skipIfResultInContext": { "type": "boolean" }, "additionalValidation": { "type": "string" }, "resultLocation": { "type": "string" }, "regex": { "type": "string" }, "slot": { "type": "string" } } } } } }, "responses": { "201": { "description": "Returns SlotFiller metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "usePositiveOnly": { "type": "boolean" }, "removeNegated": { "type": "boolean" }, "storeResultInContext": { "type": "boolean" }, "contextKey": { "type": "string" }, "storeInContactProfile": { "type": "boolean" }, "profileKey": { "type": "string" }, "storeDetailedResults": { "type": "boolean" }, "skipIfResultInContext": { "type": "boolean" }, "additionalValidation": { "type": "string" }, "resultLocation": { "type": "string" }, "regex": { "type": "string" }, "slot": { "type": "string" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexSlotFillers_2_0", "summary": "Get Slot Fillers", "description": "Gets Slot Fillers from a Flow. By default, 25 Slot Fillers are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Slot Fillers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the SlotFiller to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a SlotFiller metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "example": "pizza" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "referenceId": { "type": "string" }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/flows/{flowId}/slotfillers/{slotFillerId}": { "delete": { "operationId": "deleteSlotFiller_2_0", "summary": "Delete a Slot Filler", "description": "Deletes a Slot Filler from the Flow.", "tags": [ "Slot Fillers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "slotFillerId", "description": "The Id of the SlotFiller", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted SlotFiller" }, "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": [] } ] }, "get": { "operationId": "readSlotFiller_2_0", "summary": "Get a Slot Filler", "description": "Gets a Slot Filler from a Flow.", "tags": [ "Slot Fillers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "slotFillerId", "description": "The Id of the SlotFiller", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns SlotFiller Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "usePositiveOnly": { "type": "boolean" }, "removeNegated": { "type": "boolean" }, "storeResultInContext": { "type": "boolean" }, "contextKey": { "type": "string" }, "storeInContactProfile": { "type": "boolean" }, "profileKey": { "type": "string" }, "storeDetailedResults": { "type": "boolean" }, "skipIfResultInContext": { "type": "boolean" }, "additionalValidation": { "type": "string" }, "resultLocation": { "type": "string" }, "regex": { "type": "string" }, "slot": { "type": "string" }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateSlotFiller_2_0", "summary": "Update a Slot Filler", "description": "Updates a Slot Filler from a Flow.", "tags": [ "Slot Fillers" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "slotFillerId", "description": "The Id of the SlotFiller", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "example": "age", "enum": [ "age", "date", "duration", "email", "intent", "slot", "money", "number", "percentage", "regex", "temperature" ] }, "usePositiveOnly": { "type": "boolean" }, "removeNegated": { "type": "boolean" }, "storeResultInContext": { "type": "boolean" }, "contextKey": { "type": "string" }, "storeInContactProfile": { "type": "boolean" }, "profileKey": { "type": "string" }, "storeDetailedResults": { "type": "boolean" }, "skipIfResultInContext": { "type": "boolean" }, "additionalValidation": { "type": "string" }, "resultLocation": { "type": "string" }, "regex": { "type": "string" }, "slot": { "type": "string" } } } } } }, "responses": { "204": { "description": "Successfully updated SlotFiller" }, "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/snapshots": { "post": { "operationId": "createSnapshot_2_0", "summary": "Create a Snapshot", "description": "Creates a task to create a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots) in a Project.", "tags": [ "Snapshots" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Snapshot", "example": "New Snapshot" }, "description": { "type": "string", "description": "The description of the Snapshot", "example": "Version 1" }, "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "202": { "description": "Created a Task to create the Snapshot.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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": [] } ] }, "get": { "operationId": "indexSnapshots_2_0", "summary": "Get Snapshots", "description": "Gets [Snapshots](https://docs.cognigy.com/ai/agents/deploy/snapshots) in a Project. By default, 25 Snapshots are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Snapshots" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name the snapshot to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of snapshot metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Snapshot", "example": "New Snapshot" }, "description": { "type": "string", "description": "The description of the Snapshot", "example": "Version 1" }, "isPackaged": { "type": "boolean", "description": "Whether the Snapshot has already been packaged and is ready for download" }, "packageExpiresAt": { "type": "number", "description": "The timestamp where the downloadable package expires" }, "hash": { "type": "string", "description": "The hash of the Snapshot identifying the contents of the Snapshot" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/snapshots/{snapshotId}": { "delete": { "operationId": "deleteSnapshot_2_0", "summary": "Delete a Snapshot", "description": "Creates a task to delete a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots).", "tags": [ "Snapshots" ], "parameters": [ { "in": "path", "name": "snapshotId", "description": "The Id of the Snapshot", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Successfully created Task to delete the Snapshot.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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": [] } ] }, "get": { "operationId": "readSnapshot_2_0", "summary": "Gets a Snapshot", "description": "Gets information about a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots) in a Project.", "tags": [ "Snapshots" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "snapshotId", "description": "The Id of the Snapshot", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Snapshot Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Snapshot", "example": "New Snapshot" }, "description": { "type": "string", "description": "The description of the Snapshot", "example": "Version 1" }, "isPackaged": { "type": "boolean", "description": "Whether the Snapshot has already been packaged and is ready for download" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "hash": { "type": "string", "description": "The hash identifying the contents of the Snapshot", "example": "Version 1" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 } } } } } }, "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/snapshots/{snapshotId}/downloadlink": { "post": { "operationId": "composeSnapshotDownloadLink_2_0", "summary": "Create a Download Link", "description": "Creates a link to download a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots).", "tags": [ "Snapshots" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "snapshotId", "description": "The Id of the Snapshot", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "200": { "description": "Returning a link to download the Snapshot", "content": { "application/json": { "schema": { "type": "object", "properties": { "downloadLink": { "type": "string", "format": "uri" } } } } } }, "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/snapshots/{snapshotId}/package": { "post": { "operationId": "packageSnapshot_2_0", "summary": "Package a Snapshot", "description": "Creates a task to package a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots) in a Project.", "tags": [ "Snapshots" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "snapshotId", "description": "The Id of the Snapshot", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Succesfully started downloading the Snapshot.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/snapshots/{snapshotId}/resources": { "get": { "operationId": "indexResourcesInSnapshot_2_0", "summary": "Get Resources in a Snapshot", "description": "Gets resources of a specific type in a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots). By default, 25 resources are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Snapshots" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "snapshotId", "description": "The Id of the Snapshot", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "resourceType", "description": "The type of a resource", "required": true, "schema": { "type": "string", "enum": [ "flow", "nluconnector", "locale", "flowState" ] } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the specific resource to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of resource metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string", "description": "The name of the Resource", "example": "New Resource" }, "referenceId": { "type": "string", "description": "The reference ID of the resource" }, "resourceType": { "type": "string", "description": "The type of resource", "example": "flow" }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/snapshots/{snapshotId}/restore": { "post": { "operationId": "restoreSnapshot_2_0", "summary": "Restore a Snapshot", "description": "Creates a task to restore a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots).", "tags": [ "Snapshots" ], "parameters": [ { "in": "path", "name": "snapshotId", "description": "The Id of the Snapshot", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "projectId" ], "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "202": { "description": "Successfully created a Task to restore the Snapshot.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/snapshots/upload": { "post": { "operationId": "uploadSnapshotPackage_2_0", "summary": "Upload a Snapshot Package", "description": "Uploads a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots) package and creates a task to unpack it in the Project.", "tags": [ "Snapshots" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "202": { "description": "Successfully uploaded the Snapshot and created a Task to process it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } }, "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/flow/{flowId}/states": { "patch": { "operationId": "batchFlowStates_2_0", "summary": "Perform Batch Operations on States", "description": "Performs batch operations on States in a Flow, such as creating, updating, or deleting multiple States in a request. This method allows efficient management of Flow States in bulk.\n**Deprecated.** The \"State\" feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.\n", "deprecated": true, "tags": [ "States" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "operations": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "type": "string", "enum": [ "delete" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "create" ] }, "value": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "update" ] }, "id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "value": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } ] } } } } } } }, "responses": { "200": { "description": "Successfully ran the batch operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "updated": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "deleted": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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/flows/{flowId}/states": { "post": { "operationId": "createFlowState_2_0", "summary": "Create a State", "description": "Create a State in a Flow.\n**Deprecated.** The \"State\" feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.\n", "deprecated": true, "tags": [ "States" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "responses": { "201": { "description": "Returns the State metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexFlowStates_2_0", "summary": "Get States", "description": "Gets States from a Flow. By default, 25 States are returned. To change this value, use the `limit` query parameter.\n**Deprecated.** The \"State\" feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.\n", "deprecated": true, "tags": [ "States" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The name of the function to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of States", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "referenceId": { "type": "string", "format": "uuid" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/flows/{flowId}/states/{stateId}": { "delete": { "operationId": "deleteFlowState_2_0", "summary": "Delete a State", "description": "Deletes a State from a Flow.\n**Deprecated.** The \"State\" feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.\n", "deprecated": true, "tags": [ "States" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "stateId", "description": "The Id of the State", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The State was successfully deleted." }, "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": [] } ] }, "get": { "operationId": "readFlowState_2_0", "summary": "Get a State", "description": "Gets a State from a Flow.\n**Deprecated.** The \"State\" feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.\n", "deprecated": true, "tags": [ "States" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "stateId", "description": "The Id of the State", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns State Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "referenceId": { "type": "string", "format": "uuid" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateFlowState", "summary": "Update a State", "description": "Updates a State in a Flow. Allows modifying of a State's name, type, default status, and associated Intents.\n**Deprecated.** The \"State\" feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.\n", "deprecated": true, "tags": [ "States" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "stateId", "description": "The Id of the State", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "default" }, "isDefault": { "type": "boolean" }, "type": { "type": "string", "enum": [ "blacklist", "whitelist" ], "example": "blacklist" }, "intentIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "responses": { "204": { "description": "Successfully updated State" }, "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/flows/{flowId}/states/{stateId}/addintent": { "post": { "operationId": "addIntentToFlowState_2_0", "summary": "Add an Intent to a State", "description": "Adds an Intent to a State in a Flow.\n**Deprecated.** The \"State\" feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.\n", "deprecated": true, "tags": [ "States" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "stateId", "description": "The Id of the State", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "Successfully added Intent to the State" }, "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/flows/{flowId}/states/{stateId}/removeintent": { "post": { "operationId": "removeIntentFromFlowState_2_0", "summary": "Remove an Intent from a State", "description": "Removes an Intent from a State in a Flow.\n**Deprecated.** The \"State\" feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.\n", "deprecated": true, "tags": [ "States" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "flowId", "description": "The Id of the Flow", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "stateId", "description": "The Id of the State", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "intentId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "Successfully removed Intent from the State" }, "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/tasks": { "get": { "operationId": "indexTasks_2_0", "summary": "Get Tasks", "description": "Gets [tasks](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#task-panel) from a Project. By default, 25 tasks are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Tasks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "description": "Filter by projectId", "required": false, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The type of the task to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a tasks metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "currentStep": { "type": "integer" }, "totalStep": { "type": "integer" }, "failReason": { "type": "string" }, "lastRunAt": { "type": "string", "format": "date-time" }, "lastFinishedAt": { "type": "string", "format": "date-time" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/tasks/{taskId}": { "get": { "operationId": "readTask_2_0", "summary": "Get a Task", "description": "Gets a [task](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#task-panel) from a Project.", "tags": [ "Tasks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "taskId", "description": "The Id of the Task", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Task Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the task" }, "data": { "type": "object", "description": "The parameters of the task" }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "currentStep": { "type": "integer" }, "totalStep": { "type": "integer" }, "failReason": { "type": "string" }, "lastRunAt": { "type": "string", "format": "date-time" }, "lastFinishedAt": { "type": "string", "format": "date-time" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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/tasks/{taskId}/cancel": { "post": { "operationId": "cancelTask_2_0", "summary": "Cancel a Task", "description": "Cancels a [task](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#task-panel) in a Project.", "tags": [ "Tasks" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "taskId", "description": "The Id of the Task", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Successfully set task to cancelling-state" }, "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}/snippets": { "post": { "operationId": "createSnippet_2_0", "summary": "Create a Token", "description": "Creates a [Token](https://docs.cognigy.com/ai/platform-features/tokens) in a Project.", "tags": [ "Tokens" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "description": "The snippet Name", "example": "New snippet" } } } } } }, "responses": { "201": { "description": "Returns snippet metadata object." }, "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": [] } ] }, "get": { "operationId": "indexSnippets_2_0", "summary": "Get Tokens", "description": "Gets custom [Tokens](https://docs.cognigy.com/ai/platform-features/tokens) in a Project. By default, 25 Tokens are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. Default Tokens aren't included in the results.", "tags": [ "Tokens" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The label of the snippet to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a snippet metadata objects" }, "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}/snippets/{snippetId}": { "delete": { "operationId": "deleteSnippet_2_0", "summary": "Delete a Token", "description": "Deletes a [Token](https://docs.cognigy.com/ai/platform-features/tokens) from a Project.", "tags": [ "Tokens" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "snippetId", "description": "snippet ID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Returns the Project with resources after deleting the specified resource." }, "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}/removeprojectmember": { "post": { "operationId": "removeProjectMember_2_0", "summary": "Remove a Project Member", "description": "Removes a user from a Project.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "Project member was removed." }, "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}/addprojectmember": { "post": { "operationId": "addProjectMember_2_0", "summary": "Add a Project Member", "description": "Adds a user to a Project as a member.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "Project member was added." }, "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}/members": { "get": { "operationId": "indexProjectMembers_2_0", "summary": "Get Project Members", "description": "Gets [members](https://docs.cognigy.com/ai/resources/manage/members/) of a Project. By default, 25 Project members are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 name or id of the member to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns metadata objects for each project member.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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}/members/{userId}": { "get": { "operationId": "readProjectMember_2_0", "summary": "Get a Project Member", "description": "Gets all information about a member of a Project.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns the project member with all information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "agentAssistConfigAdmin", "agentAssistConfigViewer", "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "followUser", "handoverProviderAdmin", "intents", "data_privacy_admin", "data_privacy_editor", "data_privacy_viewer", "knowledgeAdmin", "large_language_model_admin,", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "simulator_admin", "admin" ] } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "acl": { "type": "object" }, "allowedLocales": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateProjectMember_2_0", "summary": "Update a Project Member", "description": "Updates information of a Project member.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "allowedLocales": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } } } }, "responses": { "204": { "description": "Project member was updated." }, "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}/members/{userId}/addroletomember": { "post": { "operationId": "addRoleToMember_2_0", "summary": "Assign a Project Role", "description": "Assigns a project role to a user.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "agentAssistConfigAdmin", "agentAssistConfigViewer", "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "followUser", "handoverProviderAdmin", "intents", "data_privacy_admin", "data_privacy_editor", "data_privacy_viewer", "knowledgeAdmin", "large_language_model_admin,", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "simulator_admin" ] } } } } } }, "responses": { "204": { "description": "User-role was added to the project member." }, "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}/members/{userId}/removerolefrommember": { "post": { "operationId": "removeRoleFromMember_2_0", "summary": "Unassign a Project Role", "description": "Unassigns a Project role from a Project member.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "agentAssistConfigAdmin", "agentAssistConfigViewer", "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "followUser", "handoverProviderAdmin", "intents", "data_privacy_admin", "data_privacy_editor", "data_privacy_viewer", "knowledgeAdmin", "large_language_model_admin,", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "simulator_admin" ] } } } } } }, "responses": { "204": { "description": "The role was removed from the project member." }, "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/users": { "post": { "operationId": "createUser_2_0", "summary": "Create a User", "description": "Creates a [user](https://docs.cognigy.com/ai/administer/access/management-ui#create-a-user) in the installation.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "password" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "password": { "type": "string", "description": "Enter password in case of non-sso user" } } } } } }, "responses": { "201": { "description": "Returns the created user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexUsers_2_0", "summary": "Get Users", "description": "Gets [users](https://docs.cognigy.com/voicegateway/webapp/users) in the organization. By default, 25 users are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 name or id of the user to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns metadata objects for each user in the system.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "lastActive": { "type": "number" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/users/{userId}": { "delete": { "operationId": "deleteUser_2_0", "summary": "Delete a User", "description": "Deletes a user from the system completely.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The user was removed successfully." }, "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": [] } ] }, "get": { "operationId": "readUser_2_0", "summary": "Get a User", "description": "Gets all the information from a user.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns User object", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateUser_2_0", "summary": "Update a User Profile", "description": "Updates information of a user profile.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "newPassword": { "type": "string" } } } } } }, "responses": { "204": { "description": "The user is updated successfully." }, "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/users/{userId}/addproject": { "post": { "operationId": "addProjectToUser_2_0", "summary": "Assign a Project to a User", "description": "Gives a user access to a Project.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "The project is now accessible for the user." }, "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/users/{userId}/addroletouser": { "post": { "operationId": "addRoleToUser_2_0", "summary": "Assign a Global Role", "description": "Assigns a global role to a user.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } } } } } }, "responses": { "204": { "description": "User-role was added to the user." }, "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/users/{userId}/logout": { "post": { "operationId": "logoutUser_2_0", "summary": "Log Out a User", "description": "Logs out a user and removes the access/refresh token pair.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The session was successfully destroyed." }, "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/users/{userId}/removeproject": { "post": { "operationId": "removeProjectFromUser_2_0", "summary": "Unassign a Project from a User", "description": "Removes the access to a Project from a user.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "The user no longer has access to the project." }, "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/users/{userId}/removerolefromuser": { "post": { "operationId": "removeRoleFromUser_2_0", "summary": "Unassign a Global Role", "description": "Unassigns a global role from a user.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } } } } } }, "responses": { "204": { "description": "User-role was removed from the user." }, "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/users/{userId}/resetfailedloginattempts": { "post": { "operationId": "resetFailedLoginAttempts_2_0", "summary": "Reset Failed Login Attempts", "description": "Resets the failed login attempts for a user. Requires the 'admin' role.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "userId", "description": "The Id of the User", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The failed logins attempts were reset." }, "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/users/changepassword": { "post": { "operationId": "changePassword_2_0", "summary": "Change a User Password", "description": "Changes the password of a user.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "organisationId", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "newPassword", "oldPassword" ], "properties": { "email": { "type": "string", "description": "The email of the user" }, "oldPassword": { "type": "string", "description": "The current (old) password of the user" }, "newPassword": { "type": "string", "description": "The new password the user wants to use" } } } } } }, "responses": { "204": { "description": "The password was successfully changed." }, "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/users/deprecatepassword": { "post": { "operationId": "deprecatePassword_2_0", "summary": "Deprecate User Passwords", "description": "Deprecates the password of a single user or all users of the organization.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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": { "userId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "responses": { "204": { "description": "The password(s) was/were deprecated." }, "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/users/me": { "delete": { "operationId": "deleteUserMe_2_0", "summary": "Delete Own User", "description": "Deletes the current [user](https://docs.cognigy.com/ai/administer/access/management-ui#other-operations) from the installation.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "204": { "description": "The own user was removed successfully." }, "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": [] } ] }, "get": { "operationId": "readUserMe_2_0", "summary": "Gets the Current User's Profile", "description": "Gets the current user's profile information.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Returns own User object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organisation": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } }, "projects": { "type": "array", "items": { "type": "string" } }, "acceptedTOS": { "type": "boolean" }, "disabled": { "type": "boolean" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateUserMe_2_0", "summary": "Update Own User", "description": "Updates the profile of the current [user](doc:users).", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "oldPassword": { "type": "string" }, "newPassword": { "type": "string" } } } } } }, "responses": { "204": { "description": "The user is updated successfully." }, "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/users/me/accepttermsofservice": { "post": { "operationId": "acceptTermsOfService_2_0", "summary": "Accept the Terms of Service", "description": "Accepts the terms of service.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "204": { "description": "Successfully accepted the Terms of Services" }, "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/users/me/acl": { "get": { "operationId": "readUserAclMe_2_0", "summary": "Get Current User's ACL", "description": "Gets the access control list (ACL) information for the current user's profile.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Returns the acl object for the user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "organisationWide": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "auditEvents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentAccount": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "knowledgeStores": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentInbox": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "goals": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "voiceGatewayAccount": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "admin", "apiKeys", "base_role", "basicSupportUser", "fullSupportUser", "liveAgentAdmin", "liveAgentAgent", "liveAgentSupervisor", "odata", "projectAssigner", "projectManager", "userManager", "userDetailsViewer", "voiceGatewayUser", "opsCenterUser" ] } } } }, "projectWide": { "type": "object", "additionalProperties": { "type": "object", "properties": { "rights": { "type": "object", "properties": { "agentAssistConfigs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analytics": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "connections": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "contactProfiles": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "conversationHistory": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "endpoints": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensions": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "extensionsTrust": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeComments": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodeDescription": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flowNodes": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "flows": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "handoverProviders": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "intents": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "largeLanguageModels": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "knowledgeStores": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "lexicons": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "liveAgentInbox": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "locales": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "logs": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "memberDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "members": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "goals": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "nluConnectors": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "playbooks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "project": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projectSettings": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "snapshots": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "states": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tasks": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "tokens": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "analyticsOdata": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "apiKeys": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "projects": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "userDetails": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "users": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } }, "simulator": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "additionalProperties": { "type": "object", "properties": { "create": { "type": "boolean" }, "read": { "type": "boolean" }, "update": { "type": "boolean" }, "delete": { "type": "boolean" } } } }, "roles": { "type": "array", "items": { "type": "string", "enum": [ "agentAssistConfigAdmin", "agentAssistConfigViewer", "analytics", "basic", "connection_admin", "contact_profile_admin", "contact_profile_editor", "contact_profile_viewer", "conversationHistory", "developer", "endpoint_admin", "extension_admin", "extension_editor", "flowEditor", "flowNodeComments", "flowNodeDescriptions", "followUser", "handoverProviderAdmin", "intents", "data_privacy_admin", "data_privacy_editor", "data_privacy_viewer", "knowledgeAdmin", "large_language_model_admin,", "lexicon_admin", "lexicon_editor", "localesAdmin", "logs", "memberManager", "nlu_connector_admin", "packages_admin", "playbook_admin", "playbook_editor", "projectAdmin", "snapshot_admin", "tokenAdmin", "tokenEditor", "function_admin", "function_editor", "simulator_admin" ] } }, "allowedLocales": { "type": "array", "items": { "type": "object", "properties": { "localeId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "primary": { "type": "boolean" } } } } } } } } } } } }, "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/users/me/apikeys": { "post": { "operationId": "createApiKeyMe_2_0", "summary": "Create an API Key", "description": "Creates an [API key](https://docs.cognigy.com/ai/administer/user-menu/my-profile#api-keys) for the current user.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the ApiKey", "example": "Office" } } } } } }, "responses": { "201": { "description": "Returns the created api-key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 }, "apiKey": { "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": [] } ] }, "get": { "operationId": "indexApiKeysMe_2_0", "summary": "Get API Keys of the Current User", "description": "Gets API keys of the current user. By default, 25 API keys are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 name of the api-key to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns api-keys of the current user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "apiKey": { "type": "string" }, "createdAt": { "type": "number" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/users/me/apikeys/{apiKeyId}": { "delete": { "operationId": "deleteApiKeyMe_2_0", "summary": "Delete an API Key", "description": "Deletes an [API key](https://docs.cognigy.com/ai/administer/user-menu/my-profile#api-keys) for the current user.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "apiKeyId", "description": "The Id of an Api Key", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "The Api key was removed" }, "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/users/me/lastloginattempt": { "get": { "operationId": "readLastLoginAttemptMe_2_0", "summary": "Get the Last Login Attempt", "description": "Gets the current user's last login attempt.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "The last login attempt object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "failed" ] }, "timestamp": { "type": "number" }, "location": { "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/users/me/loginattempts": { "get": { "operationId": "indexLoginAttemptsMe_2_0", "summary": "Get Login Attempts of the Current User", "description": "Gets login attempts for the current user. By default, 25 login attempts are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 status or location to filter the login attempts" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns login attempt objects for the curren tuser.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "failed" ] }, "timestamp": { "type": "number" }, "location": { "type": "string" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/users/me/pin": { "post": { "operationId": "pinResource_2_0", "summary": "Pin or Unpin Resources", "description": "Pins or unpins Cognigy.AI resources, such as Projects, to organize them based on your preferences.", "tags": [ "Users" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "The type of a pinnable resource", "example": "project", "enum": [ "project" ] }, "resourceId": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "pin": { "type": "boolean" } } } } } }, "responses": { "201": { "description": "Resource pinned/unpinned successfully." }, "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/users/me/pinned": { "get": { "operationId": "getPinnedResources_2_0", "summary": "Get Pinned Resources", "description": "Gets pinned Cognigy.AI resources by resource type.", "tags": [ "Users" ], "parameters": [ { "in": "query", "name": "resourceType", "required": true, "schema": { "type": "string", "description": "The type of a pinnable resource", "example": "project", "enum": [ "project" ] } } ], "responses": { "200": { "description": "Returns list of pinnedResources object", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of a pinnable resource", "example": "project", "enum": [ "project" ] }, "pinnedIds": { "type": "array", "items": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } } }, "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/users/requestpasswordreset": { "post": { "operationId": "requestPasswordReset_2_0", "summary": "Request a Password Reset", "description": "Requests a password reset email.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "organisationId", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "The E-Mail-Adress of the corresponding user account" } } } } } }, "responses": { "204": { "description": "Successfully sent password reset Mail" }, "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/users/resetpassword": { "post": { "operationId": "resetPassword_2_0", "summary": "Reset a User Password", "description": "Resets a user's password using a provided token.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "token", "newPassword" ], "properties": { "token": { "type": "string", "description": "The password reset token." }, "newPassword": { "type": "string", "description": "The new password." } } } } } }, "responses": { "200": { "description": "Successfully changed password.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } } } } } }, "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/users/validatepasswordresettoken": { "post": { "operationId": "validatePasswordResetToken_2_0", "summary": "Validate a Password Reset Token", "description": "Checks if the user password reset token is valid.", "tags": [ "Users" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "description": "The password reset token." } } } } } }, "responses": { "204": { "description": "Password reset token is valid." }, "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/users/me/apikeys": { "post": { "operationId": "createApiKeyMe_2_1", "summary": "Create an API Key", "description": "Creates an [API key](https://docs.cognigy.com/ai/tools/user-menu/my-profile/#api-keys) for the current user.", "tags": [ "Users 2.1" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the ApiKey", "example": "Office" } } } } } }, "responses": { "201": { "description": "Returns the created api-key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "minimum": 0, "maximum": 2147483647, "example": 1527621049 }, "apiKey": { "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": [] } ] }, "get": { "operationId": "indexApiKeysMe_2_1", "summary": "Get API Keys of the Current User", "description": "Gets API keys of the current user. By default, 25 API keys are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Users 2.1" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "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 name of the api-key to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns api-keys of the current user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "createdAt": { "type": "number" } } } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/organisations/voicegateway/account": { "get": { "operationId": "readVoiceGatewayAccount_2_0", "summary": "Get Voice Gateway Account", "description": "Gets information from the Voice Gateway account.", "tags": [ "Voice Gateway" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Returns the Voice Gateway Account for the organisation." }, "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": [] } ] }, "post": { "operationId": "setupCognigyVoiceGateway_2_0", "summary": "Set Up a Voice Gateway Account", "description": "Sets up a Voice Gateway account for the organization.", "tags": [ "Voice Gateway" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountSid": { "type": "string", "description": "The Service Provider Identifier (SID) of the Voice Gateway account." } } } } } }, "responses": { "200": { "description": "Cognigy Voice Gateway account was successfully setup for the organisation." }, "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/audio/preview/languages": { "get": { "operationId": "indexAudioPreviewLanguages_2_0", "summary": "Get Voices", "description": "Gets available preview voices for the speech provider selected in the Project settings.", "tags": [ "Voice Preview" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "projectId", "schema": { "type": "string" }, "description": "Project id from which it will get the settings" } ], "responses": { "200": { "description": "Returns the available audio preview voices", "content": { "application/json": { "schema": { "type": "object", "properties": { "audioPreviewLanguages": { "type": "array", "items": { "type": "object", "properties": { "voiceId": { "type": "string", "maxLength": 50, "description": "Audio preview provided voice Id. This is the ID that you specify when calling the SynthesizeSpeech operation." }, "languageCode": { "type": "string", "maxLength": 10, "description": "Language code of the voice." } } } } } } } } }, "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/audio/voiceprovider/test": { "post": { "operationId": "testVoiceProvider_2_0", "summary": "Validate Speech Provider", "description": "Validates the credentials of a speech provider connection.", "tags": [ "Voice Preview" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "projectId" ], "properties": { "projectId": { "type": "string" } } } } } }, "responses": { "200": { "description": "Credentials have been validated and the connection was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "voiceProvider": { "type": "string" }, "isCredentialsValid": { "type": "boolean" }, "msg": { "type": "string" }, "msgErr": { "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": [] } ] } }, "/.well-known/webfinger": { "get": { "operationId": "webfinger", "summary": "Get User or Organization Info via Webfinger for SSO", "description": "Gets data from an Identity Provider (IdP) configuration for SSO authentication based on a user email or organization ID via the [WebFinger protocol](https://en.wikipedia.org/wiki/WebFinger).", "tags": [ "Webfinger" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "query", "name": "resource", "required": true, "schema": { "type": "string", "format": "uri" } }, { "in": "query", "name": "rel", "schema": { "type": "array", "items": { "type": "array", "items": { "type": "string", "enum": [ "idp" ] } } } } ], "responses": { "200": { "description": "Returns the Webfinger result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string", "example": "org:5ce7c2d833ea1e04d7e6c432" }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "enum": [ "idp" ] }, "properties": { "type": "object", "oneOf": [ { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "none" ] } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:callback": { "type": "string", "format": "url" }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" }, "idp:logout:fc": { "type": "string", "format": "url" } } }, { "type": "object", "properties": { "idp:type": { "type": "string", "enum": [ "oidc" ] }, "idp:login": { "type": "string", "format": "url" }, "idp:logout": { "type": "string", "format": "url" } } } ] } } } } } } } } }, "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/locales/{localeId}/yesnointents": { "get": { "operationId": "readYesNoIntents_2_0", "summary": "Get Yes/No Intents", "description": "Gets the [Yes/No Intents](docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents) of a Locale.", "tags": [ "Yes/No Intents" ], "parameters": [ { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns an object containing the yesIntent, noIntent, rejectIntent for the given locale", "content": { "application/json": { "schema": { "type": "object", "properties": { "yesIntent": { "type": "object", "properties": { "isDisabled": { "type": "boolean" }, "name": { "type": "string", "example": "pizza" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rules": { "type": "array", "items": { "type": "string" } } } }, "noIntent": { "type": "object", "properties": { "isDisabled": { "type": "boolean" }, "name": { "type": "string", "example": "pizza" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rules": { "type": "array", "items": { "type": "string" } } } }, "rejectIntent": { "type": "object", "properties": { "isDisabled": { "type": "boolean" }, "name": { "type": "string", "example": "pizza" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rules": { "type": "array", "items": { "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/locales/{localeId}/yesnointents/{intentId}": { "delete": { "operationId": "deleteYesNoIntent_2_0", "summary": "Delete a Yes/No Intent", "description": "Deletes a Yes/No Intent. Once deleted, you can't recreate the Yes/No Intent. You need a new Locale to have Yes/No Intents.", "tags": [ "Yes/No Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted endpoint" }, "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": [] } ] }, "patch": { "operationId": "updateYesNoIntent_2_0", "summary": "Update a Yes/No Intent", "description": "Updates a Yes/No Intent of a Locale.", "tags": [ "Yes/No Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rules": { "type": "array", "items": { "type": "string" }, "description": "The intent rules", "example": [ "this should be a valid rule" ] }, "isDisabled": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Returns an object containing the yesIntent, noIntent, rejectIntent for the given locale", "content": { "application/json": { "schema": { "type": "object", "properties": { "yesIntent": { "type": "object", "properties": { "isDisabled": { "type": "boolean" }, "name": { "type": "string", "example": "pizza" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rules": { "type": "array", "items": { "type": "string" } } } }, "noIntent": { "type": "object", "properties": { "isDisabled": { "type": "boolean" }, "name": { "type": "string", "example": "pizza" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rules": { "type": "array", "items": { "type": "string" } } } }, "rejectIntent": { "type": "object", "properties": { "isDisabled": { "type": "boolean" }, "name": { "type": "string", "example": "pizza" }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "rules": { "type": "array", "items": { "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/locales/{localeId}/yesnointents/{intentId}/sentences": { "post": { "operationId": "createYesNoSentence_2_0", "summary": "Create a Sentence", "description": "Creates a Sentence for a [Yes/No Intent](docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents).", "tags": [ "Yes/No Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." } } } } } }, "responses": { "201": { "description": "Returns Sentence metadata object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "text": { "type": "string", "example": "I want to buy a pizza." }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "get": { "operationId": "indexYesNoSentences_2_0", "summary": "Get Sentences", "description": "Gets sentences from a [Yes/No Intent](docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents). By default, 25 sentences are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.", "tags": [ "Yes/No Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" }, "description": "The text of the sentence to filter the records" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "description": "The maximum number of items to return. The default is 25." }, { "in": "query", "name": "skip", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "The number of items to skip. The default is 0. Used along with a limit of a pagination." }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "The order of the sorting items-`desc` (descending) or `asc` (ascending). For example, to sort the records by name in ascending order, specify `name:asc`." }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the nextCursor value from the response to get the next set of records. Used along with limit for pagination." }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string", "minLength": 24, "maxLength": 24 }, "description": "This should be the previousCursor value from the response to get the previous set of records. Used along with limit for pagination." } ], "responses": { "200": { "description": "Returns array of a Sentence metadata objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." }, "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slots": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "tagReference": { "type": "string" }, "lexiconReference": { "type": "string" } } } }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } }, "total": { "type": "integer", "example": 1 }, "nextCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "previousCursor": { "nullable": true, "example": "5ce7c2d833ea1e04d7e6c432", "type": "string", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } } } } }, "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/locales/{localeId}/yesnointents/{intentId}/sentences/{sentenceId}": { "delete": { "operationId": "deleteYesNoSentence_2_0", "summary": "Delete a Sentence", "description": "Deletes a Sentence from a [Yes/No Intent](docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents).", "tags": [ "Yes/No Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sentenceId", "description": "The Id of the Sentence", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "204": { "description": "Successfully deleted sentence" }, "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": [] } ] }, "get": { "operationId": "readYesNoSentence_2_0", "summary": "Get a Sentence", "description": "Gets a Sentence from a Yes/No Intent.", "tags": [ "Yes/No Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sentenceId", "description": "The Id of the Sentence", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "200": { "description": "Returns Sentence Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "localeReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "feedbackReport": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "poorScore", "fairScore", "goodScore", "overlap", "wrongIntent" ] } } } }, "info": { "type": "object", "properties": { "trueIntent": { "type": "string" }, "topIntent": { "type": "string" }, "runnerUp": { "type": "string" }, "topScore": { "type": "number" }, "runnerUpScore": { "type": "number" }, "difference": { "type": "number" }, "trueIntentName": { "type": "string" }, "topIntentName": { "type": "string" }, "runnerUpIntentName": { "type": "string" } } } } }, "text": { "type": "string", "example": "I want to buy a pizza." }, "slots": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "anySlot" ] }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "systemSlot" ] }, "dimension": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lexiconSlot" ] }, "lexiconReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "slotReference": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "name": { "type": "string" }, "start": { "type": "number" }, "end": { "type": "number" } } } ] } }, "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "createdAt": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "lastChanged": { "type": "integer", "description": "Unix-timestamp", "example": 1694518620, "minimum": 0, "maximum": 2147483647 }, "createdBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "lastChangedBy": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, "description": "The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.\n" } } } }, "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": [] } ] }, "patch": { "operationId": "updateYesNoSentence_2_0", "summary": "Update a Sentence", "description": "Updates a Sentence in a [Yes/No Intent](docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents).", "tags": [ "Yes/No Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "intentId", "description": "The Id of the Intent", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } }, { "in": "path", "name": "sentenceId", "description": "The Id of the Sentence", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "I want to buy a pizza." } } } } } }, "responses": { "204": { "description": "Successfully updated Sentence" }, "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/locales/{localeId}/yesnointents/train": { "post": { "operationId": "trainYesNoIntents_2_0", "summary": "Train Yes/No Intents", "description": "Creates a task to train the [Yes/No Intents](https://docs.cognigy.com/ai/nlu/nlu-overview/yes-no-intents/) of a Locale.", "tags": [ "Yes/No Intents" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "localeId", "description": "The Id of the Locale", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Successfully created Tasks to train YesNoIntents for all the locales", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } } }, "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}/yesnointents/train": { "post": { "operationId": "trainYesNoIntentsProject_2_0", "summary": "Train Yes/No Intents for All Locales", "description": "Creates tasks to train the [Yes/No Intents](https://docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents#yes-no-intents) for all Locales in a Project.", "tags": [ "Yes/No Intents", "Projects" ], "parameters": [ { "in": "header", "name": "Accept", "description": "The default media type is application/hal+json. Use application/json for pure data results.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "application/hal+json", "application/xml", "text/xml", "text/csv" ] }, "example": "application/json" }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 } } ], "responses": { "202": { "description": "Successfully created Tasks to train YesNoIntents for all the locales", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "example": "5ce7c2d833ea1e04d7e6c432", "pattern": "^[a-z0-9]{24}$", "minLength": 24, "maxLength": 24 }, "status": { "type": "string", "description": "The status of the task", "example": "queued", "enum": [ "queued", "active", "done", "cancelling", "cancelled", "error" ] }, "type": { "type": "string", "example": "trainIntents" }, "parameters": { "type": "object" }, "lastChangedAt": { "type": "number", "example": 1594243850 }, "lastCreatedAt": { "type": "number", "example": 1594243850 }, "currentStep": { "type": "integer", "example": 0 }, "totalStep": { "type": "integer", "example": 100 } } } } } } }, "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": [] } ] } } } }