{"openapi":"3.0.0","paths":{"/v1/workspaces/{workspaceId}/chatbots/{chatbotId}":{"patch":{"operationId":"ChatbotController_updateChatbot[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot to be updated.","schema":{"type":"string"}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChatbotRequestDto"}}}},"responses":{"200":{"description":"Chatbot updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatbotResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing chatbot","tags":["Chatbot management"],"description":"\n\n**Required Permission:** `chatbots.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"get":{"operationId":"ChatbotController_getChatbot[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot to be retrieved.","schema":{"type":"string"}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{"type":"string"}}],"responses":{"200":{"description":"Details of the chatbot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChatbotResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific chatbot","tags":["Chatbot management"],"description":"\n\n**Required Permission:** `chatbots.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/api/{index}":{"post":{"operationId":"ChatbotApikeyController_generateApiKey[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"index","required":true,"in":"path","description":"The index of the key (e.g., 1 or 2)","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{"type":"string"}}],"responses":{"201":{"description":"The newly generated API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Generates a new API key","tags":["Chatbot api-keys"],"description":"\n\n**Required Permission:** `chatbots.apikey.create`\n\n**Resource:** `chatbots/:chatbotId`"},"get":{"operationId":"ChatbotApikeyController_getApiKey[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"index","required":true,"in":"path","description":"The index of the key (e.g., 1 or 2)","schema":{"type":"number"}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{"type":"string"}}],"responses":{"200":{"description":"The API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves an existing API key","tags":["Chatbot api-keys"],"description":"\n\n**Required Permission:** `chatbots.apikey.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/templates/{templateId}":{"get":{"operationId":"ChatbotTemplateController_getTemplate[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"templateId","required":true,"in":"path","description":"The ID of the template to be retrieved.","schema":{"type":"string"}},{"name":"channelId","required":true,"in":"query","description":"The ID of the channel to which the template belongs.","schema":{}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{"type":"string"}}],"responses":{"200":{"description":"Template details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific WhatsApp template","tags":["Chatbot templates"],"description":"\n\n**Required Permission:** `chatbots.templates.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/templates":{"post":{"operationId":"ChatbotTemplateController_createTemplate[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWhatsAppTemplateRequestDto"}}}},"responses":{"201":{"description":"Template successfully submitted for review.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppTemplateResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new WhatsApp template","tags":["Chatbot templates"],"description":"\n\n**Required Permission:** `chatbots.templates.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users":{"post":{"operationId":"ChatbotUserController_addUser[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddChatbotUserRequestDto"}}}},"responses":{"201":{"description":"User successfully added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddChatbotUserResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Adds a user to a chatbot","tags":["Chatbot users"],"description":"\n\n**Required Permission:** `chatbots.users.add`\n\n**Resource:** `chatbots/:chatbotId`"},"get":{"operationId":"ChatbotUserController_listChatbotUsers[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{}}],"responses":{"200":{"description":"List of users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChatbotUsersResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all users of a chatbot","tags":["Chatbot users"],"description":"\n\n**Required Permission:** `chatbots.users.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users/{userId}":{"delete":{"operationId":"ChatbotUserController_removeUser[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"userId","required":true,"in":"path","description":"The ID of the user to be removed.","schema":{"type":"string"}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{}}],"responses":{"200":{"description":"User successfully removed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveChatbotUserResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Removes a user from a chatbot","tags":["Chatbot users"],"description":"\n\n**Required Permission:** `chatbots.users.remove`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users/{userId}/roles":{"post":{"operationId":"ChatbotUserController_grantRole[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"userId","required":true,"in":"path","description":"The Id of the user.","schema":{"type":"string"}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantChatbotRoleRequestDto"}}}},"responses":{"201":{"description":"Role successfully assigned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantChatbotRoleResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Assigns a role to a user for the chatbot","tags":["Chatbot users"],"description":"\n\n**Required Permission:** `chatbots.users.roles.grant`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users/{userId}/roles/{role}":{"delete":{"operationId":"ChatbotUserController_revokeRole[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"userId","required":true,"in":"path","description":"The Id of the user.","schema":{"type":"string"}},{"name":"role","required":true,"in":"path","description":"The role to be revoked.","schema":{"type":"string"}},{"name":"workspaceId","required":true,"in":"path","description":"The ID of the workspace.","schema":{}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeChatbotRoleRequestDto"}}}},"responses":{"200":{"description":"Role successfully revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeChatbotRoleResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Revokes a role from a user for the chatbot","tags":["Chatbot users"],"description":"\n\n**Required Permission:** `chatbots.users.roles.revoke`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/faqs":{"post":{"operationId":"ChatbotFaqController_createFaq[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFaqRequestDto"}}}},"responses":{"201":{"description":"Faq created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaqResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new FAQ","tags":["Chatbot faqs"],"description":"\n\n**Required Permission:** `chatbots.faqs.create`\n\n**Resource:** `chatbots/:chatbotId`"},"get":{"operationId":"ChatbotFaqController_listFaqs[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all FAQs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFaqsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all FAQs for a chatbot","tags":["Chatbot faqs"],"description":"\n\n**Required Permission:** `chatbots.faqs.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/faqs/{faqId}":{"get":{"operationId":"ChatbotFaqController_getFaq[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"faqId","required":true,"in":"path","description":"The ID of the FAQ to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Details of the FAQ.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaqResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific FAQ","tags":["Chatbot faqs"],"description":"\n\n**Required Permission:** `chatbots.faqs.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"ChatbotFaqController_updateFaq[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"faqId","required":true,"in":"path","description":"The ID of the FAQ to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFaqRequestDto"}}}},"responses":{"200":{"description":"Faq updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaqResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing FAQ","tags":["Chatbot faqs"],"description":"\n\n**Required Permission:** `chatbots.faqs.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ChatbotFaqController_deleteFaq[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"faqId","required":true,"in":"path","description":"The ID of the FAQ to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the deletion operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFaqResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes an FAQ","tags":["Chatbot faqs"],"description":"\n\n**Required Permission:** `chatbots.faqs.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/examples":{"get":{"operationId":"ChatbotExampleController_listExamples[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"The limit for how many examples should be fetched.","schema":{"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"The date after which to filter examples. Only examples after this date will be fetched.","schema":{"type":"string"}},{"name":"intentId","required":false,"in":"query","description":"The Id of the intent the examples belong to.","schema":{"type":"string"}},{"name":"entityId","required":false,"in":"query","description":"The Id of the intent the examples belong to.","schema":{"type":"string"}},{"name":"language","required":false,"in":"query","description":"The language of the examples.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of training examples.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExamplesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists and filters training examples","tags":["Chatbot examples"],"description":"\n\n**Required Permission:** `chatbots.examples.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ChatbotExampleController_createExample[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExampleRequestDto"}}}},"responses":{"201":{"description":"Example created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new training example","tags":["Chatbot examples"],"description":"\n\n**Required Permission:** `chatbots.examples.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/examples/{exampleId}":{"patch":{"operationId":"ChatbotExampleController_updateExample[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"exampleId","required":true,"in":"path","description":"The ID of the example to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExampleRequestDto"}}}},"responses":{"200":{"description":"Example updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleResponseDto"}}}},"403":{"description":"Insufficient permissions."},"404":{"description":"Example not found."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing training example.","tags":["Chatbot examples"],"description":"\n\n**Required Permission:** `chatbots.examples.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ChatbotExampleController_deleteExample[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"exampleId","required":true,"in":"path","description":"The ID of the example to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the deletion process.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExampleResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a training example","tags":["Chatbot examples"],"description":"\n\n**Required Permission:** `chatbots.examples.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/intents":{"get":{"operationId":"ChatbotIntentController_listIntents[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all intents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListIntentsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all intents for a chatbot","tags":["Chatbot intents"],"description":"\n\n**Required Permission:** `chatbots.intents.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ChatbotIntentController_createIntent[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntentRequestDto"}}}},"responses":{"201":{"description":"Intent created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new intent","tags":["Chatbot intents"],"description":"\n\n**Required Permission:** `chatbots.intents.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/intents/{intentId}":{"get":{"operationId":"ChatbotIntentController_getIntent[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"intentId","required":true,"in":"path","description":"The ID of the intent to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Details of the intent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific intent","tags":["Chatbot intents"],"description":"\n\n**Required Permission:** `chatbots.intents.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"ChatbotIntentController_updateIntent[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"intentId","required":true,"in":"path","description":"The ID of the intent to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntentRequestDto"}}}},"responses":{"200":{"description":"Intent updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntentResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing intent","tags":["Chatbot intents"],"description":"\n\n**Required Permission:** `chatbots.intents.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ChatbotIntentController_deleteIntent[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"intentId","required":true,"in":"path","description":"The ID of the intent to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the deletion process.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteIntentResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes an intent","tags":["Chatbot intents"],"description":"\n\n**Required Permission:** `chatbots.intents.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/triggers":{"get":{"operationId":"ChatbotTriggerController_listTriggers[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"A list of all triggers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTriggersResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all triggers for a chatbot.","tags":["Chatbot triggers"],"description":"\n\n**Required Permission:** `chatbots.triggers.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/flows/{flowId}/steps":{"get":{"operationId":"ChatbotStepController_listSteps[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"flowId","required":true,"in":"path","description":"The ID of the flows.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all Steps.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStepsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all steps for a flow","tags":["Chatbot steps"],"description":"\n\n**Required Permission:** `chatbots.steps.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ChatbotStepController_createStep[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"flowId","required":true,"in":"path","description":"The ID of the flows.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStepRequestDto"}}}},"responses":{"201":{"description":"Step created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new step within a flow","tags":["Chatbot steps"],"description":"\n\n**Required Permission:** `chatbots.steps.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/flows/{flowId}/steps/{stepId}":{"get":{"operationId":"ChatbotStepController_getStep[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"flowId","required":true,"in":"path","description":"The ID of the flows.","schema":{"type":"string"}},{"name":"stepId","required":true,"in":"path","description":"The ID of the step to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Details of the step.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStepResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific step","tags":["Chatbot steps"],"description":"\n\n**Required Permission:** `chatbots.steps.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"ChatbotStepController_updateStep[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"flowId","required":true,"in":"path","description":"The ID of the flows.","schema":{"type":"string"}},{"name":"stepId","required":true,"in":"path","description":"The ID of the step to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStepRequestDto"}}}},"responses":{"200":{"description":"Step updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing step","tags":["Chatbot steps"],"description":"\n\n**Required Permission:** `chatbots.steps.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ChatbotStepController_deleteStep[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"flowId","required":true,"in":"path","description":"The ID of the flows.","schema":{"type":"string"}},{"name":"stepId","required":true,"in":"path","description":"The ID of the step to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the deletion process.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteStepResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a step","tags":["Chatbot steps"],"description":"\n\n**Required Permission:** `chatbots.steps.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/entities":{"get":{"operationId":"ChatbotEntityController_listEntities[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all entities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEntitiesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all entities for a chatbot","tags":["Chatbot entities"],"description":"\n\n**Required Permission:** `chatbots.entities.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ChatbotEntityController_createEntity[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntityRequestDto"}}}},"responses":{"201":{"description":"Entity created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new entity","tags":["Chatbot entities"],"description":"\n\n**Required Permission:** `chatbots.entities.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/entities/{entityId}":{"get":{"operationId":"ChatbotEntityController_getEntity[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"entityId","required":true,"in":"path","description":"The ID of the entity to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Details of the entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific entity","tags":["Chatbot entities"],"description":"\n\n**Required Permission:** `chatbots.entities.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"ChatbotEntityController_updateEntity[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"entityId","required":true,"in":"path","description":"The ID of the entity to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEntityRequestDto"}}}},"responses":{"200":{"description":"Entity updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing entity","tags":["Chatbot entities"],"description":"\n\n**Required Permission:** `chatbots.entities.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ChatbotEntityController_deleteEntity[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"entityId","required":true,"in":"path","description":"The ID of the entity to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the deletion process.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEntityResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes an entity","tags":["Chatbot entities"],"description":"\n\n**Required Permission:** `chatbots.entities.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/entities/{entityId}/state":{"patch":{"operationId":"ChatbotEntityController_setEntityState[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"entityId","required":true,"in":"path","description":"The ID of the entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetEntityStateRequestDto"}}}},"responses":{"200":{"description":"Status changed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Changes the activation status of an entity","tags":["Chatbot entities"],"description":"\n\n**Required Permission:** `chatbots.entities.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/flows":{"get":{"operationId":"ChatbotFlowController_listFlows[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all flows.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all flows for a chatbot","tags":["Chatbot flows"],"description":"\n\n**Required Permission:** `chatbots.flows.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ChatbotFlowController_createFlow[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFlowRequestDto"}}}},"responses":{"201":{"description":"Flow created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new flow","tags":["Chatbot flows"],"description":"\n\n**Required Permission:** `chatbots.flows.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/flows/{flowId}":{"get":{"operationId":"ChatbotFlowController_getFlow[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"flowId","required":true,"in":"path","description":"The ID of the flow to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Details of the flow.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFlowResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific flow","tags":["Chatbot flows"],"description":"\n\n**Required Permission:** `chatbots.flows.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"ChatbotFlowController_updateFlow[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"flowId","required":true,"in":"path","description":"The ID of the flow to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFlowRequestDto"}}}},"responses":{"200":{"description":"Flow updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing flow","tags":["Chatbot flows"],"description":"\n\n**Required Permission:** `chatbots.flows.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ChatbotFlowController_deleteFlow[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"flowId","required":true,"in":"path","description":"The ID of the flow to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the deletion process.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFlowResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a flow","tags":["Chatbot flows"],"description":"\n\n**Required Permission:** `chatbots.flows.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/settings/languages":{"get":{"operationId":"ChatbotLanguageController_getLanguages[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot","schema":{"type":"string"}}],"responses":{"200":{"description":"The current language settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanguagesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves all language settings for a chatbot","tags":["Chatbot language-settings"],"description":"\n\n**Required Permission:** `chatbots.languages.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ChatbotLanguageController_addLanguages[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddLanguagesRequestDto"}}}},"responses":{"200":{"description":"The updated language settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanguagesResponseDto"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Adds one or more languages to the chatbot","tags":["Chatbot language-settings"],"description":"\n\n**Required Permission:** `chatbots.languages.create`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ChatbotLanguageController_removeLanguage[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveLanguagesRequestDto"}}}},"responses":{"200":{"description":"The updated language settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanguagesResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Removes one or more languages from the chatbot","tags":["Chatbot language-settings"],"description":"\n\n**Required Permission:** `chatbots.languages.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/settings/languages/translate":{"patch":{"operationId":"ChatbotLanguageController_updateTranslationMode[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTranslationModeDto"}}}},"responses":{"200":{"description":"The updated status of the translation mode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTranslationModeResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Enables/disables automatic translation mode","tags":["Chatbot language-settings"],"description":"\n\n**Required Permission:** `chatbots.languages.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/models":{"get":{"operationId":"ChatbotModelController_listModels[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all models.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListModelsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all trained models for a chatbot","tags":["Chatbot models"],"description":"\n\n**Required Permission:** `chatbots.models.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/models/{modelId}":{"get":{"operationId":"ChatbotModelController_getModel[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"modelId","required":true,"in":"path","description":"The ID of the model to be retrieved.","schema":{"type":"string"}}],"responses":{"200":{"description":"Details of the model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModelResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific trained model","tags":["Chatbot models"],"description":"\n\n**Required Permission:** `chatbots.models.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/models/{modelId}/evaluation":{"get":{"operationId":"ChatbotModelController_getModelEvaluation[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"modelId","required":true,"in":"path","description":"The ID of the model to be evaluated.","schema":{"type":"string"}}],"responses":{"200":{"description":"Detailed evaluation metrics of the model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModelEvaluationResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves evaluation results for a specific model","tags":["Chatbot models"],"description":"\n\n**Required Permission:** `chatbots.models.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/training/required":{"get":{"operationId":"ChatbotTrainingController_trainingRequired[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"Indicates whether training is required due to changes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrainingRequiredResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Checks if retraining of the model is required","tags":["Chatbot training"],"description":"\n\n**Required Permission:** `chatbots.training-status.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/settings/ai":{"get":{"operationId":"ChatbotAiFeaturesController_getAiFeatures[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"The current AI feature settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiFeaturesSettingsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves AI feature settings for a chatbot","tags":["Chatbot ai-feature-settings"],"description":"\n\n**Required Permission:** `chatbots.settings.aifeatures.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"ChatbotAiFeaturesController_updateAiFeatures[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAiFeaturesRequestDto"}}}},"responses":{"200":{"description":"The current AI feature settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiFeaturesSettingsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates AI feature settings for a chatbot","tags":["Chatbot ai-feature-settings"],"description":"\n\n**Required Permission:** `chatbots.settings.aifeatures.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/versions":{"get":{"operationId":"ChatbotVersionController_listVersions[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all versions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVersionsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all versions of a chatbot","tags":["Chatbot versions"],"description":"\n\n**Required Permission:** `chatbots.versions.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ChatbotVersionController_createVersion[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVersionRequestDto"}}}},"responses":{"201":{"description":"Version created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new version","tags":["Chatbot versions"],"description":"\n\n**Required Permission:** `chatbots.versions.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/versions/{versionId}":{"delete":{"operationId":"ChatbotVersionController_deleteVersion[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"versionId","required":true,"in":"path","description":"The Id of the version to be deleted.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteVersionResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a version","tags":["Chatbot versions"],"description":"\n\n**Required Permission:** `chatbots.versions.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/versions/{versionId}/deploy":{"post":{"operationId":"ChatbotVersionController_deployVersion[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"versionId","required":true,"in":"path","description":"The Id of the version to be deployed.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeployVersionRequestDto"}}}},"responses":{"202":{"description":"Deployment process started.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeployVersionResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deploys a version to an environment","tags":["Chatbot versions"],"description":"\n\n**Required Permission:** `chatbots.versions.deploy`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/versions/{versionId}/rollback":{"post":{"operationId":"ChatbotVersionController_rollbackVersion[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"versionId","required":true,"in":"path","description":"The Id of the version to roll back on.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollbackVersionRequestDto"}}}},"responses":{"200":{"description":"Result of the rollback operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollbackVersionResponseDto"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Performs a rollback to a specific version","tags":["Chatbot versions"],"description":"\n\n**Required Permission:** `chatbots.versions.deploy`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/deployments/status":{"get":{"operationId":"ChatbotDeploymentController_getActiveDeploymentStatus[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"The status of deployments for the test, prod, and dev environments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveDeploymentsStatusResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves the status of active deployments for all environments.","tags":["Chatbot deployments"],"description":"\n\n**Required Permission:** `chatbots.deployments.status`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/variables":{"get":{"operationId":"ChatbotVariableController_listGlobalVariables[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"filters","required":false,"in":"query","description":"Filters variables by categories. Separate multiple filters with commas.\n\n- `0`: CUSTOM\n- `1`: APP\n- `2`: Entity\n","schema":{"example":"0,1","type":"string"}}],"responses":{"200":{"description":"List of all global variables.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGlobalVariablesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all global variables for a chatbot","tags":["Chatbot variables"],"description":"\n\n**Required Permission:** `chatbots.variables.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ChatbotVariableController_createGlobalVariable[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGlobalVariableRequestDto"}}}},"responses":{"201":{"description":"Global variable created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalVariableResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new global variable","tags":["Chatbot variables"],"description":"\n\n**Required Permission:** `chatbots.variables.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/variables/{variableId}":{"patch":{"operationId":"ChatbotVariableController_updateGlobalVariable[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"variableId","required":true,"in":"path","description":"The ID of the variable to be updated.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGlobalVariableRequestDto"}}}},"responses":{"200":{"description":"Global variable updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalVariableResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing global variable","tags":["Chatbot variables"],"description":"\n\n**Required Permission:** `chatbots.variables.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ChatbotVariableController_deleteGlobalVariable[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"variableId","required":true,"in":"path","description":"The ID of the variable to be deleted.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the deletion process.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGlobalVariableResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a global variable","tags":["Chatbot variables"],"description":"\n\n**Required Permission:** `chatbots.variables.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/expressions":{"get":{"operationId":"ChatbotExpressionController_listExpressions[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"The limit for how many examples should be fetched.","schema":{"type":"number"}},{"name":"pageToken","required":false,"in":"query","description":"The date after which to filter examples. Only examples after this date will be fetched.","schema":{"type":"string"}},{"name":"intentId","required":false,"in":"query","description":"Filters by a specific intent ID.","schema":{"type":"string"}},{"name":"maxScore","required":false,"in":"query","description":"Filters for expressions with a confidence score less than or equal to this value.","schema":{"type":"number"}},{"name":"language","required":false,"in":"query","description":"The language of the examples.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of expressions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExpressionsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists and filters user inputs (expressions)","tags":["Chatbot expressions"],"description":"\n\n**Required Permission:** `chatbots.expressions.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/expressions/stats":{"get":{"operationId":"ChatbotExpressionController_getExpressionStats[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"Statistical evaluation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetExpressionStatsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves statistics for recorded expressions","tags":["Chatbot expressions"],"description":"\n\n**Required Permission:** `chatbots.expressions.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/expressions/{expressionId}":{"delete":{"operationId":"ChatbotExpressionController_deleteExpression[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"expressionId","required":true,"in":"path","description":"The ID of the expression to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the deletion process.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExpressionResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes an expression","tags":["Chatbot expressions"],"description":"\n\n**Required Permission:** `chatbots.expressions.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/public-apps":{"get":{"operationId":"CcAppPublicController_listApprovedPublicApps[1]_v1","parameters":[],"responses":{"200":{"description":"List of all public apps.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApprovedPublicAppsResponseDto"}}}}},"summary":"Lists all publicly approved apps","tags":["App public"]}},"/v1/public-apps/{appId}/versions":{"get":{"operationId":"CcAppPublicController_listApprovedVersions[1]_v1","parameters":[{"name":"appId","required":true,"in":"path","description":"The ID of the public app.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of approved versions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApprovedVersionsResponseDto"}}}}},"summary":"Lists all approved versions for a specific public app","tags":["App public"]}},"/v1/buckets/{bucketId}/objects":{"get":{"operationId":"StorageObjectController_listObjects[1]_v1","parameters":[{"name":"bucketId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all objects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListObjectsResponseDto"}}}},"403":{"description":"No authorization."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all objects (files) in a bucket","tags":["Storage objects"],"description":"\n\n**Required Permission:** `buckets.objects.list`\n\n**Resource:** `buckets/:bucketId`"},"post":{"operationId":"StorageObjectController_createObject[1]_v1","parameters":[{"name":"bucketId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"File upload with optional metadata.","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateObjectDto"}}}},"responses":{"201":{"description":"Object successfully uploaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageObjectResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Uploads a new object (file) to a bucket","tags":["Storage objects"],"description":"\n\n**Required Permission:** `buckets.objects.create`\n\n**Resource:** `buckets/:bucketId`"}},"/v1/buckets/{bucketId}/objects/{objectId}":{"get":{"operationId":"StorageObjectController_getObject[1]_v1","parameters":[{"name":"bucketId","required":true,"in":"path","schema":{"type":"string"}},{"name":"objectId","required":true,"in":"path","description":"The ID (name/path) of the object to retrieve","schema":{"type":"string"}}],"responses":{"200":{"description":"Object details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageObjectResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific object","tags":["Storage objects"],"description":"\n\n**Required Permission:** `buckets.objects.get`\n\n**Resource:** `buckets/:bucketId`"},"delete":{"operationId":"StorageObjectController_deleteObject[1]_v1","parameters":[{"name":"bucketId","required":true,"in":"path","schema":{"type":"string"}},{"name":"objectId","required":true,"in":"path","description":"The ID (name/path) of the object to delete","schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the deletion operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteObjectResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes an object from a bucket","tags":["Storage objects"],"description":"\n\n**Required Permission:** `buckets.objects.delete`\n\n**Resource:** `buckets/:bucketId`"}},"/v1/inbox/{chatbotId}/tags":{"post":{"operationId":"InboxTagController_createTag[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTagRequestDto"}}}},"responses":{"201":{"description":"Tag created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new tag","tags":["Inbox tags"],"description":"\n\n**Required Permission:** `chatbots.tags.create`\n\n**Resource:** `chatbots/:chatbotId`"},"get":{"operationId":"InboxTagController_listTags[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all tags.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all tags for a chatbot","tags":["Inbox tags"],"description":"\n\n**Required Permission:** `chatbots.tags.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/tags/{tagId}":{"get":{"operationId":"InboxTagController_getTag[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"tagId","required":true,"in":"path","description":"The ID of the tag to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Details of the tag.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResponseDto"}}}},"403":{"description":"Insufficient permissions."},"404":{"description":"Tag not found."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific tag","tags":["Inbox tags"],"description":"\n\n**Required Permission:** `chatbots.tags.get`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"InboxTagController_deleteTag[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"tagId","required":true,"in":"path","description":"The ID of the tag to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Tag deleted successfully."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a tag","tags":["Inbox tags"],"description":"\n\n**Required Permission:** `chatbots.tags.delete`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"InboxTagController_updateTag[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"tagId","required":true,"in":"path","description":"The ID of the tag to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTagRequestDto"}}}},"responses":{"200":{"description":"Tag updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing tag","tags":["Inbox tags"],"description":"\n\n**Required Permission:** `chatbots.tags.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/views":{"post":{"operationId":"InboxViewController_createView[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateViewRequestDto"}}}},"responses":{"201":{"description":"View created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Permission denied."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new view","tags":["Inbox views"],"description":"\n\n**Required Permission:** `chatbots.inbox.views.create`\n\n**Resource:** `chatbots/:chatbotId`"},"get":{"operationId":"InboxViewController_listViews[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all views.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListViewsResponseDto"}}}},"403":{"description":"Permission denied."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all views for a chatbot","tags":["Inbox views"],"description":"\n\n**Required Permission:** `chatbots.inbox.views.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/views/{viewId}":{"get":{"operationId":"InboxViewController_getView[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}},{"name":"viewId","required":true,"in":"path","description":"The ID of the view","schema":{"type":"string"}}],"responses":{"200":{"description":"View details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewResponseDto"}}}},"403":{"description":"Permission denied."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific view","tags":["Inbox views"],"description":"\n\n**Required Permission:** `chatbots.inbox.views.get`\n\n**Resource:** `chatbots/:chatbotId`"},"put":{"operationId":"InboxViewController_updateView[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}},{"name":"viewId","required":true,"in":"path","description":"The ID of the view to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateViewRequestDto"}}}},"responses":{"200":{"description":"View updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Permission denied."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing view","tags":["Inbox views"],"description":"\n\n**Required Permission:** `chatbots.inbox.views.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"InboxViewController_deleteView[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}},{"name":"viewId","required":true,"in":"path","description":"The ID of the view to delete","schema":{"type":"string"}}],"responses":{"200":{"description":"View deleted successfully."},"403":{"description":"Permission denied."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a view","tags":["Inbox views"],"description":"\n\n**Required Permission:** `chatbots.inbox.views.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/views/{viewId}/conversations":{"get":{"operationId":"InboxViewController_listViewConversations[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}},{"name":"viewId","required":true,"in":"path","description":"The ID of the view","schema":{"type":"string"}},{"name":"limit","required":true,"in":"query","schema":{"type":"number"}},{"name":"pageToken","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"List of conversations for the view."},"403":{"description":"Permission denied."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists conversations for a view","tags":["Inbox views"],"description":"\n\n**Required Permission:** `chatbots.conversations.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/views/{viewId}/count":{"get":{"operationId":"InboxViewController_getViewConversationCount[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}},{"name":"viewId","required":true,"in":"path","description":"The ID of the view","schema":{"type":"string"}}],"responses":{"200":{"description":"The conversation count for the view."},"403":{"description":"Permission denied."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Gets the conversation count for a view","tags":["Inbox views"],"description":"\n\n**Required Permission:** `chatbots.conversations.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/messages":{"post":{"operationId":"InboxMessageController_sendMessage[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequestDto"}}}},"responses":{"201":{"description":"Message sent successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Sends a new message on behalf of an agent","tags":["Inbox messages"],"description":"\n\n**Required Permission:** `chatbots.inbox.messages.send`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/conversations":{"post":{"operationId":"InboxConversationController_createConversation[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInboxConversationRequestDto"}}}},"responses":{"201":{"description":"Conversation created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInboxConversationResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new inbox conversation","tags":["Inbox conversations"],"description":"\n\n**Required Permission:** `chatbots.inbox.conversations.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/notes":{"post":{"operationId":"InboxNoteController_sendNote[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNoteRequestDto"}}}},"responses":{"201":{"description":"Note successfully created as a message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNoteResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Adds an internal note to a conversation","tags":["Inbox notes"],"description":"\n\n**Required Permission:** `chatbots.inbox.notes.send`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/answers":{"get":{"operationId":"InboxAnswerController_listAnswers[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all response snippets.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAnswersResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all response snippets","tags":["Inbox answers"],"description":"\n\n**Required Permission:** `chatbots.inbox.answers.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"InboxAnswerController_createAnswer[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnswerRequestDto"}}}},"responses":{"201":{"description":"Response snippet created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnswerResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new response snippet","tags":["Inbox answers"],"description":"\n\n**Required Permission:** `chatbots.inbox.answers.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/answers/{answerId}":{"put":{"operationId":"InboxAnswerController_updateAnswer[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"answerId","required":true,"in":"path","description":"The ID of the response snippet to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAnswerRequestDto"}}}},"responses":{"200":{"description":"Response snippet updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnswerResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing response snippet","tags":["Inbox answers"],"description":"\n\n**Required Permission:** `chatbots.inbox.answers.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"InboxAnswerController_deleteAnswer[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"answerId","required":true,"in":"path","description":"The ID of the response snippet to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Response snippet deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAnswerResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a response snippet","tags":["Inbox answers"],"description":"\n\n**Required Permission:** `chatbots.inbox.answers.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/conversations/{conversationId}/summary":{"get":{"operationId":"InboxAiChatController_createChatSummary[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The ID of the conversation.","schema":{"type":"string"}}],"responses":{"200":{"description":"The generated summary.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatSummaryResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Generates an AI-based summary of the conversation","tags":["Inbox ai-chat-functions"],"description":"\n\n**Required Permission:** `chatbots.inbox.openai.summary`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/conversations/{conversationId}/completion":{"get":{"operationId":"InboxAiChatController_createChatCompletion[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The ID of the conversation.","schema":{"type":"string"}}],"responses":{"200":{"description":"The generated text completion.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatCompletionResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Generates a text completion for an agent's response","tags":["Inbox ai-chat-functions"],"description":"\n\n**Required Permission:** `chatbots.inbox.openai.completion`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/conversations/{conversationId}/formulation":{"post":{"operationId":"InboxAiChatController_createChatFormulation[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The ID of the conversation.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatFormulationRequestDto"}}}},"responses":{"201":{"description":"The reformulated message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatFormulationResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Reformulates a given message using AI","tags":["Inbox ai-chat-functions"],"description":"\n\n**Required Permission:** `chatbots.inbox.openai.formulation`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/agents/online":{"get":{"operationId":"InboxAgentsController_getOnlineAgents[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"A list of agent's online status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentOnlineStateResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all agent's online status from a chatbot","tags":["Inbox agents"],"description":"\n\n**Required Permission:** `chatbots.inbox.agents.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/agents/me/online":{"post":{"operationId":"InboxAgentsController_setOwnAgentState[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetAgentOnlineStateRequestDto"}}}},"responses":{"200":{"description":"The updated online status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetAgentOnlineStateResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Sets the agent's own online status","tags":["Inbox agents"],"description":"\n\n**Required Permission:** `chatbots.inbox.agents.online.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/agents/me/notifications":{"post":{"operationId":"InboxAgentsController_setOwnAgentNotificationSettings[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentNotificationSettingsRequestDto"}}}},"responses":{"200":{"description":"The updated settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentNotificationSettingsResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates the agent's own notification settings","tags":["Inbox agents"],"description":"\n\n**Required Permission:** `chatbots.inbox.agents.notifications.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"get":{"operationId":"InboxAgentsController_getOwnAgentNotificationSettings[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"The current settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentNotificationSettingsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves the agent's own notification settings","tags":["Inbox agents"],"description":"\n\n**Required Permission:** `chatbots.inbox.agents.notifications.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/teams":{"get":{"operationId":"InboxTeamsController_listTeams[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all teams.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTeamsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all teams for a chatbot","tags":["Inbox teams"],"description":"\n\n**Required Permission:** `chatbots.teams.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"InboxTeamsController_createTeam[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamRequestDto"}}}},"responses":{"201":{"description":"Team created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new team","tags":["Inbox teams"],"description":"\n\n**Required Permission:** `chatbots.teams.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/teams/{teamId}":{"get":{"operationId":"InboxTeamsController_getTeam[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"teamId","required":true,"in":"path","description":"The ID of the team to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Details of the team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific team","tags":["Inbox teams"],"description":"\n\n**Required Permission:** `chatbots.teams.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"InboxTeamsController_updateTeam[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"teamId","required":true,"in":"path","description":"The ID of the team to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTeamRequestDto"}}}},"responses":{"200":{"description":"Team updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing team","tags":["Inbox teams"],"description":"\n\n**Required Permission:** `chatbots.teams.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"InboxTeamsController_deleteTeam[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"teamId","required":true,"in":"path","description":"The ID of the team to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Team deleted successfully."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a team","tags":["Inbox teams"],"description":"\n\n**Required Permission:** `chatbots.teams.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/widgets":{"post":{"operationId":"InboxWidgetController_createInboxWidget[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInboxWidgetRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxWidgetResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]}],"summary":"Creates a widget","tags":["Inbox widgets"],"description":"\n\n**Required Permission:** `chatbots.inbox.widgets.create`\n\n**Resource:** `chatbots/:chatbotId`"},"get":{"operationId":"InboxWidgetController_listInboxWidgets[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInboxWidgetsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]}],"summary":"Lists all widgets","tags":["Inbox widgets"],"description":"\n\n**Required Permission:** `chatbots.inbox.widgets.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/widgets/{widgetId}":{"get":{"operationId":"InboxWidgetController_getInboxWidget[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}},{"name":"widgetId","required":true,"in":"path","description":"The Id of the widget.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxWidgetResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]}],"summary":"Gets a widget","tags":["Inbox widgets"],"description":"\n\n**Required Permission:** `chatbots.inbox.widgets.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"InboxWidgetController_updateInboxWidget[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}},{"name":"widgetId","required":true,"in":"path","description":"The Id of the widget.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInboxWidgetRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxWidgetResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]}],"summary":"Updates a widget","tags":["Inbox widgets"],"description":"\n\n**Required Permission:** `chatbots.inbox.widgets.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"InboxWidgetController_deleteInboxWidget[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}},{"name":"widgetId","required":true,"in":"path","description":"The Id of the widget.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteInboxWidgetResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]}],"summary":"Deletes a widget","tags":["Inbox widgets"],"description":"\n\n**Required Permission:** `chatbots.inbox.widgets.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/inbox/{chatbotId}/widgets/{widgetId}/values":{"get":{"operationId":"InboxWidgetController_getInboxWidgetValuesBatch[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}},{"name":"widgetId","required":true,"in":"path","description":"The Id of the widget.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"query","description":"The Id of the conversation.","schema":{"type":"string"}},{"name":"contactId","required":true,"in":"query","description":"The Id of the contact.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboxWidgetValuesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]}],"summary":"Gets a widget's values","tags":["Inbox widgets"],"description":"\n\n**Required Permission:** `chatbots.inbox.widgets.content.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/channels":{"get":{"operationId":"ChannelController_listChannels[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all channels.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all channels for a chatbot","tags":["Channel management"],"description":"\n\n**Required Permission:** `chatbots.channels.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/channels/generate-token":{"get":{"operationId":"ChannelController_generateChannelToken[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"channelType","required":true,"in":"query","description":"The type of the channel.\n\n- `0`: WEB\n- `6`: AUDIOCODES","schema":{"$ref":"#/components/schemas/ChannelType"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateChannelTokenResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]}],"summary":"Generates a channel token for Web or Audiocodes","tags":["Channel management"]}},"/v1/chatbots/{chatbotId}/channels/{channelId}/widget":{"get":{"operationId":"ChannelWebWidgetController_getWebWidgetSettings[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"channelId","required":true,"in":"path","description":"The ID of the web channel.","schema":{"type":"string"}}],"responses":{"200":{"description":"The current widget settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebWidgetSettingsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves web widget settings for a channel","tags":["Channel web-widget"],"description":"\n\n**Required Permission:** `chatbots.channels.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"ChannelWebWidgetController_updateWebWidgetSettings[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"channelId","required":true,"in":"path","description":"The ID of the web channel.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebWidgetSettingsRequestDto"}}}},"responses":{"200":{"description":"The updated widget settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebWidgetSettingsResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates web widget settings for a channel.","tags":["Channel web-widget"],"description":"\n\n**Required Permission:** `chatbots.channels.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/search":{"get":{"operationId":"ConversationSearchController_searchConversations[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"query","required":true,"in":"query","description":"The search term.","schema":{"type":"string"}},{"name":"viewId","required":true,"in":"query","description":"The ID of the view within which the search is conducted.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchConversationsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Search conversations","tags":["Conversation search"],"description":"\n\n**Required Permission:** `chatbots.conversations.search`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/search-external":{"get":{"operationId":"ConversationSearchController_searchConversationsExternal[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"query","required":true,"in":"query","description":"The search term.","schema":{"type":"string"}},{"name":"viewId","required":true,"in":"query","description":"The ID of the view within which the search is conducted.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchConversationsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Searches conversations for external inbox users","tags":["Conversation search"],"description":"\n\n**Required Permission:** `chatbots.conversations.search-external`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations":{"get":{"operationId":"ConversationController_listConversations[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"contactId","required":false,"in":"query","description":"Filters by a contact ID.","schema":{"type":"string"}},{"name":"channelId","required":false,"in":"query","description":"Filters by a channel ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConversationsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists and filters conversations","tags":["Conversation management"],"description":"\n\n**Required Permission:** `chatbots.conversations.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ConversationController_createConversation[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversationRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new conversation","tags":["Conversation management"],"description":"\n\n**Required Permission:** `chatbots.conversations.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/find":{"get":{"operationId":"ConversationController_findConversations[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"channelId","required":true,"in":"query","description":"The Id of the channel.","schema":{"type":"string"}},{"name":"providerId","required":true,"in":"query","description":"The Id of the provider.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindConversationResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Finds a conversation by external Id's","tags":["Conversation management"],"description":"\n\n**Required Permission:** `chatbots.conversations.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/{conversationId}":{"get":{"operationId":"ConversationController_getConversations[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The Id of the conversation to be retrieved.","schema":{"type":"string"}}],"responses":{"200":{"description":"The retrieved conversation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific conversation","tags":["Conversation management"],"description":"\n\n**Required Permission:** `chatbots.conversations.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"ConversationController_updateConversation[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The Id of the conversation to be updated.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConversationRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing conversation","tags":["Conversation management"],"description":"\n\n**Required Permission:** `chatbots.conversations.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ConversationController_deleteConversation[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The Id of the conversation to be deleted.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConversationResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a conversation","tags":["Conversation management"],"description":"\n\n**Required Permission:** `chatbots.conversations.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/handle":{"post":{"operationId":"ConversationController_handleIncomingMessage[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandleNewIncomingMessageRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandleIncomingResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Processes a new incoming message (e.g., from a channel)","tags":["Conversation management"],"description":"\n\n**Required Permission:** `chatbots.messages.handle`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/event":{"post":{"operationId":"ConversationController_handleIncomingEvent[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandleNewIncomingEventRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandleIncomingResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Processes a new incoming event (e.g., \"user_seen\")","tags":["Conversation management"],"description":"\n\n**Required Permission:** `chatbots.events.handle`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/payload":{"post":{"operationId":"ConversationController_handleIncomingStepPayload[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandleNewIncomingStepPayloadRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandleIncomingResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Processes a step payload.","tags":["Conversation management"],"description":"\n\n**Required Permission:** `chatbots.step-payload.handle`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/custom-event":{"post":{"operationId":"ConversationController_triggerCustomConversationEvent[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCustomConversationEventRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCustomConversationEventResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Triggers a custom event in a conversation","tags":["Conversation management"],"description":"\n\n**Required Permission:** `chatbots.events.handle`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/{conversationId}/messages":{"get":{"operationId":"ConversationMessageController_listMessages[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The ID of the conversation.","schema":{"type":"string"}}],"responses":{"200":{"description":"A list of all messages in the conversation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMessagesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all messages for a conversation","tags":["Conversation messages"],"description":"\n\n**Required Permission:** `chatbots.messages.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ConversationMessageController_createConversationMessage[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The ID of the conversation.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMessageRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new message in a conversation","tags":["Conversation messages"],"description":"\n\n**Required Permission:** `chatbots.messages.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/{conversationId}/messages/{messageId}":{"get":{"operationId":"ConversationMessageController_getConversationMessage[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The ID of the conversation.","schema":{"type":"string"}},{"name":"messageId","required":true,"in":"path","description":"The Id of the message to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific message","tags":["Conversation messages"],"description":"\n\n**Required Permission:** `chatbots.messages.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"ConversationMessageController_updateConversationMessage[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The Id of the conversation.","schema":{"type":"string"}},{"name":"messageId","required":true,"in":"path","description":"The Id of the message to retrieve.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing message","tags":["Conversation messages"],"description":"\n\n**Required Permission:** `chatbots.messages.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/organizations":{"get":{"operationId":"ConversationOrganizationController_listOrganizations[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"pageToken","required":false,"in":"query","description":"The date after which to filter organizations. Only organizations created before this date will be fetched.","schema":{"example":"2024-09-29T07:08:00Z","type":"string"}},{"name":"limit","required":false,"in":"query","description":"The amount of contacts to fetch","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrganizationsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all organizations for a chatbot","tags":["Conversation organizations"],"description":"\n\n**Required Permission:** `chatbots.organizations.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ConversationOrganizationController_createOrganization[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrganizationRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new organization","tags":["Conversation organizations"],"description":"\n\n**Required Permission:** `chatbots.organizations.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/organizations/search":{"get":{"operationId":"ConversationOrganizationController_searchOrganizations[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"query","required":true,"in":"query","description":"The search term.","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","description":"The page on which to start the seach.","schema":{"example":"1","type":"number"}},{"name":"pageSize","required":true,"in":"query","description":"The number of pages to return.","schema":{"example":"250","type":"number"}},{"name":"hiddenHits","required":false,"in":"query","description":"Comma-separated list of IDs to be excluded from the search results.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchOrganizationResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Searches organizations","tags":["Conversation organizations"],"description":"\n\n**Required Permission:** `chatbots.organizations.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/organizations/{organizationId}/contacts":{"get":{"operationId":"ConversationOrganizationController_listOrganizationContacts[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"organizationId","required":true,"in":"path","description":"The Id of the organization to add a contact to.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrganizationContactsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all contacts of an organization","tags":["Conversation organizations"],"description":"\n\n**Required Permission:** `chatbots.organizations.contacts.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/organizations/{organizationId}":{"patch":{"operationId":"ConversationOrganizationController_updateOrganization[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"organizationId","required":true,"in":"path","description":"The Id of the organization to add a contact to.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrganizationRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing organization","tags":["Conversation organizations"],"description":"\n\n**Required Permission:** `chatbots.organizations.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"get":{"operationId":"ConversationOrganizationController_getOrganization[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"organizationId","required":true,"in":"path","description":"The Id of the organization to add a contact to.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific organization","tags":["Conversation organizations"],"description":"\n\n**Required Permission:** `chatbots.organizations.get`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ConversationOrganizationController_deleteOrganization[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"organizationId","required":true,"in":"path","description":"The Id of the organization to add a contact to.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteOrganizationResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes an organization","tags":["Conversation organizations"],"description":"\n\n**Required Permission:** `chatbots.organizations.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/organizations/{organizationId}/contacts/count":{"get":{"operationId":"ConversationOrganizationController_getOrganizationContactsCount[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"organizationId","required":true,"in":"path","description":"The Id of the organization to add a contact to.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrganizationContactsCountResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Gets the count of contacts in an organization","tags":["Conversation organizations"],"description":"\n\n**Required Permission:** `chatbots.organizations.contacts.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/{conversationId}/variables":{"get":{"operationId":"ConversationVariableController_listVariables[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The ID of the conversation.","schema":{"type":"string"}}],"responses":{"200":{"description":"The list of conversation variables.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVariablesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all custom, entity and app variables of a conversation","tags":["Conversation variables"],"description":"\n\n**Required Permission:** `chatbots.conversations.variables.list`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ConversationVariableController_deleteVariables[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The ID of the conversation.","schema":{"type":"string"}}],"responses":{"200":{"description":"The deletion result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteVariablesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes all custom, entity and app variables of a conversation","tags":["Conversation variables"],"description":"\n\n**Required Permission:** `chatbots.conversations.variables.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/{conversationId}/variables/{variableId}":{"get":{"operationId":"ConversationVariableController_getVariable[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The ID of the conversation.","schema":{"type":"string"}},{"name":"variableId","required":true,"in":"path","description":"The Id of the variable.","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested variable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariableResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific custom, entity or app variable of a conversation","tags":["Conversation variables"],"description":"\n\n**Required Permission:** `chatbots.conversations.variables.get`\n\n**Resource:** `chatbots/:chatbotId`"},"put":{"operationId":"ConversationVariableController_assignValueToVariable[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"variableId","required":true,"in":"path","description":"The Id of the variable whose value is to be set.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The ID of the conversation.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignValueToConversationVariableRequestDto"}}}},"responses":{"200":{"description":"The updated variable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariableResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Sets or updates the value of a custom, entity or app variable in a conversation","tags":["Conversation variables"],"description":"\n\n**Required Permission:** `chatbots.conversations.variables.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/contacts/variables/{contactId}":{"get":{"operationId":"ConversationContactVariableController_listVariables[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}},{"name":"contactId","required":true,"in":"path","description":"The Id of the contact.","schema":{"type":"string"}}],"responses":{"200":{"description":"The list of contact variables.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVariablesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all custom variables of a contact","tags":["Contact variables"],"description":"\n\n**Required Permission:** `chatbots.contacts.variables.list`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ConversationContactVariableController_deleteVariables[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}},{"name":"contactId","required":true,"in":"path","description":"The Id of the contact.","schema":{"type":"string"}}],"responses":{"200":{"description":"The deletion result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteVariablesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes all custom variables of a contact","tags":["Contact variables"],"description":"\n\n**Required Permission:** `chatbots.contacts.variables.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/contacts/variables/{contactId}/{variableId}":{"get":{"operationId":"ConversationContactVariableController_getVariable[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}},{"name":"variableId","required":true,"in":"path","description":"The Id of the variable.","schema":{"type":"string"}},{"name":"contactId","required":true,"in":"path","description":"The Id of the contact.","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested variable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariableResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Gets a specific custom variable of a contact","tags":["Contact variables"],"description":"\n\n**Required Permission:** `chatbots.contacts.variables.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/contacts/variables/{variableId}":{"put":{"operationId":"ConversationContactVariableController_assignValueToVariable[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}},{"name":"variableId","required":true,"in":"path","description":"The Id of the variable whose value is to be set.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignValueToVariableRequestDto"}}}},"responses":{"200":{"description":"The updated variable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariableResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Sets or updates the value of a custom variable of a contact","tags":["Contact variables"],"description":"\n\n**Required Permission:** `chatbots.contacts.variables.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/contacts/search":{"get":{"operationId":"ConversationContactController_searchContacts[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"query","required":true,"in":"query","description":"The search term.","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","description":"The page on which to start the seach.","schema":{"example":"1","type":"number"}},{"name":"pageSize","required":true,"in":"query","description":"The number of pages to return.","schema":{"example":"250","type":"number"}},{"name":"hiddenHits","required":false,"in":"query","description":"Comma-separated list of IDs to be excluded from the search results.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchContactsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Searches contacts","tags":["Conversation contacts"],"description":"\n\n**Required Permission:** `chatbots.contacts.list`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/contacts":{"get":{"operationId":"ConversationContactController_listContacts[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"pageToken","required":false,"in":"query","description":"The date after which to filter organizations. Only organizations created before this date will be fetched.","schema":{"example":"2025-09-29T07:08:00Z","type":"string"}},{"name":"limit","required":false,"in":"query","description":"The amount of contacts to fetch","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContactsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all contacts for a chatbot","tags":["Conversation contacts"],"description":"\n\n**Required Permission:** `chatbots.contacts.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"ConversationContactController_createContact[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new contact","tags":["Conversation contacts"],"description":"\n\n**Required Permission:** `chatbots.contacts.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/contacts/{contactId}":{"get":{"operationId":"ConversationContactController_getContact[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"contactId","required":true,"in":"path","description":"The Id of the contact to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific contact","tags":["Conversation contacts"],"description":"\n\n**Required Permission:** `chatbots.contacts.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"ConversationContactController_updateContact[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"contactId","required":true,"in":"path","description":"The Id of the contact to retrieve.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing contact","tags":["Conversation contacts"],"description":"\n\n**Required Permission:** `chatbots.contacts.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ConversationContactController_deleteContact[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"contactId","required":true,"in":"path","description":"The Id of the contact to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteContactResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a contact","tags":["Conversation contacts"],"description":"\n\n**Required Permission:** `chatbots.contacts.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/contacts/{contactId}/organizations":{"get":{"operationId":"ConversationContactController_listContactOrganizations[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"contactId","required":true,"in":"path","description":"The Id of the contact to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContactOrganizationsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all organizations a contact belongs to","tags":["Conversation contacts"],"description":"\n\n**Required Permission:** `chatbots.contacts.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/conversations/{conversationId}/notes":{"patch":{"operationId":"ConversationNotesController_addConversationNotes[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The Id of the conversation to add notes to.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddConversationNotesRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationNotesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Adds notes to a conversation","tags":["Conversation notes"],"description":"\n\n**Required Permission:** `chatbots.conversations.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"ConversationNotesController_removeConversationNotes[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The Id of the conversation to add notes to.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveConversationNotesRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationNotesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Removes notes from a conversation","tags":["Conversation notes"],"description":"\n\n**Required Permission:** `chatbots.conversations.edit`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/statistics/reports/channel":{"get":{"operationId":"StatisticsController_getChannelReport[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}},{"name":"channelId","required":true,"in":"query","description":"The Id of the channel for which to retrieve statistics for.","schema":{"type":"string"}},{"name":"from","required":true,"in":"query","description":"The start date of the statistics timeframe (ISO format).","schema":{"example":"2025-01-04T23:00:00.000Z","type":"string"}},{"name":"to","required":true,"in":"query","description":"The end date of the statistics timeframe (ISO format).","schema":{"example":"2025-02-01T22:59:59.999Z","type":"string"}},{"name":"interval","required":true,"in":"query","description":"Sets the interval per day or hour in seconds (86400 for multiple days reports and 3600 for single day reports)","schema":{"enum":[86400,3600],"type":"number"}},{"name":"components","required":true,"in":"query","description":"Comma-separated list of component IDs.\n\n- `0`: STEP_EXEC_COUNT_FOR_CHANNEL_ID\n- `1`: CONVERSATION_COUNT_FOR_CHANNEL_ID\n- `2`: CONVERSATION_COUNT_INTERVAL_FOR_CHANNEL_ID\n- `3`: CONVERSATION_COUNT_PERIODIC_TREND_FOR_CHANNEL_ID\n- `4`: CONVERSATION_LANGUAGES_FOR_CHANNEL_ID\n- `5`: CONVERSATION_MESSAGE_COUNT_MEDIAN_FOR_CHANNEL_ID\n- `6`: INTENT_COUNT_FOR_CHANNEL_ID\n- `7`: INTENT_HITS_FOR_CHANNEL_ID\n- `8`: INTENT_SCORE_MEDIAN_FOR_CHANNEL_ID\n- `9`: INTERACTION_COUNT_FOR_CHANNEL_ID\n- `10`: INTERACTION_COUNT_INTERVAL_FOR_CHANNEL_ID\n- `11`: INTERACTION_COUNT_PERIODIC_TREND_FOR_CHANNEL_ID\n- `12`: MESSAGE_COUNT_FOR_CHANNEL_ID\n- `13`: MESSAGE_COUNT_INTERVAL_FOR_CHANNEL_ID\n- `14`: MESSAGE_COUNT_PERIODIC_TREND_FOR_CHANNEL_ID\n- `15`: MESSAGE_LENGTH_MEDIAN_FOR_CHANNEL_ID\n- `16`: CALL_DURATION_TOTAL\n- `17`: CALL_DURATION_PERIODIC_TREND\n- `18`: CALL_DURATION_MEDIAN\n- `19`: CALL_EXIT_STEP\n- `20`: CALL_USER_INPUTS_MEDIAN\n- `21`: CALL_END_REASON\n- `22`: CALL_TRANSFER_TARGET","schema":{"example":"0,1,2","type":"string"}}],"responses":{"200":{"description":"The report structure depends on the requested components.","content":{"application/json":{"schema":{"type":"object"}}}}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Generates a channel-specific report","tags":["Statistics"],"description":"\n\n**Required Permission:** `chatbots.statistics.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/statistics/reports/overview":{"get":{"operationId":"StatisticsController_getOverviewReport[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}},{"name":"from","required":true,"in":"query","description":"The start date of the statistics timeframe (ISO format).","schema":{"example":"2025-01-04T23:00:00.000Z","type":"string"}},{"name":"to","required":true,"in":"query","description":"The end date of the statistics timeframe (ISO format).","schema":{"example":"2025-02-01T22:59:59.999Z","type":"string"}},{"name":"interval","required":true,"in":"query","description":"Sets the interval per day or hour in seconds (86400 for multiple days reports and 3600 for single day reports)","schema":{"enum":[86400,3600],"type":"number"}},{"name":"components","required":true,"in":"query","description":"Comma-separated list of component IDs.\n\n- `0`: STEP_EXEC_COUNT\n- `1`: CONVERSATION_COUNT\n- `2`: CONVERSATION_COUNT_INTERVAL\n- `3`: CONVERSATION_LANGUAGES\n- `4`: CONVERSATION_BY_CHANNEL_TYPE\n- `5`: CONVERSATION_COUNT_PERIODIC_TREND\n- `6`: CONVERSATION_MESSAGE_COUNT_MEDIAN\n- `7`: MESSAGE_COUNT\n- `8`: MESSAGE_COUNT_INTERVAL\n- `9`: MESSAGE_COUNT_PERIODIC_TREND\n- `10`: MESSAGE_LENGTH_MEDIAN\n- `11`: INTENT_HITS\n- `12`: INTENT_SCORE_MEDIAN\n- `13`: INTENT_COUNT\n- `14`: INTERACTION_COUNT\n- `15`: INTERACTION_COUNT_INTERVAL\n- `16`: INTERACTION_COUNT_PERIODIC_TREND","schema":{"example":"0,1,2","type":"string"}}],"responses":{"200":{"description":"The report structure depends on the requested components.","content":{"application/json":{"schema":{"type":"object"}}}}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Generates an overview report","tags":["Statistics"],"description":"\n\n**Required Permission:** `chatbots.statistics.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/statistics/export":{"post":{"operationId":"StatisticsController_exportStats[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}},{"name":"from","required":true,"in":"query","description":"The start date of the statistics timeframe (ISO format).","schema":{"example":"2025-01-04T23:00:00.000Z","type":"string"}},{"name":"to","required":true,"in":"query","description":"The end date of the statistics timeframe (ISO format).","schema":{"example":"2025-02-01T22:59:59.999Z","type":"string"}}],"responses":{"202":{"description":"Export job has been started.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsExportResponseDto"}}}}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates an export of statistics","tags":["Statistics"],"description":"\n\n**Required Permission:** `chatbots.statistics.export`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/statistics/export/{exportId}":{"get":{"operationId":"StatisticsController_getStatsExportStatus[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}},{"name":"exportId","required":true,"in":"path","description":"The Id of the export job.","schema":{"type":"string"}}],"responses":{"200":{"description":"The current status of the export job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatsExportStatusResponseDto"}}}}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves the status of a statistics export","tags":["Statistics"],"description":"\n\n**Required Permission:** `chatbots.statistics.export`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/statistics/inbox":{"get":{"operationId":"StatisticsController_getInboxStatistics[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}},{"name":"from","required":true,"in":"query","description":"The start date of the statistics timeframe (ISO format).","schema":{"example":"2025-01-04T23:00:00.000Z","type":"string"}},{"name":"to","required":true,"in":"query","description":"The end date of the statistics timeframe (ISO format).","schema":{"example":"2025-02-01T22:59:59.999Z","type":"string"}}],"responses":{"200":{"description":"The inbox statistics data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInboxReportResponseDto"}}}}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves statistics of the inbox section of a chatbot.","tags":["Statistics"],"description":"\n\n**Required Permission:** `chatbots.statistics.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/statistics/channels":{"get":{"operationId":"StatisticsController_getChannels[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot","schema":{"type":"string"}}],"responses":{"200":{"description":"The list of channels for the chatbot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsGetChannelsResponseDto"}}}},"500":{"description":"Internal server error, e.g. if the channel service is unavailable."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves all channels associated with a chatbot","tags":["Statistics"],"description":"\n\n**Required Permission:** `chatbots.statistics.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/widget/{chatbotId}/conversations/{conversationId}/messages":{"get":{"operationId":"WidgetController_listWidgetConversationMessages[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}},{"name":"conversationId","required":true,"in":"path","description":"The Id of the conversation.","schema":{"type":"string"}},{"name":"token","required":true,"in":"query","description":"The widget token.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWidgetConversationMessagesResponseDto"}}}}},"security":[{"x-chatcaptain-key":[]}],"summary":"Lists the messages of a conversation for the widget","tags":["Widgets"]}},"/v1/widget/{chatbotId}/conversations":{"post":{"operationId":"WidgetController_createWidgetConversation[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWidgetConversationRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWidgetConversationResponseDto"}}}},"400":{"description":"Invalid input data."}},"security":[{"x-chatcaptain-key":[]}],"summary":"Creates a new conversation via the widget","tags":["Widgets"]}},"/v1/widget/{chatbotId}/contact":{"post":{"operationId":"WidgetController_createWidgetContact[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The Id of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWidgetContactRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWidgetContactResponseDto"}}}},"400":{"description":"Invalid input data."}},"security":[{"x-chatcaptain-key":[]}],"summary":"Creates a new contact via the widget","tags":["Widgets"]}},"/v1/chatbots/{chatbotId}/ai/knowledge/sources":{"get":{"operationId":"AiKnowledgeSourceController_listKnowledgeSources[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"pageToken","required":false,"in":"query","description":"The date after which to filter sources. Only sources created after this date will be fetched.","schema":{"example":"2025-09-29T07:08:00Z","type":"string"}},{"name":"limit","required":false,"in":"query","description":"The limit for how many sources should be fetched.","schema":{"type":"number"}}],"responses":{"200":{"description":"List of all knowledge sources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListKnowledgeSourcesResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all knowledge sources for a chatbot","tags":["Ai knowledge-sources"],"description":"\n\n**Required Permission:** `chatbots.knowledge-source.list`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"AiKnowledgeSourceController_deleteKnowledgeSourceBatch[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteKnowledgeSourceBatchRequestDto"}}}},"responses":{"200":{"description":"Deletion result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteKnowledgeSourceResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a batch of knowledge sources.","tags":["Ai knowledge-sources"],"description":"\n\n**Required Permission:** `chatbots.knowledge-source.delete`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/ai/knowledge/sources/{sourceId}":{"get":{"operationId":"AiKnowledgeSourceController_getKnowledgeSource[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"sourceId","required":true,"in":"path","description":"The ID of the knowledge source to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Knowledge source details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetKnowledgeSourceResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific knowledge source","tags":["Ai knowledge-sources"],"description":"\n\n**Required Permission:** `chatbots.knowledge-source.get`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/ai/knowledge/sources/upload":{"post":{"operationId":"AiKnowledgeSourceController_uploadKnowledgeSourceFile[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Files to be uploaded as knowledge sources.","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UploadFilesDto"}}}},"responses":{"200":{"description":"Upload result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadKnowledgeSourceFilesResponseDto"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Uploads knowledge source files.","tags":["Ai knowledge-sources"],"description":"\n\n**Required Permission:** `chatbots.knowledge-source.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/ai/knowledge/groups":{"get":{"operationId":"AiKnowledgeGroupController_listKnowledgeGroups[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"pageToken","required":false,"in":"query","description":"The date after which to filter groups. Only groups created after this date will be fetched.","schema":{"example":"2025-09-29T07:08:00Z","type":"string"}},{"name":"limit","required":false,"in":"query","description":"The limit for how many groups should be fetched.","schema":{"type":"number"}}],"responses":{"200":{"description":"List of all knowledge groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListKnowledgeGroupsResponseDto"}}}},"401":{"description":"Not authenticated."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Lists all knowledge groups","tags":["Ai knowledge-groups"],"description":"\n\n**Required Permission:** `chatbots.knowledge-source.list`\n\n**Resource:** `chatbots/:chatbotId`"},"post":{"operationId":"AiKnowledgeGroupController_createKnowledgeGroup[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKnowledgeGroupRequestDto"}}}},"responses":{"201":{"description":"Knowledge group created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeGroupResponseDto"}}}},"400":{"description":"Invalid input data."},"401":{"description":"Not authenticated."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Creates a new knowledge group","tags":["Ai knowledge-groups"],"description":"\n\n**Required Permission:** `chatbots.knowledge-source.create`\n\n**Resource:** `chatbots/:chatbotId`"}},"/v1/chatbots/{chatbotId}/ai/knowledge/groups/{groupId}":{"get":{"operationId":"AiKnowledgeGroupController_getKnowledgeGroups[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"groupId","required":true,"in":"path","description":"The ID of the knowledge group to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Knowledge group details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeGroupResponseDto"}}}},"401":{"description":"Not authenticated."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Retrieves a specific knowledge group","tags":["Ai knowledge-groups"],"description":"\n\n**Required Permission:** `chatbots.knowledge-source.get`\n\n**Resource:** `chatbots/:chatbotId`"},"patch":{"operationId":"AiKnowledgeGroupController_updateKnowledgeGroup[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"groupId","required":true,"in":"path","description":"The ID of the knowledge group to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKnowledgeGroupRequestDto"}}}},"responses":{"200":{"description":"Knowledge group updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeGroupResponseDto"}}}},"400":{"description":"Invalid input data."},"401":{"description":"Not authenticated."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Updates an existing knowledge group","tags":["Ai knowledge-groups"],"description":"\n\n**Required Permission:** `chatbots.knowledge-source.edit`\n\n**Resource:** `chatbots/:chatbotId`"},"delete":{"operationId":"AiKnowledgeGroupController_deleteKnowledgeSource[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"groupId","required":true,"in":"path","description":"The ID of the knowledge group to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Knowledge group deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteKnowledgeGroupResponseDto"}}}},"401":{"description":"Not authenticated."},"403":{"description":"Insufficient permissions."}},"security":[{"x-chatcaptain-key":[]},{"x-chatcaptain-key":[]}],"summary":"Deletes a knowledge group","tags":["Ai knowledge-groups"],"description":"\n\n**Required Permission:** `chatbots.knowledge-source.delete`\n\n**Resource:** `chatbots/:chatbotId`"}}},"info":{"title":"ChatCaptain API","description":"","version":"1.0","contact":{}},"tags":[{"name":"Ai knowledge-groups","description":""},{"name":"Ai knowledge-sources","description":""},{"name":"App public","description":""},{"name":"Channel management","description":""},{"name":"Channel web-widget","description":""},{"name":"Chatbot management","description":""},{"name":"Chatbot ai-feature-settings","description":""},{"name":"Chatbot api-keys","description":""},{"name":"Chatbot deployments","description":""},{"name":"Chatbot entities","description":""},{"name":"Chatbot examples","description":""},{"name":"Chatbot expressions","description":""},{"name":"Chatbot faqs","description":""},{"name":"Chatbot flows","description":""},{"name":"Chatbot intents","description":""},{"name":"Chatbot language-settings","description":""},{"name":"Chatbot models","description":""},{"name":"Chatbot steps","description":""},{"name":"Chatbot templates","description":""},{"name":"Chatbot training","description":""},{"name":"Chatbot triggers","description":""},{"name":"Chatbot users","description":""},{"name":"Chatbot variables","description":""},{"name":"Chatbot versions","description":""},{"name":"Conversation management","description":""},{"name":"Conversation search","description":""},{"name":"Conversation notes","description":""},{"name":"Conversation messages","description":""},{"name":"Conversation contacts","description":""},{"name":"Conversation organizations","description":""},{"name":"Conversation variables","description":""},{"name":"Contact variables","description":""},{"name":"Inbox agents","description":""},{"name":"Inbox ai-chat-functions","description":""},{"name":"Inbox answers","description":""},{"name":"Inbox conversations","description":""},{"name":"Inbox messages","description":""},{"name":"Inbox notes","description":""},{"name":"Inbox tags","description":""},{"name":"Inbox teams","description":""},{"name":"Inbox views","description":""},{"name":"Inbox widgets","description":""},{"name":"Statistics","description":""},{"name":"Storage objects","description":""},{"name":"Widgets","description":""}],"servers":[{"url":"https://api.chatcaptain.com","description":"Production"}],"components":{"securitySchemes":{"x-chatcaptain-key":{"type":"apiKey","in":"header","name":"x-chatcaptain-key"}},"schemas":{"UpdateChatbotPayloadDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the chatbot.","example":"Support & Sales Bot"},"timeZone":{"type":"string","description":"The new timezone of the chatbot.","example":"America/New_York"}}},"UpdateChatbotRequestDto":{"type":"object","properties":{"updateChatbot":{"description":"The object containing the fields to be updated.","allOf":[{"$ref":"#/components/schemas/UpdateChatbotPayloadDto"}]}},"required":["updateChatbot"]},"BotEdition":{"type":"number","enum":[0,1,2,3,-1],"description":"The edition of the bot.\n\n- `0`: ENTERPRISE\n- `1`: VOICE_AGENT_GO_TEMPLATE\n- `2`: VOICE_AGENT_GO\n- `3`: AI_ASSISTANT"},"ChatbotDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the chatbot.","example":"botKq8BxZaJd2wZR9cxd1P"},"name":{"type":"string","description":"The name of the chatbot.","example":"My first Chatbot"},"workspaceId":{"type":"string","description":"The ID of the workspace this chatbot belongs to.","example":"ws59aBv7wzR9cxd1Pxyz"},"type":{"type":"string","description":"The type of the chatbot.","example":"default"},"created":{"type":"string","description":"The creation timestamp of the chatbot.","example":"2025-10-01T09:00:00Z"},"updated":{"type":"string","description":"The last update timestamp of the chatbot.","example":"2025-10-01T09:05:00Z"},"enabled":{"type":"boolean","description":"Indicates whether the chatbot is enabled.","example":true},"timeZone":{"type":"string","description":"The timezone of the chatbot.","example":"Europe/Berlin"},"edition":{"description":"The edition of the bot.\n\n- `0`: ENTERPRISE\n- `1`: VOICE_AGENT_GO_TEMPLATE\n- `2`: VOICE_AGENT_GO\n- `3`: AI_ASSISTANT","example":0,"allOf":[{"$ref":"#/components/schemas/BotEdition"}]}},"required":["name","workspaceId","type","created","updated","enabled","timeZone","edition"]},"ChatbotResponseDto":{"type":"object","properties":{"chatbot":{"description":"The chatbot object.","allOf":[{"$ref":"#/components/schemas/ChatbotDto"}]},"error":{"type":"string","description":"Optional error message."}}},"BucketDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the bucket.","example":"bckt59aBv7wzR9cxd1Pxyz"},"name":{"type":"string","description":"The name of the bucket.","example":"content-wzR9cxd1Pxyzd1Px"},"created":{"type":"string","description":"The creation timestamp of the bucket.","example":"2025-10-01T09:00:00Z"},"updated":{"type":"string","description":"The last update timestamp of the bucket.","example":"2025-10-01T09:00:00Z"}},"required":["id","name","created","updated"]},"GetChatbotResponseDto":{"type":"object","properties":{"chatbot":{"description":"The retrieved chatbot.","allOf":[{"$ref":"#/components/schemas/ChatbotDto"}]},"buckets":{"description":"A list of buckets associated with the chatbot.","type":"array","items":{"$ref":"#/components/schemas/BucketDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["buckets"]},"ApiKeyResponseDto":{"type":"object","properties":{"apiKey":{"type":"string","description":"The generated API key. Only fully displayed upon creation.","example":"CCSB-a1b2c3d4-e5f6g7h8i9j0"},"error":{"type":"string","description":"Optional error message."}}},"WhatsAppTemplateDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the template.","example":"6XAjCp0D1VeJarAR9mfe"},"name":{"type":"string","description":"The name of the template.","example":"order_confirmation"},"category":{"type":"string","description":"The category of the template (e.g., UTILITY, MARKETING).","example":"UTILITY"},"rejectReason":{"type":"string","description":"The reason for rejection, if the template was rejected.","example":"Content policy violation"},"created":{"type":"string","description":"Timestamp of when the template was created.","example":"2025-10-03T12:00:00Z"},"updated":{"type":"string","description":"Timestamp of when the template was last updated.","example":"2025-10-03T12:05:00Z"},"translations":{"type":"object","description":"An object containing translations for different languages.","additionalProperties":{"$ref":"#/components/schemas/WhatsAppTemplateTranslationsDto"}}},"required":["id","name","category","created","updated","translations"]},"WhatsAppTemplateResponseDto":{"type":"object","properties":{"template":{"description":"The WhatsApp template.","allOf":[{"$ref":"#/components/schemas/WhatsAppTemplateDto"}]},"error":{"type":"string","description":"Optional error message."}}},"CreateWhatsAppTemplateRequestDto":{"type":"object","properties":{"channelId":{"type":"string","description":"The ID of the channel for which the template is created.","example":"t1o15pfRt7PBT5hvC9z4"},"name":{"type":"string","description":"The name of the template.","example":"order_confirmation_v2"},"category":{"type":"string","description":"The category of the template (e.g., \"UTILITY\", \"MARKETING\").","example":"UTILITY"},"translations":{"type":"object","description":"The template translations as key-value pairs (language code -> translation).","additionalProperties":{"$ref":"#/components/schemas/WhatsAppTemplateTranslationsCreateDto"}}},"required":["channelId","name","category","translations"]},"AddChatbotUserRequestDto":{"type":"object","properties":{"userId":{"type":"string","description":"The ID of the user to be added.","example":"PmVSyFWMFYWB3xvHHwsc"}},"required":["userId"]},"AddChatbotUserResponseDto":{"type":"object","properties":{"added":{"type":"boolean","description":"Indicates whether the user was successfully added.","example":true},"error":{"type":"string","description":"Optional error message."}}},"RemoveChatbotUserResponseDto":{"type":"object","properties":{"removed":{"type":"boolean","description":"Indicates whether the user was successfully removed.","example":true},"error":{"type":"string","description":"Optional error message."}}},"ChatbotUserDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the user.","example":"kFf3OqjhsGK1rdAIyU4r"},"name":{"type":"string","description":"The display name of the user.","example":"Max Mustermann"},"email":{"type":"string","description":"The email address of the user.","example":"max.mustermann@example.com"},"added":{"type":"string","description":"Timestamp of when the user was added to the chatbot.","example":"2025-10-03T20:00:00Z"},"roles":{"description":"The list of roles assigned to the user.","example":["admin","editor"],"type":"array","items":{"type":"string"}}},"required":["id","name","email","added","roles"]},"ListChatbotUsersResponseDto":{"type":"object","properties":{"users":{"description":"The list of users associated with the chatbot.","type":"array","items":{"$ref":"#/components/schemas/ChatbotUserDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["users"]},"GrantChatbotRoleRequestDto":{"type":"object","properties":{"role":{"type":"string","description":"The role to be assigned.","enum":["ChatbotAdmin","ChatbotOwner","ChatbotEditor","ChatbotMember","InboxAdmin","InboxUser","ExternalInboxUser","StatisticsViewer"],"example":"ChatbotEditor"},"params":{"type":"object","description":"Additional parameters for the role assignment.","additionalProperties":{"type":"string"},"example":{"chatbotId":"fjQV0jxv2uI5oIaIDtvx","userId":"967dgbak26dgöadw769efndp87"}}},"required":["role","params"]},"PermissionDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the permission.","example":"chatbots.users.list"},"resource":{"type":"string","description":"The resource ID the permission applies to, if scoped.","example":"fjQV0jxv2uI5oIaIDtvx"}},"required":["name"]},"GrantChatbotRoleResponseDto":{"type":"object","properties":{"permissions":{"description":"The resulting list of permissions after the role assignment.","type":"array","items":{"$ref":"#/components/schemas/PermissionDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["permissions"]},"RevokeChatbotRoleRequestDto":{"type":"object","properties":{"params":{"type":"object","description":"Additional parameters that must match those of the assignment.","additionalProperties":{"type":"string"},"example":{"chatbotId":"fjQV0jxv2uI5oIaIDtvx","userId":"967dgbak26dgöadw769efndp87"}}},"required":["params"]},"RevokeChatbotRoleResponseDto":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the role was successfully revoked.","example":true},"error":{"type":"string","description":"Optional error message."}},"required":["success"]},"CreateFaqRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The question or name of the new FAQ.","example":"Opening hours"}},"required":["name"]},"FaqStepDto":{"type":"object","properties":{"stepId":{"type":"string","description":"The ID of the step to which the FAQ belongs.","example":"59aBv7wzR9cxd1Pxyz"},"flowId":{"type":"string","description":"The ID of the flow to which the FAQ belongs.","example":"Kq8BxZaJd2wZR9cxd1P"}},"required":["stepId","flowId"]},"FaqDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the FAQ.","example":"59aBv7wzR9cxd1Pxyz"},"created":{"type":"string","description":"The creation timestamp of the FAQ.","example":"2025-10-02T12:00:00Z"},"updated":{"type":"string","description":"The last update timestamp of the FAQ.","example":"2025-10-02T12:05:00Z"},"name":{"type":"string","description":"The question or name of the FAQ.","example":"What are the shipping costs?"},"intentId":{"type":"string","description":"The ID of the associated intent.","example":"Kq8BxZaJd2wZR9cxd1P"},"stepId":{"type":"string","description":"The ID of the associated step.","example":"59aBv7wzR9cxd1Pxyz"},"hasMessages":{"type":"boolean","description":"Indicates whether the associated step contains message elements.","example":true},"step":{"description":"The step and flow information for the FAQ.","allOf":[{"$ref":"#/components/schemas/FaqStepDto"}]}},"required":["id","created","updated","name","intentId","stepId","hasMessages","step"]},"FaqResponseDto":{"type":"object","properties":{"faq":{"description":"The FAQ object.","allOf":[{"$ref":"#/components/schemas/FaqDto"}]},"error":{"type":"string","description":"Optional error message."}}},"ListFaqsResponseDto":{"type":"object","properties":{"faqs":{"description":"A list of FAQs.","type":"array","items":{"$ref":"#/components/schemas/FaqDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["faqs"]},"UpdateFaqRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the FAQ.","example":"What are the changed opening hours?"}},"required":["name"]},"DeleteFaqResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the deletion process was successful.","example":true},"error":{"type":"string","description":"Optional error message."}},"required":["deleted"]},"ExampleEntityDto":{"type":"object","properties":{"entityId":{"type":"string","description":"The Id of the entity.","example":"ent_59aBv7wzR9cxd1Pxyz"},"value":{"type":"string","description":"The value of the entitiy","example":"Bestellnummer"},"start":{"type":"number","description":"The position on which the entity starts.","example":12},"end":{"type":"number","description":"The position on which the entity ends.","example":25}},"required":["entityId","value","start","end"]},"ExampleStatus":{"type":"number","enum":[0,1,2,3,-1],"description":"The status of the example.\n\n- `0`: PENDING\n- `1`: INDEXING\n- `2`: INDEXED\n- `3`: ERROR"},"ExampleDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the example.","example":"ex_Kq8BxZaJd2wZR9cxd1P"},"text":{"type":"string","description":"The text of the example.","example":"When does my order arrive?"},"created":{"type":"string","description":"The creation timestamp of the example.","example":"2025-10-02T10:00:00Z"},"updated":{"type":"string","description":"The last update timestamp of the example.","example":"2025-10-02T10:05:00Z"},"language":{"type":"string","description":"The language of the example.","example":"DE"},"intentId":{"type":"string","description":"The ID of the intent this example belongs to.","example":"int_59aBv7wzR9cxd1Pxyz"},"error":{"type":"boolean","description":"Indicates if there was an error with the example.","example":false},"predictionScore":{"type":"number","description":"The prediction score of the example.","example":0.98},"entityIds":{"description":"A list of entity IDs associated with this example.","example":["ent_59aBv7wzR9cxd1Pxyz"],"type":"array","items":{"type":"string"}},"entities":{"description":"A list of entities found in this example.","type":"array","items":{"$ref":"#/components/schemas/ExampleEntityDto"}},"translatedExampleIds":{"description":"A list of IDs of translated examples.","type":"array","items":{"type":"string"}},"status":{"description":"The status of the example.\n\n- `0`: PENDING\n- `1`: INDEXING\n- `2`: INDEXED\n- `3`: ERROR","example":2,"allOf":[{"$ref":"#/components/schemas/ExampleStatus"}]},"vector":{"description":"The vector representation of the example.","type":"array","items":{"type":"number"}},"conversationId":{"type":"string","description":"The ID of the conversation this example belongs to.","example":"Kq8BxZaJd2wZR9cxd1P"}},"required":["id","text","created","updated","language","intentId","error","entityIds","entities","translatedExampleIds","status","vector"]},"ListExamplesResponseDto":{"type":"object","properties":{"pageToken":{"type":"string","description":"The date of the latest fetched example."},"examples":{"description":"A list of examples.","type":"array","items":{"$ref":"#/components/schemas/ExampleDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["pageToken","examples"]},"CreateExampleRequestDto":{"type":"object","properties":{"intentId":{"type":"string","description":"The ID of the Intent to which this example is assigned.","example":"59aBv7wzR9cxd1Pxyz"},"text":{"type":"string","description":"The text of the training example.","example":"I would like to know the status of my order."},"language":{"type":"string","description":"The language of the example.","example":"DE"},"entityIds":{"description":"A list of entity Id's that are marked in this example.","default":[],"type":"array","items":{"type":"string"}},"entities":{"description":"The entities marked in this example.","default":[],"type":"array","items":{"$ref":"#/components/schemas/ExampleEntityDto"}},"translate":{"type":"boolean","description":"Indicates whether the example should be translated into other languages."},"conversationId":{"type":"string","description":"Optional ID of the conversation from which the example originated.","example":"Kq8BxZaJd2wZR9cxd1P"}},"required":["intentId","text","entityIds","entities"]},"ExampleResponseDto":{"type":"object","properties":{"example":{"description":"The example details.","allOf":[{"$ref":"#/components/schemas/ExampleDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["example"]},"UpdateExampleRequestDto":{"type":"object","properties":{"text":{"type":"string","description":"The updated text of the training example."},"entityIds":{"default":[],"type":"array","items":{"type":"string"}},"entities":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/ExampleEntityDto"}},"status":{"description":"Sets the indexing status of the example.\n\n- `0`: EXAMPLE_STATUS_PENDING\n- `1`: EXAMPLE_STATUS_INDEXING\n- `2`: EXAMPLE_STATUS_INDEXED\n- `3`: EXAMPLE_STATUS_ERROR","allOf":[{"$ref":"#/components/schemas/ExampleStatus"}]},"vector":{"description":"The manually set vector for this example.","default":[],"type":"array","items":{"type":"number"}}},"required":["text","entityIds","entities","vector"]},"DeleteExampleResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the deletion was successful.","example":true},"error":{"type":"string","description":"Optional error message."}},"required":["deleted"]},"ActorDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the actor.","example":"flow"},"flowId":{"type":"string","description":"The ID of the flow that the trigger step resides in.","example":"Mq8BxZaJd2wZR9cxd1P"},"stepId":{"type":"string","description":"The ID of the step that is triggered by the intent.","example":"l9aBv7wzR9cxd1Pxyz"}},"required":["type","flowId","stepId"]},"IntentDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the intent.","example":"69aBv7wzR9cxd1Pxyz"},"name":{"type":"string","description":"The name of the intent.","example":"Query order status"},"created":{"type":"string","description":"The creation timestamp of the intent.","example":"2025-10-02T15:00:00Z"},"updated":{"type":"string","description":"The last update timestamp of the intent.","example":"2025-10-02T15:05:00Z"},"confidenceScore":{"type":"number","minimum":0,"maximum":1,"description":"The minimum confidence score (0.0-1.0) required for this intent to be triggered.","example":0.75},"state":{"type":"string","description":"The training status of the intent.","example":"trained"},"trainingRequired":{"type":"boolean","description":"Indicates whether retraining is required after changes.","example":false},"actor":{"description":"Defines which action (e.g., which flow) is executed when the intent is recognized.","allOf":[{"$ref":"#/components/schemas/ActorDto"}]}},"required":["name","created","updated","confidenceScore","state","trainingRequired","actor"]},"ListIntentsResponseDto":{"type":"object","properties":{"intents":{"description":"A list of intents.","type":"array","items":{"$ref":"#/components/schemas/IntentDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["intents"]},"IntentResponseDto":{"type":"object","properties":{"intent":{"description":"The intent object.","allOf":[{"$ref":"#/components/schemas/IntentDto"}]},"error":{"type":"string","description":"Optional error message."}}},"CreateIntentRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the new intent.","example":"Register return"},"confidenceScore":{"type":"number","minimum":0,"maximum":1,"description":"The required minimum confidence score (0.0-1.0).","example":0.8},"actor":{"description":"The action to be executed.","nullable":true,"allOf":[{"$ref":"#/components/schemas/ActorDto"}]}},"required":["name","confidenceScore","actor"]},"UpdateIntentRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name for the intent.","example":"Returns and exchanges"},"confidenceScore":{"type":"number","minimum":0,"maximum":1,"description":"The new confidence score for the intent.","example":0.85},"trainingRequired":{"type":"boolean","description":"Whether the intent requires training.","example":true},"actor":{"description":"The new actor for the intent.","allOf":[{"$ref":"#/components/schemas/ActorDto"}]}}},"DeleteIntentResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the deletion was successful.","example":true},"error":{"type":"string","description":"Optional error message."}},"required":["deleted"]},"TriggerActorDto":{"type":"object","properties":{"flowId":{"type":"string","description":"The ID of the Flow that the step resides in.","example":"EeSDw4CwFPqrObmcvNuh"},"stepId":{"type":"string","description":"The ID of the step that is triggered.","example":"V1dBTyPkc6BdAxtfRPEm"}},"required":["flowId","stepId"]},"TriggerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the trigger.","example":"8Qd7z4W6qm0m5w7e7O3a"},"created":{"type":"string","description":"Creation timestamp (ISO format).","example":"2025-10-03T18:00:00Z"},"updated":{"type":"string","description":"Last updated timestamp (ISO format).","example":"2025-10-03T18:05:00Z"},"event":{"type":"string","description":"The event that triggers the action.","example":"conversation_started"},"payload":{"type":"string","description":"An optional payload required for triggering the event.","example":"welcome_message"},"actor":{"description":"Defines which action (e.g., which Flow) will be executed.","allOf":[{"$ref":"#/components/schemas/TriggerActorDto"}]}},"required":["id","created","updated","event","actor"]},"ListTriggersResponseDto":{"type":"object","properties":{"triggers":{"description":"A list of triggers for the chatbot.","type":"array","items":{"$ref":"#/components/schemas/TriggerDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["triggers"]},"StepGridDto":{"type":"object","properties":{"x":{"type":"number","description":"X-coordinate in the flow editor.","example":100},"y":{"type":"number","description":"Y-coordinate in the flow editor.","example":200}},"required":["x","y"]},"StepElementContentTextDto":{"type":"object","properties":{"text":{"type":"object","description":"The text content, localized by language key.","additionalProperties":{"type":"string"},"example":{"DE":"Hallo Welt!","EN-GB":"Hello World!"}}},"required":["text"]},"StepElementContentButtonButtonDto":{"type":"object","properties":{"text":{"type":"object","description":"The text displayed on the button, localized.","additionalProperties":{"type":"string"},"example":{"de":"Ja","en":"Yes"}},"value":{"type":"string","description":"The value associated with the button.","example":"flow_123/step_456"},"type":{"type":"string","description":"The type of button (e.g., 'redirect', 'postback').","example":"redirect"},"payload":{"type":"string","description":"An optional payload for postback buttons.","example":"BUTTON_CLICKED"}},"required":["text","value","type"]},"StepElementContentButtonDto":{"type":"object","properties":{"buttons":{"description":"A list of buttons to display.","type":"array","items":{"$ref":"#/components/schemas/StepElementContentButtonButtonDto"}}},"required":["buttons"]},"StepElementContentFileDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the file.","example":"document.pdf"},"bucketId":{"type":"string","description":"The ID of the bucket where the file is stored.","example":"bucket789"},"objectId":{"type":"string","description":"The object ID of the file within the bucket.","example":"object1011"},"mimeType":{"type":"string","description":"The MIME type of the file.","example":"application/pdf"},"sizeInByte":{"type":"number","description":"The size of the file in bytes.","example":102400},"fbaId":{"type":"string","description":"Facebook attachment ID (optional).","example":"fba123"},"waaId":{"type":"string","description":"WhatsApp attachment ID (optional).","example":"waa456"}},"required":["name","bucketId","objectId","mimeType","sizeInByte"]},"StepElementContentVoiceHangupDto":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for hanging up the voice call.","example":"user_disconnected"},"headers":{"type":"object","description":"Custom headers to send with the hangup event.","additionalProperties":{"type":"string"},"example":{"X-Reason-Code":"1001"}}},"required":["reason","headers"]},"StepElementContentVoiceTransferDto":{"type":"object","properties":{"target":{"type":"string","description":"The target for the voice transfer (e.g., a phone number).","example":"+1234567890"},"reason":{"type":"string","description":"An optional reason for the voice transfer.","example":"agent_transfer"},"headers":{"type":"object","description":"Custom headers to send with the voice transfer.","additionalProperties":{"type":"string"},"example":{"X-Transfer-ID":"abc-123"}}},"required":["target","headers"]},"StepElementContentAgentHandoverDto":{"type":"object","properties":{"reason":{"type":"string","description":"An optional reason for the agent handover.","example":"escalation"},"timeoutSeconds":{"type":"number","description":"Timeout in seconds for the agent to accept the handover.","example":60},"agentId":{"type":"string","description":"The ID of the specific agent to hand over to.","example":"agent987"},"groupId":{"type":"string","description":"The ID of the agent group to hand over to.","example":"support_team"},"assignmentMethod":{"type":"string","description":"The method used for assigning the agent.","example":"round_robin"}}},"StepElementContentAssignVariableDto":{"type":"object","properties":{"variableId":{"type":"string","description":"The ID of the variable to assign a value to.","example":"varUserQuery"},"path":{"type":"string","description":"Optional JSON path within the variable to assign the value.","example":"$.data.query"},"value":{"type":"string","description":"The value to assign to the variable.","example":"What is your return policy?"}},"required":["variableId"]},"StepElementContentUpdateTagsDto":{"type":"object","properties":{"method":{"type":"string","description":"The method to update tags ('add' or 'remove').","enum":["add","remove"],"example":"add"},"tagId":{"type":"string","description":"The ID of the tag to add or remove.","example":"tag_vip_customer"}},"required":["method","tagId"]},"StepElementContentSnoozeDto":{"type":"object","properties":{"seconds":{"type":"number","description":"The duration in seconds to snooze the conversation.","example":3600}},"required":["seconds"]},"StepElementContentUnreadDto":{"type":"object","properties":{"unread":{"type":"boolean","description":"Whether to mark the conversation as unread.","example":true}},"required":["unread"]},"StepElementContentWhatsAppTemplateDto":{"type":"object","properties":{"templateId":{"type":"string","description":"The ID of the WhatsApp template to send.","example":"template_order_update"},"parameters":{"type":"object","description":"Parameters to populate the WhatsApp template.","additionalProperties":{"type":"string"},"example":{"customer_name":"John Doe","order_id":"12345"}}},"required":["templateId","parameters"]},"StepElementContentTextToSpeechDto":{"type":"object","properties":{"text":{"type":"object","description":"The text content for text-to-speech, localized.","additionalProperties":{"type":"string"},"example":{"en":"Your call is important to us."}},"speech":{"type":"string","description":"Optional SSML speech markup.","example":"<speak>Hello <break time='1s'/> World!</speak>"}},"required":["text"]},"StepElementContentCallSettingsDto":{"type":"object","properties":{"userInputSpeechDetectionTimeout":{"type":"number","description":"Timeout for user speech detection in milliseconds.","example":5000},"dtmf":{"type":"boolean","description":"Whether DTMF (Dual-tone multi-frequency) input is enabled.","example":true},"bargeIn":{"type":"boolean","description":"Whether barge-in is enabled (user can interrupt bot).","example":true}}},"StepElementContentMetaWhatsAppTemplateHeaderDto":{"type":"object","properties":{"file":{"description":"The file used in the template header.","allOf":[{"$ref":"#/components/schemas/StepElementContentFileDto"}]},"parameters":{"description":"Parameters for the header text.","example":["{{1}}","User Name"],"type":"array","items":{"type":"string"}}},"required":["parameters"]},"StepElementContentMetaWhatsAppTemplateButtonsDto":{"type":"object","properties":{"values":{"description":"Values for the buttons in the template.","example":["button_value_1","button_value_2"],"type":"array","items":{"type":"string"}}},"required":["values"]},"StepElementContentMetaWhatsAppTemplateDto":{"type":"object","properties":{"templateName":{"type":"string","description":"The name of the Meta WhatsApp template.","example":"order_confirmation"},"templateId":{"type":"string","description":"The ID of the Meta WhatsApp template.","example":"meta_tpl_123"},"header":{"description":"Header configuration for the Meta WhatsApp template.","allOf":[{"$ref":"#/components/schemas/StepElementContentMetaWhatsAppTemplateHeaderDto"}]},"bodyParameters":{"description":"Parameters for the body of the Meta WhatsApp template.","example":["{{1}}","Order Number"],"type":"array","items":{"type":"string"}},"buttons":{"description":"Button configurations for the Meta WhatsApp template.","allOf":[{"$ref":"#/components/schemas/StepElementContentMetaWhatsAppTemplateButtonsDto"}]}},"required":["templateName","templateId","bodyParameters"]},"StepElementContentNoteDto":{"type":"object","properties":{"note":{"type":"string","description":"A private note for internal use.","example":"Follow up with customer next week."}},"required":["note"]},"StepElementContentChatEnd_ConversationStatus":{"type":"number","enum":[0,1,2,3,-1],"description":"The status to set for the conversation.\n\n- `0`: OPEN\n- `1`: BOT\n- `2`: IN_PROGRESS\n- `3`: CLOSED"},"StepElementContentChatEndDto":{"type":"object","properties":{"status":{"description":"The status to set for the conversation.\n\n- `0`: OPEN\n- `1`: BOT\n- `2`: IN_PROGRESS\n- `3`: CLOSED","example":3,"allOf":[{"$ref":"#/components/schemas/StepElementContentChatEnd_ConversationStatus"}]}},"required":["status"]},"StepElementContentAssignTeamDto":{"type":"object","properties":{"teamId":{"type":"string","description":"The ID of the team to assign the conversation to.","example":"team_sales"}},"required":["teamId"]},"StepElementContentAssignOperatorDto":{"type":"object","properties":{"operatorId":{"type":"string","description":"The ID of the operator to assign the conversation to.","example":"operator_john"},"assignToLastAssigned":{"type":"boolean","description":"Whether to assign to the last assigned operator.","example":true}},"required":["assignToLastAssigned"]},"StepElementContentDto":{"type":"object","properties":{"text":{"description":"Text content for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentTextDto"}]},"buttons":{"description":"Button content for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentButtonDto"}]},"file":{"description":"File content for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentFileDto"}]},"voiceHangup":{"description":"Voice hangup action for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentVoiceHangupDto"}]},"voiceTransfer":{"description":"Voice transfer action for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentVoiceTransferDto"}]},"agentHandover":{"description":"Agent handover action for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentAgentHandoverDto"}]},"assignVariable":{"description":"Assign variable action for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentAssignVariableDto"}]},"updateTags":{"description":"Update tags action for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentUpdateTagsDto"}]},"snooze":{"description":"Snooze action for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentSnoozeDto"}]},"unread":{"description":"Unread action for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentUnreadDto"}]},"whatsappTemplate":{"description":"WhatsApp template content for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentWhatsAppTemplateDto"}]},"textToSpeech":{"description":"Text-to-speech content for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentTextToSpeechDto"}]},"callSettings":{"description":"Call settings for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentCallSettingsDto"}]},"metaWhatsappTemplate":{"description":"Meta WhatsApp template content for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentMetaWhatsAppTemplateDto"}]},"note":{"description":"Note content for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentNoteDto"}]},"chatEnd":{"description":"Chat end action for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentChatEndDto"}]},"assignTeam":{"description":"Assign team action for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentAssignTeamDto"}]},"assignOperator":{"description":"Assign operator action for the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentAssignOperatorDto"}]}}},"StepElementDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the step element (e.g., 'text', 'buttons').","example":"text"},"content":{"description":"The content of the step element.","allOf":[{"$ref":"#/components/schemas/StepElementContentDto"}]}},"required":["type","content"]},"StepIntentDto":{"type":"object","properties":{"intentId":{"type":"string","description":"The ID of the associated intent.","example":"t8gsDajqeJAVMZQPB5mp"}},"required":["intentId"]},"StepDelayDto":{"type":"object","properties":{"seconds":{"type":"number","description":"The waiting time in seconds.","example":5}},"required":["seconds"]},"StepSplitRedirectsDto":{"type":"object","properties":{"a":{"type":"string","description":"The step ID for redirect A.","example":"flow/AAIVrMmsvmfYYeR4xo69/step/vnClGd8WHu3f4KY6dVYL"},"b":{"type":"string","description":"The step ID for redirect B.","example":"flow/vnClGd8WHu3f4KY6dVYL/step/AAIVrMmsvmfYYeR4xo69"}},"required":["a","b"]},"StepSplitDto":{"type":"object","properties":{"a":{"type":"number","description":"Percentage for exit A.","example":50},"b":{"type":"number","description":"Percentage for exit B.","example":50},"sameRedirect":{"type":"boolean","description":"Indicates whether both exits should lead to the same destination.","example":false},"redirects":{"description":"The redirect configurations for split A and B.","allOf":[{"$ref":"#/components/schemas/StepSplitRedirectsDto"}]}},"required":["a","b","sameRedirect","redirects"]},"StepConditionRedirectsDto":{"type":"object","properties":{"t":{"type":"string","description":"The step ID to redirect to if the condition is true.","example":"stepTrue"},"f":{"type":"string","description":"The step ID to redirect to if the condition is false.","example":"stepFalse"}},"required":["t","f"]},"StepConditionConditionDto":{"type":"object","properties":{"valueLeft":{"type":"string","description":"The left-hand side value for the condition.","example":"{{variable.name}}"},"operator":{"type":"string","description":"The operator for the condition (e.g., '==', '>', '<').","example":"=="},"valueRight":{"type":"string","description":"The right-hand side value for the condition.","example":"some_value"},"group":{"type":"number","description":"The group number for logical grouping of conditions.","example":1}},"required":["valueLeft","operator","valueRight","group"]},"StepConditionDto":{"type":"object","properties":{"redirects":{"description":"The redirect configurations based on condition outcome.","allOf":[{"$ref":"#/components/schemas/StepConditionRedirectsDto"}]},"conditions":{"description":"A list of conditions to evaluate.","type":"array","items":{"$ref":"#/components/schemas/StepConditionConditionDto"}}},"required":["redirects","conditions"]},"StepFlowDto":{"type":"object","properties":{"outlets":{"type":"object","description":"Outlets of the flow, mapping names to step IDs.","additionalProperties":{"$ref":"#/components/schemas/StepFlowOutletDto"},"example":{"success":{"stepId":"stepSuccess","name":"Success"}}},"flowId":{"type":"string","description":"The ID of the flow to execute.","example":"flowABC"},"entryStepId":{"type":"string","description":"The ID of the entry step within the flow.","example":"entryStep1"},"redirects":{"type":"object","description":"Redirects based on flow outcomes.","additionalProperties":{"type":"string"},"example":{"complete":"stepComplete"}}},"required":["outlets","flowId","entryStepId","redirects"]},"StepTriggerDto":{"type":"object","properties":{"triggerId":{"type":"string","description":"The unique identifier of the trigger.","example":"gVh98q1ILzabR51miQbH"},"event":{"type":"string","description":"The triggering event.","example":"user_subscribed"},"payload":{"type":"string","description":"An optional payload value required for triggering.","example":"premium_plan"}},"required":["triggerId","event"]},"StepContextIntentDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the intent.","example":"GreetingIntent"},"intentId":{"type":"string","description":"The ID of the intent.","example":"intent456"},"redirect":{"type":"string","description":"The step ID to redirect to if this intent is matched.","example":"step789"}},"required":["name","intentId"]},"StepContextDto":{"type":"object","properties":{"intents":{"description":"A list of intents to consider in this context.","type":"array","items":{"$ref":"#/components/schemas/StepContextIntentDto"}},"fallbackRedirect":{"type":"string","description":"The step ID to redirect to if no intent is matched.","example":"stepFallback"}},"required":["intents"]},"StepAppDto":{"type":"object","properties":{"appId":{"type":"string","description":"The ID of the app to integrate.","example":"appCRM"},"moduleId":{"type":"string","description":"The ID of the module within the app to execute.","example":"moduleCreateLead"},"paramsJson":{"type":"string","format":"json","description":"Parameters for the app module in JSON format.","example":"{\"leadName\": \"{{variable.name}}\"}"}},"required":["appId","moduleId","paramsJson"]},"StepEntityDetectionExampleDto":{"type":"object","properties":{"value":{"type":"string","description":"The example input value.","example":"I want to book a flight to London."},"result":{"type":"string","description":"The expected result of entity detection for the example.","example":"{'city': 'London'}"}},"required":["value","result"]},"StepEntityDetectionDto":{"type":"object","properties":{"outputVariableId":{"type":"string","description":"The ID of the variable to store the detected entities.","example":"varDetectedEntities"},"outputVariablePath":{"type":"string","description":"Optional JSON path within the output variable.","example":"$.entities"},"prompt":{"type":"string","description":"The prompt for entity detection.","example":"Extract entities from: {{user_input}}"},"examples":{"description":"Examples for entity detection.","type":"array","items":{"$ref":"#/components/schemas/StepEntityDetectionExampleDto"}}},"required":["outputVariableId","prompt","examples"]},"StepRunPromptDto":{"type":"object","properties":{"outputVariableId":{"type":"string","description":"The ID of the variable to store the prompt's output.","example":"varPromptOutput"},"outputVariablePath":{"type":"string","description":"Optional JSON path within the output variable.","example":"$.response"},"prompt":{"type":"string","description":"The prompt to run.","example":"Generate a summary of the conversation."},"includeConversationHistory":{"type":"boolean","description":"Whether to include conversation history in the prompt.","example":true},"useRag":{"type":"boolean","description":"Whether to use RAG (Retrieval Augmented Generation).","example":true},"includeNotes":{"type":"boolean","description":"Whether to use notes in prompt context.","example":true},"knowledgeGroupIds":{"description":"List of knowledge group IDs for RAG.","example":["kg1","kg2"],"type":"array","items":{"type":"string"}},"ragContextMessages":{"type":"number","description":"Number of context messages for RAG.","example":5},"contextMessageCount":{"type":"number","description":"Number of messages to include in the context.","example":10}},"required":["outputVariableId","prompt","knowledgeGroupIds"]},"StepLeadAiConversationOutletDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the conversation outlet.","example":"BookFlight"},"description":{"type":"string","description":"A description of what this outlet does.","example":"Books a flight for the user."},"redirect":{"type":"string","description":"The step ID to redirect to when this outlet is triggered.","example":"stepBookFlight"}},"required":["name","description"]},"StepLeadAiConversationToolDto":{"type":"object","properties":{"appId":{"type":"string","description":"The ID of the app associated with the tool.","example":"app123"},"moduleId":{"type":"string","description":"The ID of the module within the app.","example":"module456"},"description":{"type":"string","description":"A description of what the tool does.","example":"Searches for available flights."},"name":{"type":"string","pattern":"/^[a-zA-Z][a-zA-Z0-9_]*$/","description":"The name of the tool.","example":"FlightSearchTool"}},"required":["appId","moduleId","description","name"]},"StepLeadAiConversationDto":{"type":"object","properties":{"prompt":{"type":"string","description":"The initial prompt for the AI conversation.","example":"Help the user book a flight."},"context":{"type":"string","description":"Additional context for the AI conversation.","example":"User wants to travel to Paris."},"maxIterations":{"type":"number","description":"The maximum number of iterations for the AI conversation.","example":5},"ragContextMessages":{"type":"number","description":"Number of context messages for RAG.","example":5},"includeConversationHistory":{"type":"boolean","description":"Whether to include conversation history.","example":true},"outlets":{"description":"Outlets for different conversation paths.","type":"array","items":{"$ref":"#/components/schemas/StepLeadAiConversationOutletDto"}},"tools":{"description":"Tools available to the AI during the conversation.","type":"array","items":{"$ref":"#/components/schemas/StepLeadAiConversationToolDto"}},"useRag":{"type":"boolean","description":"Whether to use RAG (Retrieval Augmented Generation).","example":true},"delayMin":{"type":"number","description":"Minimum delay in seconds before the next AI response.","example":10},"delayMax":{"type":"number","description":"Maximum delay in seconds before the next AI response.","example":20},"delay":{"type":"boolean","description":"Whether to apply a delay before the next AI response.","example":true},"knowledgeGroupIds":{"description":"List of knowledge group IDs for RAG.","example":["kg_flights","kg_destinations"],"type":"array","items":{"type":"string"}},"contextMessageCount":{"type":"number","description":"Number of messages to include in the context.","example":10}},"required":["prompt","maxIterations","outlets","tools","knowledgeGroupIds"]},"StepContactDataDto":{"type":"object","properties":{"values":{"type":"string","description":"The values to set for contact data.","example":"{\"email\": \"user@example.com\"}"}},"required":["values"]},"StepAiConfigDto":{"type":"object","properties":{"model":{"type":"number","description":"The AI model to use.\n\n- `1`: GEMINI_25_FLASH","enum":[1],"example":1},"thinkingBudget":{"type":"number","description":"Budget for the \"thinking\" process in tokens.","example":256},"seed":{"type":"number","description":"Seed for reproducible results.","example":42},"topP":{"type":"number","description":"Top-P value for generation.","example":0.9},"temperature":{"type":"number","description":"Temperature for generation creativity.","example":0.8}},"required":["model"]},"StepDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the step.","example":"step123"},"name":{"type":"string","description":"The name of the step.","example":"Welcome Message"},"created":{"type":"string","description":"The creation timestamp of the step.","example":"2023-01-01T12:00:00Z"},"updated":{"type":"string","description":"The last update timestamp of the step.","example":"2023-01-01T12:30:00Z"},"type":{"type":"string","description":"The type of the step (e.g., 'start', 'message', 'condition').","example":"message"},"grid":{"description":"Grid coordinates for visual placement in the editor.","allOf":[{"$ref":"#/components/schemas/StepGridDto"}]},"elements":{"description":"A list of elements within this step.","type":"array","items":{"$ref":"#/components/schemas/StepElementDto"}},"intent":{"description":"Optional intent configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepIntentDto"}]},"delay":{"description":"Optional delay configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepDelayDto"}]},"split":{"description":"Optional split configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepSplitDto"}]},"condition":{"description":"Optional condition configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepConditionDto"}]},"flow":{"description":"Optional flow execution configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepFlowDto"}]},"trigger":{"description":"Optional trigger configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepTriggerDto"}]},"redirect":{"type":"string","description":"Optional step ID to redirect to.","example":"redirectStep456"},"userInput":{"type":"string","description":"Optional user input prompt.","example":"Please enter your name."},"userInputRequired":{"type":"boolean","description":"Whether user input is required for this step.","example":true},"context":{"description":"Optional context configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepContextDto"}]},"app":{"description":"Optional app integration configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepAppDto"}]},"description":{"type":"string","description":"An optional description for the step.","example":"This step greets the user and asks for their name."},"entityDetection":{"description":"Optional entity detection configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepEntityDetectionDto"}]},"userInputIsSensitive":{"type":"boolean","description":"Whether user input in this step is sensitive.","example":false},"runPrompt":{"description":"Optional run prompt configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepRunPromptDto"}]},"leadAiConversation":{"description":"Optional Lead AI conversation configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepLeadAiConversationDto"}]},"contactData":{"description":"Optional contact data configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepContactDataDto"}]},"aiConfig":{"description":"Optional AI configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepAiConfigDto"}]}},"required":["id","name","created","updated","type","grid","elements"]},"ListStepsResponseDto":{"type":"object","properties":{"steps":{"description":"A list of steps.","type":"array","items":{"$ref":"#/components/schemas/StepDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["steps"]},"GetStepResponseDto":{"type":"object","properties":{"step":{"description":"The retrieved step.","allOf":[{"$ref":"#/components/schemas/StepDto"}]},"error":{"type":"string","description":"Optional error message."}}},"UpdateOrCreateStepTriggerDto":{"type":"object","properties":{"event":{"type":"string","description":"The triggering event.","example":"user_subscribed"},"payload":{"type":"string","description":"An optional payload value required for triggering.","example":"premium_plan"}},"required":["event"]},"StepConversationDataDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the conversation.","example":"Customer request"},"language":{"type":"string","description":"The language of the conversation.","example":"DE"}},"required":["name","language"]},"CreateStepRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the step.","example":"Initial Greeting"},"type":{"type":"string","description":"The type of the step.","example":"message"},"grid":{"description":"Grid coordinates for visual placement.","allOf":[{"$ref":"#/components/schemas/StepGridDto"}]},"elements":{"description":"A list of elements to include in the step.","default":[],"type":"array","items":{"$ref":"#/components/schemas/StepElementDto"}},"delay":{"description":"Optional delay configuration.","allOf":[{"$ref":"#/components/schemas/StepDelayDto"}]},"split":{"description":"Optional split configuration.","allOf":[{"$ref":"#/components/schemas/StepSplitDto"}]},"condition":{"description":"Optional condition configuration.","allOf":[{"$ref":"#/components/schemas/StepConditionDto"}]},"trigger":{"description":"Optional trigger configuration.","allOf":[{"$ref":"#/components/schemas/UpdateOrCreateStepTriggerDto"}]},"redirect":{"type":"string","description":"Optional step ID to redirect to.","example":"redirectStepABC"},"context":{"description":"Optional context configuration.","allOf":[{"$ref":"#/components/schemas/StepContextDto"}]},"app":{"description":"Optional app integration configuration.","allOf":[{"$ref":"#/components/schemas/StepAppDto"}]},"entityDetection":{"description":"Optional entity detection configuration.","allOf":[{"$ref":"#/components/schemas/StepEntityDetectionDto"}]},"description":{"type":"string","description":"An optional description for the step.","example":"This step welcomes the user."},"flow":{"description":"Optional flow execution configuration.","allOf":[{"$ref":"#/components/schemas/StepFlowDto"}]},"runPrompt":{"description":"Optional run prompt configuration.","allOf":[{"$ref":"#/components/schemas/StepRunPromptDto"}]},"leadAiConversation":{"description":"Optional Lead AI conversation configuration.","allOf":[{"$ref":"#/components/schemas/StepLeadAiConversationDto"}]},"contactData":{"description":"Optional contact data configuration.","allOf":[{"$ref":"#/components/schemas/StepContactDataDto"}]},"aiConfig":{"description":"Optional AI configuration.","allOf":[{"$ref":"#/components/schemas/StepAiConfigDto"}]},"conversationData":{"description":"Optional conversation data.","allOf":[{"$ref":"#/components/schemas/StepConversationDataDto"}]}},"required":["name","type","grid","elements"]},"StepResponseDto":{"type":"object","properties":{"step":{"description":"The retrieved step.","allOf":[{"$ref":"#/components/schemas/StepDto"}]}}},"UpdateStepRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the step.","example":"Updated Welcome Message"},"grid":{"description":"New grid coordinates for visual placement.","allOf":[{"$ref":"#/components/schemas/StepGridDto"}]},"elements":{"description":"A list of elements to update in the step.","default":[],"type":"array","items":{"$ref":"#/components/schemas/StepElementDto"}},"delay":{"description":"Optional delay configuration.","allOf":[{"$ref":"#/components/schemas/StepDelayDto"}]},"split":{"description":"Optional split configuration.","allOf":[{"$ref":"#/components/schemas/StepSplitDto"}]},"condition":{"description":"Optional condition configuration.","allOf":[{"$ref":"#/components/schemas/StepConditionDto"}]},"flow":{"description":"Optional flow execution configuration.","allOf":[{"$ref":"#/components/schemas/StepFlowDto"}]},"trigger":{"description":"Optional trigger configuration.","allOf":[{"$ref":"#/components/schemas/UpdateOrCreateStepTriggerDto"}]},"redirect":{"type":"string","description":"Optional step ID to redirect to.","example":"flowId/stepId"},"userInput":{"type":"string","description":"Optional user input redirect.","example":"flowId/stepId."},"userInputRequired":{"type":"boolean","description":"Whether user input is required for this step.","example":false},"context":{"description":"Optional context configuration.","allOf":[{"$ref":"#/components/schemas/StepContextDto"}]},"app":{"description":"Optional app integration configuration.","allOf":[{"$ref":"#/components/schemas/StepAppDto"}]},"entityDetection":{"description":"Optional entity detection configuration.","allOf":[{"$ref":"#/components/schemas/StepEntityDetectionDto"}]},"description":{"type":"string","description":"An optional description for the step.","example":"This step updates user information."},"userInputIsSensitive":{"type":"boolean","description":"Whether user input in this step is sensitive.","example":true},"runPrompt":{"description":"Optional run prompt configuration.","allOf":[{"$ref":"#/components/schemas/StepRunPromptDto"}]},"leadAiConversation":{"description":"Optional Lead AI conversation configuration.","allOf":[{"$ref":"#/components/schemas/StepLeadAiConversationDto"}]},"intent":{"description":"Optional intent configuration for the step.","allOf":[{"$ref":"#/components/schemas/StepIntentDto"}]},"contactData":{"description":"Optional contact data configuration.","allOf":[{"$ref":"#/components/schemas/StepContactDataDto"}]},"aiConfig":{"description":"Optional AI configuration.","allOf":[{"$ref":"#/components/schemas/StepAiConfigDto"}]},"conversationData":{"description":"Optional conversation data.","allOf":[{"$ref":"#/components/schemas/StepConversationDataDto"}]}},"required":["elements"]},"DeleteStepResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates if the step was successfully deleted.","example":true},"error":{"type":"string","description":"Optional error message."}},"required":["deleted"]},"CompositionSettingsDto":{"type":"object","properties":{"combineComponents":{"type":"string","description":"How to combine components.","example":"combine"},"requireExactOverlap":{"type":"string","description":"Whether to require exact overlap.","example":"exact"},"returnLongestOverlap":{"type":"string","description":"Whether to return the longest overlap.","example":"longest"},"separateComponents":{"type":"string","description":"How to separate components.","example":"separate"}},"required":["combineComponents","requireExactOverlap","returnLongestOverlap","separateComponents"]},"ListComponentSynonymDto":{"type":"object","properties":{"language":{"type":"string","description":"The language code for the synonyms.","example":"EN-GB"},"values":{"description":"A list of synonymous values.","example":["Order","Shipment"],"type":"array","items":{"type":"string"}}},"required":["language","values"]},"ListComponentListEntryDto":{"type":"object","properties":{"listKey":{"type":"string","description":"The key for this list entry.","example":"Order"},"synonyms":{"description":"A list of synonyms for this entry.","type":"array","items":{"$ref":"#/components/schemas/ListComponentSynonymDto"}}},"required":["listKey","synonyms"]},"ListComponentDto":{"type":"object","properties":{"sublists":{"description":"A list of sublists for the entity.","type":"array","items":{"$ref":"#/components/schemas/ListComponentListEntryDto"}}},"required":["sublists"]},"PrebuiltsComponentDto":{"type":"object","properties":{"category":{"type":"string","description":"Category of the predefined entity.","example":"Quantity.Number"}},"required":["category"]},"RegexComponentExpressionDto":{"type":"object","properties":{"regexKey":{"type":"string","description":"The key for this regular expression.","example":"ORDER_NUMBER_REGEX"},"language":{"type":"string","description":"The language code for this regular expression.","example":"DE"},"regexPattern":{"type":"string","description":"The regular expression pattern.","example":"[A-Z]{2,}\\d{5,}"}},"required":["regexKey","language","regexPattern"]},"RegexComponentDto":{"type":"object","properties":{"expressions":{"description":"A list of regular expressions for the entity.","type":"array","items":{"$ref":"#/components/schemas/RegexComponentExpressionDto"}}},"required":["expressions"]},"EntityDto":{"type":"object","properties":{"category":{"type":"string","description":"The category or name of the entity.","example":"Order"},"compositionSettings":{"description":"Settings for how entity components are combined.","allOf":[{"$ref":"#/components/schemas/CompositionSettingsDto"}]},"list":{"description":"List component for the entity.","allOf":[{"$ref":"#/components/schemas/ListComponentDto"}]},"prebuilts":{"description":"Pre-built components for the entity.","type":"array","items":{"$ref":"#/components/schemas/PrebuiltsComponentDto"}},"regex":{"description":"Regex component for the entity.","allOf":[{"$ref":"#/components/schemas/RegexComponentDto"}]},"requiredComponents":{"description":"A list of required component keys.","example":["list","prebuilts"],"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"The unique identifier of the entity.","example":"59aBv7wzR9cxd1Pxyz"},"created":{"type":"string","description":"The creation timestamp of the entity.","example":"2025-10-02T08:00:00Z"},"updated":{"type":"string","description":"The last update timestamp of the entity.","example":"2025-10-02T08:05:00Z"},"editable":{"type":"boolean","description":"Indicates whether the entity is editable.","example":true},"enabled":{"type":"boolean","description":"Indicates whether the entity is enabled.","example":true},"variableId":{"type":"string","description":"The ID of the variable associated with this entity.","example":"Kq8BxZaJd2wZR9cxd1P"}},"required":["category","prebuilts","requiredComponents","id","created","updated","editable","enabled","variableId"]},"ListEntitiesResponseDto":{"type":"object","properties":{"entities":{"description":"A list of entities.","type":"array","items":{"$ref":"#/components/schemas/EntityDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["entities"]},"EntityResponseDto":{"type":"object","properties":{"entity":{"description":"The retrieved entity.","allOf":[{"$ref":"#/components/schemas/EntityDto"}]},"error":{"type":"string","description":"Optional error message."}}},"EntityPayloadDto":{"type":"object","properties":{"category":{"type":"string","description":"The category or name of the entity.","example":"Order"},"compositionSettings":{"description":"Settings for how entity components are combined.","allOf":[{"$ref":"#/components/schemas/CompositionSettingsDto"}]},"list":{"description":"List component for the entity.","allOf":[{"$ref":"#/components/schemas/ListComponentDto"}]},"prebuilts":{"description":"Pre-built components for the entity.","type":"array","items":{"$ref":"#/components/schemas/PrebuiltsComponentDto"}},"regex":{"description":"Regex component for the entity.","allOf":[{"$ref":"#/components/schemas/RegexComponentDto"}]},"requiredComponents":{"description":"A list of required component keys.","example":["list","prebuilts"],"type":"array","items":{"type":"string"}}},"required":["category","prebuilts","requiredComponents"]},"CreateEntityRequestDto":{"type":"object","properties":{"entity":{"description":"The entity object to be created.","allOf":[{"$ref":"#/components/schemas/EntityPayloadDto"}]}},"required":["entity"]},"UpdateEntityRequestDto":{"type":"object","properties":{"entity":{"description":"The object containing the entity fields to be updated.","allOf":[{"$ref":"#/components/schemas/EntityPayloadDto"}]}},"required":["entity"]},"SetEntityStateRequestDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Sets the entity to enabled (true) or disabled (false).","example":true}},"required":["enabled"]},"DeleteEntityResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the deletion operation was successful.","example":true},"error":{"type":"string","description":"Optional error message."}},"required":["deleted"]},"FlowParentDto":{"type":"object","properties":{"flowId":{"type":"string","description":"The ID of the parent flow.","example":"Kq8BxZaJd2wZR9cxd1P"},"stepId":{"type":"string","description":"The ID of the step in the parent flow that calls this sub-flow.","example":"59aBv7wzR9cxd1Pxyz"}},"required":["flowId","stepId"]},"FlowDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the flow.","example":"Kq8BxZaJd2wZR9cxd1P"},"name":{"type":"string","description":"The name of the flow.","example":"Order Process"},"created":{"type":"string","description":"The creation timestamp of the flow.","example":"2025-10-02T14:00:00Z"},"updated":{"type":"string","description":"The last update timestamp of the flow.","example":"2025-10-02T14:05:00Z"},"type":{"type":"string","description":"The type of the flow (e.g., \"default\", \"faq\").","example":"default"},"parent":{"description":"Information about the parent flow, if this is a sub-flow.","allOf":[{"$ref":"#/components/schemas/FlowParentDto"}]},"isStandard":{"type":"boolean","description":"Indicates whether the flow is a standard flow or not.","example":"false"}},"required":["id","name","created","updated","type"]},"ListFlowsResponseDto":{"type":"object","properties":{"flows":{"description":"A list of flows.","type":"array","items":{"$ref":"#/components/schemas/FlowDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["flows"]},"GetFlowResponseDto":{"type":"object","properties":{"flow":{"description":"The flow object.","allOf":[{"$ref":"#/components/schemas/FlowDto"}]},"error":{"type":"string","description":"Optional error message."}}},"CreateFlowRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the new flow.","example":"Return Process"},"parentFlowId":{"type":"string","description":"The ID of the parent flow, if a sub-flow is being created.","example":"Kq8BxZaJd2wZR9cxd1P"},"parentStepId":{"type":"string","description":"The ID of the step in the parent flow, if a sub-flow is being created.","example":"59aBv7wzR9cxd1Pxyz"},"isStandard":{"type":"boolean","description":"Indicates whether the flow is a standard flow or not.","example":"false"}},"required":["name"]},"FlowResponseDto":{"type":"object","properties":{"flow":{"description":"The flow object.","allOf":[{"$ref":"#/components/schemas/FlowDto"}]}}},"UpdateFlowRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the flow.","example":"Returns & Exchange Process"},"parentFlowId":{"type":"string","description":"The new ID of the parent flow, if a sub-flow is being updated.","example":"Kq8BxZaJd2wZR9cxd1P"},"parentStepId":{"type":"string","description":"The new ID of the step in the parent flow, if a sub-flow is being updated.","example":"59aBv7wzR9cxd1Pxyz"}}},"DeleteFlowResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the deletion operation was successful.","example":true}},"required":["deleted"]},"LanguagesDto":{"type":"object","properties":{"updated":{"type":"string","description":"The last update timestamp for the language settings.","example":"2025-10-02T16:00:00Z"},"languages":{"description":"A list of currently enabled language codes.","example":["DE","EN-GB"],"type":"array","items":{"type":"string"}},"defaultLanguage":{"type":"string","description":"The default language code for the chatbot.","example":"DE"},"translate":{"type":"boolean","description":"Indicates whether translation mode is enabled.","example":true},"defaultCluLanguage":{"type":"string","description":"The default language for the CLU (optional).","example":"DE"}},"required":["updated","languages","defaultLanguage","translate"]},"LanguagesResponseDto":{"type":"object","properties":{"languages":{"description":"The language settings object.","allOf":[{"$ref":"#/components/schemas/LanguagesDto"}]},"error":{"type":"string","description":"Optional error message."}}},"AddLanguagesRequestDto":{"type":"object","properties":{"languages":{"minItems":1,"description":"A list of language codes to be added.","example":["DE","EN-GB"],"type":"array","items":{"type":"string"}}},"required":["languages"]},"UpdateTranslationModeDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enables or disables the automatic translation mode.","example":true}},"required":["enabled"]},"UpdateTranslationModeResponseDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"The new state of the translation mode.","example":true},"error":{"type":"string","description":"Optional error message."}}},"RemoveLanguagesRequestDto":{"type":"object","properties":{"languages":{"minItems":1,"description":"A list of language codes to be removed.","example":["FR"],"type":"array","items":{"type":"string"}}},"required":["languages"]},"ModelStatusDto":{"type":"object","properties":{"status":{"type":"string","description":"The status of the model training/evaluation.","example":"Succeeded"},"percentComplete":{"type":"number","description":"The completion percentage of the process.","example":100},"startDateTime":{"type":"string","description":"The start time of the process.","example":"2025-10-02T10:00:00Z"},"endDateTime":{"type":"string","description":"The end time of the process.","example":"2025-10-02T10:15:00Z"}},"required":["status","percentComplete"]},"ModelDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the model.","example":"modl_59aBv7wzR9cxd1Pxyz"},"name":{"type":"string","description":"The name of the model.","example":"2025-10-02_de"},"created":{"type":"string","description":"The creation timestamp of the model.","example":"2025-10-02T10:00:00Z"},"updated":{"type":"string","description":"The last update timestamp of the model.","example":"2025-10-02T10:15:00Z"},"trainingStatus":{"description":"The training status of the model.","allOf":[{"$ref":"#/components/schemas/ModelStatusDto"}]},"evaluationStatus":{"description":"The evaluation status of the model.","allOf":[{"$ref":"#/components/schemas/ModelStatusDto"}]},"estimatedEndDateTime":{"type":"string","description":"The estimated end time of the current process.","example":"2025-10-02T10:20:00Z"},"cluJobId":{"type":"string","description":"The job ID from the CLU service.","example":"clu-job-123"},"trainingMode":{"type":"string","description":"The training mode used for the model.","example":"standard"},"state":{"type":"string","description":"The current state of the model.","example":"trained"},"cluModelId":{"type":"string","description":"The model ID from the CLU service.","example":"clu-model-456"},"lastTrainingDurationInSeconds":{"type":"number","description":"The duration of the last training in seconds.","example":900},"lastTrainedDateTime":{"type":"string","description":"The timestamp of the last training.","example":"2025-10-02T10:15:00Z"},"expirationDate":{"type":"string","description":"The expiration date of the model.","example":"2026-10-02T10:15:00Z"},"modelTrainingConfigVersion":{"type":"string","description":"The version of the model training configuration.","example":"v2"},"enoughExamples":{"type":"boolean","description":"Indicates if there are enough examples for training.","example":true}},"required":["id","name","created","updated","trainingStatus","evaluationStatus","cluJobId","trainingMode","state"]},"ListModelsResponseDto":{"type":"object","properties":{"models":{"description":"A list of models.","type":"array","items":{"$ref":"#/components/schemas/ModelDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["models"]},"GetModelResponseDto":{"type":"object","properties":{"model":{"description":"The retrieved model.","nullable":true,"allOf":[{"$ref":"#/components/schemas/ModelDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["model"]},"LabelsExamplesDistributionDto":{"type":"object","properties":{"train":{"type":"number","description":"The number of training examples.","example":80},"test":{"type":"number","description":"The number of testing examples.","example":20}},"required":["train","test"]},"EntityCluEvaluationDto":{"type":"object","properties":{"entityName":{"type":"string","description":"The name of the entity.","example":"Location"},"labelsDistribution":{"description":"The distribution of labels for this entity.","allOf":[{"$ref":"#/components/schemas/LabelsExamplesDistributionDto"}]},"examplesDistribution":{"description":"The distribution of examples for this entity.","allOf":[{"$ref":"#/components/schemas/LabelsExamplesDistributionDto"}]}},"required":["entityName","labelsDistribution","examplesDistribution"]},"IntentCluEvaluationDto":{"type":"object","properties":{"intentName":{"type":"string","description":"The name of the intent.","example":"GetWeather"},"labelsDistribution":{"description":"The distribution of labels for this intent.","allOf":[{"$ref":"#/components/schemas/LabelsExamplesDistributionDto"}]}},"required":["intentName","labelsDistribution"]},"DistributionDto":{"type":"object","properties":{"labelsDistribution":{"description":"The overall distribution of labels.","allOf":[{"$ref":"#/components/schemas/LabelsExamplesDistributionDto"}]},"entities":{"description":"The evaluation distribution for each entity.","type":"array","items":{"$ref":"#/components/schemas/EntityCluEvaluationDto"}},"intents":{"description":"The evaluation distribution for each intent.","type":"array","items":{"$ref":"#/components/schemas/IntentCluEvaluationDto"}}},"required":["labelsDistribution","entities","intents"]},"EntitiesEvaluationDto":{"type":"object","properties":{"confusionMatrix":{"type":"object","description":"The confusion matrix for entities.","additionalProperties":{"$ref":"#/components/schemas/ConfusionMatrixDto"}},"entities":{"type":"object","description":"The evaluation metrics for each entity.","additionalProperties":{"$ref":"#/components/schemas/EvaluationMetricsDto"}},"microF1":{"type":"number","description":"The micro F1 score.","example":0.95},"microPrecision":{"type":"number","description":"The micro precision score.","example":0.94},"microRecall":{"type":"number","description":"The micro recall score.","example":0.96},"macroF1":{"type":"number","description":"The macro F1 score.","example":0.92},"macroPrecision":{"type":"number","description":"The macro precision score.","example":0.91},"macroRecall":{"type":"number","description":"The macro recall score.","example":0.93}},"required":["confusionMatrix","entities","microF1","microPrecision","microRecall","macroF1","macroPrecision","macroRecall"]},"EvaluationOptionsDto":{"type":"object","properties":{"kind":{"type":"string","description":"The kind of evaluation.","example":"combined"},"trainingSplitPercentage":{"type":"number","description":"The percentage of data used for training.","example":80},"testSplitPercentage":{"type":"number","description":"The percentage of data used for testing.","example":20}},"required":["kind","trainingSplitPercentage","testSplitPercentage"]},"IntentsEvaluationDto":{"type":"object","properties":{"confusionMatrix":{"type":"object","description":"The confusion matrix for intents.","additionalProperties":{"$ref":"#/components/schemas/ConfusionMatrixDto"}},"intents":{"type":"object","description":"The evaluation metrics for each intent.","additionalProperties":{"$ref":"#/components/schemas/EvaluationMetricsDto"}},"microF1":{"type":"number","description":"The micro F1 score.","example":0.95},"microPrecision":{"type":"number","description":"The micro precision score.","example":0.94},"microRecall":{"type":"number","description":"The micro recall score.","example":0.96},"macroF1":{"type":"number","description":"The macro F1 score.","example":0.92},"macroPrecision":{"type":"number","description":"The macro precision score.","example":0.91},"macroRecall":{"type":"number","description":"The macro recall score.","example":0.93}},"required":["confusionMatrix","intents","microF1","microPrecision","microRecall","macroF1","macroPrecision","macroRecall"]},"ModelEvaluationDto":{"type":"object","properties":{"projectKind":{"type":"string","description":"The kind of the project.","example":"classification"},"distribution":{"description":"The distribution of data.","allOf":[{"$ref":"#/components/schemas/DistributionDto"}]},"entitiesEvaluation":{"description":"The evaluation of entities.","allOf":[{"$ref":"#/components/schemas/EntitiesEvaluationDto"}]},"evaluationOptions":{"description":"The options used for evaluation.","allOf":[{"$ref":"#/components/schemas/EvaluationOptionsDto"}]},"intentsEvaluation":{"description":"The evaluation of intents.","allOf":[{"$ref":"#/components/schemas/IntentsEvaluationDto"}]},"modelGuidance":{"type":"object","description":"Detailed guidelines for model improvement."}},"required":["projectKind","distribution","entitiesEvaluation","evaluationOptions","intentsEvaluation","modelGuidance"]},"GetModelEvaluationResponseDto":{"type":"object","properties":{"evaluation":{"description":"The evaluation of the model.","allOf":[{"$ref":"#/components/schemas/ModelEvaluationDto"}]},"error":{"type":"string","description":"Optional error message."}}},"TrainingRequiredResponseDto":{"type":"object","properties":{"trainingRequired":{"type":"boolean","description":"Indicates whether retraining is required after changes to intents or examples.","example":true},"error":{"type":"string","description":"Optional error message."}},"required":["trainingRequired"]},"AiFeaturesSettingsDto":{"type":"object","properties":{"completionEnabled":{"type":"boolean","description":"Whether chat completion is enabled.","example":true},"completionPrompt":{"type":"string","description":"The prompt used for chat completion.","example":"Complete the following chat."},"formulationEnabled":{"type":"boolean","description":"Whether chat formulation is enabled.","example":true},"formulationPrompt":{"type":"string","description":"The prompt used for chat formulation.","example":"Rephrase the following chat."},"summaryEnabled":{"type":"boolean","description":"Whether chat summary is enabled.","example":true},"summaryPrompt":{"type":"string","description":"The prompt used for chat summary.","example":"Summarize the following chat."},"updated":{"type":"string","description":"The last time the settings were updated.","example":"2025-09-29T11:05:00Z"},"questionAnsweringEnabled":{"type":"boolean","description":"Whether question answering is enabled.","example":true},"questionAnsweringPrompt":{"type":"string","description":"The prompt used for question answering.","example":"Answer the following question."},"questionAnsweringAiConfig":{"description":"The Ai configuration settings.","allOf":[{"$ref":"#/components/schemas/StepAiConfigDto"}]}},"required":["completionEnabled","completionPrompt","formulationEnabled","formulationPrompt","summaryEnabled","summaryPrompt","updated","questionAnsweringEnabled","questionAnsweringPrompt"]},"AiFeaturesSettingsResponseDto":{"type":"object","properties":{"settings":{"description":"The AI features settings.","allOf":[{"$ref":"#/components/schemas/AiFeaturesSettingsDto"}]},"error":{"type":"string","description":"Optional error message."}}},"UpdateAiFeaturesSettingsDto":{"type":"object","properties":{"completionEnabled":{"type":"boolean","description":"Enables/disables chat completion.","example":true},"completionPrompt":{"type":"string","description":"The prompt for chat completion.","example":"Complete the following chat."},"formulationEnabled":{"type":"boolean","description":"Enables/disables chat rephrasing.","example":true},"formulationPrompt":{"type":"string","description":"The prompt for chat rephrasing.","example":"Rephrase the following chat."},"summaryEnabled":{"type":"boolean","description":"Enables/disables chat summarization.","example":true},"summaryPrompt":{"type":"string","description":"The prompt for chat summarization.","example":"Summarize the following chat."},"questionAnsweringEnabled":{"type":"boolean","description":"Enables/disables question answering.","example":true},"questionAnsweringPrompt":{"type":"string","description":"The prompt for question answering.","example":"Answer the following question."},"questionAnsweringAiConfig":{"description":"Specific AI configuration for question answering.","allOf":[{"$ref":"#/components/schemas/StepAiConfigDto"}]}}},"UpdateAiFeaturesRequestDto":{"type":"object","properties":{"settings":{"description":"The object containing the settings to be updated.","allOf":[{"$ref":"#/components/schemas/UpdateAiFeaturesSettingsDto"}]}},"required":["settings"]},"VersionStatsDto":{"type":"object","properties":{"steps":{"type":"number","description":"The number of steps in this version.","example":42},"events":{"type":"number","description":"The number of events in this version.","example":15},"intents":{"type":"number","description":"The number of intents in this version.","example":28},"entities":{"type":"number","description":"The number of entities in this version.","example":12},"flows":{"type":"number","description":"The number of flows in this version.","example":8},"triggers":{"type":"number","description":"The number of triggers in this version.","example":5}},"required":["steps","events","intents","entities","flows","triggers"]},"VersionDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the version.","example":"By4hQWBaJaRrwvxg5fWz"},"name":{"type":"string","description":"The display name of the version.","example":"Version 1.2.3"},"created":{"type":"string","description":"Timestamp of when the version was created.","example":"2025-10-04T10:00:00Z"},"deployed":{"type":"string","description":"Timestamp of when the version was deployed.","example":"2025-10-04T10:05:00Z"},"modelId":{"type":"string","description":"The ID of the associated model.","example":"modl_Kq8BxZaJd2wZR9cxd1P"},"versionNumber":{"type":"string","description":"The semantic version number.","example":"1.2.3"},"stats":{"description":"Statistics about the version contents.","allOf":[{"$ref":"#/components/schemas/VersionStatsDto"}]},"description":{"type":"string","description":"A description of the version.","example":"Initial release"},"environment":{"type":"string","description":"The environment this version is associated with.","example":"dev","enum":["dev","test","prod"]},"deploymentId":{"type":"string","description":"The ID of the active deployment, if any.","example":"OI03ITtm1nSliNJGJ5HV"},"hasActiveDeployment":{"type":"boolean","description":"Indicates whether the version has an active deployment.","example":true},"resettable":{"type":"boolean","description":"Indicates whether the version can be reset.","example":true}},"required":["id","name","created","deployed","modelId","versionNumber","stats","description","environment","hasActiveDeployment"]},"ListVersionsResponseDto":{"type":"object","properties":{"versions":{"description":"The list of versions.","type":"array","items":{"$ref":"#/components/schemas/VersionDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["versions"]},"CreateVersionRequestDto":{"type":"object","properties":{"description":{"type":"string","description":"An optional description for the new version.","example":"Release for Q4 Campaign"},"name":{"type":"string","description":"The name of the new version (often automatically generated).","example":"Version 1.2.4"},"environment":{"type":"string","description":"The environment for which this version is created. None being dev, as no deployment is needed.","enum":["test","prod","none"],"example":"test"}},"required":["name","environment"]},"VersionResponseDto":{"type":"object","properties":{"version":{"description":"The version.","allOf":[{"$ref":"#/components/schemas/VersionDto"}]},"error":{"type":"string","description":"Optional error message."}}},"DeleteVersionResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the version was successfully deleted.","example":true},"error":{"type":"string","description":"Optional error message."}}},"DeployVersionRequestDto":{"type":"object","properties":{"environment":{"type":"string","description":"The target environment for the deployment.","enum":["test","prod","dev"],"example":"prod"}},"required":["environment"]},"DeployVersionResponseDto":{"type":"object","properties":{"started":{"type":"boolean","description":"Indicates whether the deployment was successfully started.","example":true},"error":{"type":"string","description":"Optional error message."}}},"RollbackVersionComponents":{"type":"number","enum":[0,1,-1],"description":"Components to be excluded from the rollback.\n\n- `0`: Apps\n- `1`: Settings"},"RollbackVersionRequestDto":{"type":"object","properties":{"excludeComponents":{"type":"array","items":{"$ref":"#/components/schemas/RollbackVersionComponents"},"description":"Components to be excluded from the rollback.\n\n- `0`: Apps\n- `1`: Settings","example":[0,1]}},"required":["excludeComponents"]},"RollbackVersionResponseDto":{"type":"object","properties":{"rolledBack":{"type":"boolean","description":"Indicates whether the rollback was successful.","example":true},"error":{"type":"string","description":"Optional error message."}}},"DeploymentStatusDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Deployments.","example":"dply59aBv7wzR9cxd1Pxyz"},"version":{"type":"string","description":"The version number that is deployed.","example":"1.2.3"},"deployed":{"type":"string","description":"The deployment timestamp in ISO format.","example":"2025-09-29T10:00:00Z"},"modelId":{"type":"string","description":"The ID of the model that this version is based on.","example":"modlKq8BxZaJd2wZR9cxd1P"}},"required":["id","version","deployed","modelId"]},"GetActiveDeploymentsStatusResponseDto":{"type":"object","properties":{"test":{"description":"The status of the deployment in the test environment.","allOf":[{"$ref":"#/components/schemas/DeploymentStatusDto"}]},"prod":{"description":"The status of the deployment in the production environment.","allOf":[{"$ref":"#/components/schemas/DeploymentStatusDto"}]},"dev":{"description":"The status of the deployment in the development environment.","allOf":[{"$ref":"#/components/schemas/DeploymentStatusDto"}]},"error":{"type":"string","description":"An optional error message."}}},"GlobalVariableDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the variable.","example":"gS9DWxRHUuRI9yDUjiWw"},"name":{"type":"string","description":"The programmatic name of the variable.","example":"customer_name"},"defaultValue":{"type":"string","description":"The default value of the variable.","example":"Default value"},"category":{"type":"string","description":"The category of the variable (e.g., custom, entity, app).","example":"custom"},"label":{"type":"string","description":"The readable label of the variable.","example":"Customer Name"},"type":{"type":"string","description":"The data type of the variable.","example":"string","enum":["string","number","boolean","object"]},"readonly":{"type":"boolean","description":"Indicates whether the variable is read-only.","example":false},"created":{"type":"string","description":"Timestamp of when the variable was created.","example":"2025-10-04T10:00:00Z"},"updated":{"type":"string","description":"Timestamp of when the variable was last updated.","example":"2025-10-04T10:05:00Z"},"structureJson":{"type":"string","format":"json","description":"A JSON string defining the structure for object variables.","example":"{\"firstName\": \"string\", \"lastName\": \"string\"}"}},"required":["id","name","category","label","type","readonly","created","updated"]},"ListGlobalVariablesResponseDto":{"type":"object","properties":{"variables":{"description":"The list of global variables.","type":"array","items":{"$ref":"#/components/schemas/GlobalVariableDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["variables"]},"GlobalVariableSubCategory":{"type":"number","enum":[0,1,-1],"description":"Sets the subCategory of the variable.\n\n- `0`: GLOBAL_VARIABLE_SUB_CATEGORY_CONVERSATION\n- `1`: GLOBAL_VARIABLE_SUB_CATEGORY_CONTACT"},"CreateGlobalVariableRequestDto":{"type":"object","properties":{"category":{"type":"string","description":"The category of the variable.","example":"custom","enum":["custom"]},"defaultValue":{"type":"string","description":"An optional default value for the variable.","example":"Default Value"},"label":{"type":"string","description":"The human-readable label of the variable.","example":"Customer Email"},"type":{"type":"string","description":"The data type of the variable (e.g., \"string\", \"number\", \"boolean\", \"object\").","example":"string"},"name":{"type":"string","description":"The programmatic name of the variable.","example":"customer_email"},"structureJson":{"type":"string","format":"json","description":"A JSON string defining the structure for object variables.","example":"{\"firstName\": \"string\", \"lastName\": \"string\"}"},"subCategory":{"description":"Sets the subCategory of the variable.\n\n- `0`: GLOBAL_VARIABLE_SUB_CATEGORY_CONVERSATION\n- `1`: GLOBAL_VARIABLE_SUB_CATEGORY_CONTACT","example":0,"allOf":[{"$ref":"#/components/schemas/GlobalVariableSubCategory"}]}},"required":["category","label","type","name","subCategory"]},"GlobalVariableResponseDto":{"type":"object","properties":{"variable":{"description":"The global variable.","allOf":[{"$ref":"#/components/schemas/GlobalVariableDto"}]}}},"UpdateGlobalVariableRequestDto":{"type":"object","properties":{"defaultValue":{"type":"string","description":"The new default value.","example":"Updated Default"},"label":{"type":"string","description":"The new label.","example":"Updated Label"},"name":{"type":"string","description":"The new programmatic name.","example":"updated_variable_name"}}},"DeleteGlobalVariableResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the variable was successfully deleted.","example":true}}},"ExpressionIntentDto":{"type":"object","properties":{"category":{"type":"string","description":"The category/name of the intent.","example":"Order status"},"confidenceScore":{"type":"number","minimum":0,"maximum":1,"description":"The confidence score of the prediction for this intent.","example":0.7}},"required":["category","confidenceScore"]},"ExpressionDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the expression.","example":"59aBv7wzR9cxd1Pxyz"},"created":{"type":"string","description":"The creation timestamp of the expression.","example":"2025-10-02T11:00:00Z"},"expression":{"type":"string","description":"The original text of the user input.","example":"Where is my package?"},"intents":{"description":"List of intents recognized for this expression.","type":"array","items":{"$ref":"#/components/schemas/ExpressionIntentDto"}},"predictedIntentId":{"type":"string","description":"The ID of the intent that was ultimately selected as the prediction.","example":"Kq8BxZaJd2wZR9cxd1P"},"predictionScore":{"type":"number","minimum":0,"maximum":1,"description":"The confidence score of the top prediction.","example":0.95},"requiredIntentPredictionScore":{"type":"number","minimum":0,"maximum":1,"description":"The minimum required confidence score for this intent.","example":0.7},"topIntent":{"description":"The intent with the highest confidence.","allOf":[{"$ref":"#/components/schemas/ExpressionIntentDto"}]},"versionId":{"type":"string","description":"The version ID of the chatbot model.","example":"59aBv7wzR9cxd1Pxyz"},"language":{"type":"string","description":"The language of the expression.","example":"DE"},"conversationId":{"type":"string","description":"The ID of the conversation this expression belongs to.","example":"Kq8BxZaJd2wZR9cxd1P"}},"required":["id","created","expression","intents","predictedIntentId","predictionScore","requiredIntentPredictionScore","topIntent","language","conversationId"]},"ListExpressionsResponseDto":{"type":"object","properties":{"pageToken":{"type":"string","description":"The date of the latest fetched example.","example":"2025-09-29T07:08:00Z"},"expressions":{"description":"A list of expressions.","type":"array","items":{"$ref":"#/components/schemas/ExpressionDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["pageToken","expressions"]},"GetExpressionStatsResponseDto":{"type":"object","properties":{"total":{"type":"number","description":"Total number of expressions.","example":1250},"averagePredictionScore":{"type":"number","minimum":0,"maximum":1,"description":"Average confidence score of all expressions.","example":0.89},"totals":{"type":"object","description":"Distribution of expressions by confidence buckets.","additionalProperties":{"type":"number"},"example":{"80":200,"90":300,"100":500}},"error":{"type":"string","description":"Optional error message."}},"required":["total","averagePredictionScore","totals"]},"DeleteExpressionResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the deletion was successful.","example":true},"error":{"type":"string","description":"Optional error message."}},"required":["deleted"]},"PublicAppDto":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the app.","example":"app59aBv7wzR9cxd1Pxyz"},"versionCount":{"type":"number","description":"Total number of versions for this app.","example":5},"hasApprovedVersion":{"type":"boolean","description":"Indicates whether at least one version has been approved.","example":true},"lastVersionRequested":{"type":"string","description":"Timestamp of the most recent version request (ISO format).","example":"2025-09-28T10:00:00Z"},"lastVersionApproved":{"type":"string","description":"Timestamp of the last approved version (ISO format).","example":"2025-09-29T09:00:00Z"},"name":{"type":"string","description":"Name of the app.","example":"My public assistant"}},"required":["id","versionCount","hasApprovedVersion","lastVersionRequested","name"]},"ListApprovedPublicAppsResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Optional error message."},"publicApps":{"description":"A list of retrieved apps.","type":"array","items":{"$ref":"#/components/schemas/PublicAppDto"}}},"required":["publicApps"]},"AppVersionReleaseState":{"type":"number","enum":[0,1,2,3,4,-1],"description":"The state of the version.\n\n- `0`: IN_QUEUE\n- `1`: IN_PROGRESS\n- `2`: APPROVED\n- `3`: REJECTED\n- `4`: WITHDRAWN"},"AppVersionDto":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the app version.","example":"vrsKq8BxZaJd2wZR9cxd1P"},"name":{"type":"string","description":"The name of the app.","example":"My app"},"owner":{"type":"string","description":"The id of the workspace the app originates from.","example":"ws59aBv7wzR9cxd1Pxyz"},"state":{"description":"The state of the version.\n\n- `0`: IN_QUEUE\n- `1`: IN_PROGRESS\n- `2`: APPROVED\n- `3`: REJECTED\n- `4`: WITHDRAWN","example":2,"allOf":[{"$ref":"#/components/schemas/AppVersionReleaseState"}]},"requested":{"type":"string","description":"Timestamp of when the app versions approval was requested (ISO format).","example":"2025-09-28T10:00:00Z"},"inQueue":{"type":"string","description":"Timestamp of when the version entered the queue (ISO format).","example":"2025-09-28T10:05:00Z"},"inProgress":{"type":"string","description":"Timestamp of when the version was in progress (ISO format).","example":"2025-09-28T10:10:00Z"},"approved":{"type":"string","description":"Timestamp of when the version was approved (ISO format).","example":"2025-09-29T09:00:00Z"},"rejected":{"type":"string","description":"Timestamp of when the version was rejected (ISO format).","example":"2025-09-29T09:00:00Z"},"withdrawn":{"type":"string","description":"Timestamp of when the version was rejected (ISO format).","example":"2025-09-29T09:00:00Z"},"baseJson":{"type":"string","format":"json","description":"The base data of the app as JSON string.","example":"{ \"baseUrl\": \"https://example.com\" }"},"emitterUrl":{"type":"string","description":"The URL to which the Event-Emitter can send events from the app. Like when it was installed.","example":"https://emitter.example.com/run/v1.2.0"},"readme":{"type":"string","description":"README in Markdown format.","example":"# My app\n\nDescription."}},"required":["id","name","owner","state","requested","inQueue","inProgress","approved","rejected","withdrawn","baseJson","emitterUrl","readme"]},"ListApprovedVersionsResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Optional error message."},"appVersions":{"description":"A list of retrieved app versions.","type":"array","items":{"$ref":"#/components/schemas/AppVersionDto"}}},"required":["appVersions"]},"StorageObjectDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the object.","example":"59aBv7wzR9cxd1Pxyz"},"name":{"type":"string","description":"The name/path of the object in the bucket.","example":"uploads/image.png"},"created":{"type":"string","description":"Timestamp when the object was created.","example":"2025-10-08T10:00:00Z"},"updated":{"type":"string","description":"Timestamp when the object was last updated.","example":"2025-10-08T10:00:00Z"},"size":{"type":"number","description":"The size of the object in bytes.","example":102400},"contentType":{"type":"string","description":"The content type of the object.","example":"image/png"},"selfLink":{"type":"string","description":"The internal link to the object.","example":"https://storage.example.com/internal/59aBv7wzR9cxd1Pxyz"},"mediaLink":{"type":"string","description":"The public media link to download the object.","example":"https://storage.example.com/public/uploads/image.png"},"metadata":{"type":"object","description":"Custom metadata.","additionalProperties":{"type":"string"},"example":{"author":"John Doe"}}},"required":["id","name","created","updated","size","contentType","selfLink","metadata"]},"ListObjectsResponseDto":{"type":"object","properties":{"objects":{"description":"The list of objects.","type":"array","items":{"$ref":"#/components/schemas/StorageObjectDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["objects"]},"StorageObjectResponseDto":{"type":"object","properties":{"object":{"description":"The object.","nullable":true,"allOf":[{"$ref":"#/components/schemas/StorageObjectDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["object"]},"CreateObjectDto":{"type":"object","properties":{"data":{"type":"string","format":"binary","description":"The file to be uploaded."},"filename":{"type":"string","description":"An optional filename. If not specified, the original name of the file will be used."},"metadata":{"type":"object","description":"Optional metadata as key-value pairs.","additionalProperties":{"type":"string"}}},"required":["data","metadata"]},"DeleteObjectResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the deletion operation was successful.","example":true},"error":{"type":"string","description":"Optional error message."}},"required":["deleted"]},"CreateTagRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the new tag.","example":"VIP Customer"},"color":{"type":"string","description":"The color of the tag.","example":"blue"}},"required":["name","color"]},"TagDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the tag.","example":"kMA97ZQweaES0FGU25cl"},"created":{"type":"string","description":"Timestamp when the tag was created.","example":"2025-10-06T18:00:00Z"},"updated":{"type":"string","description":"Timestamp when the tag was last updated.","example":"2025-10-06T18:05:00Z"},"name":{"type":"string","description":"The name of the tag.","example":"Important"},"color":{"type":"string","pattern":"^#?([0-9A-F]{3}|[0-9A-F]{4}|[0-9A-F]{6}|[0-9A-F]{8})$","description":"The color of the tag as a hex code.","example":"#FF0000"}},"required":["id","created","updated","name","color"]},"TagResponseDto":{"type":"object","properties":{"tag":{"description":"The tag.","nullable":true,"allOf":[{"$ref":"#/components/schemas/TagDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["tag"]},"ListTagsResponseDto":{"type":"object","properties":{"tags":{"description":"The list of tags.","type":"array","items":{"$ref":"#/components/schemas/TagDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["tags"]},"UpdateTagRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the tag.","example":"High Priority"},"color":{"type":"string","description":"The new color of the tag.","example":"dark_green"}},"required":["name","color"]},"SortDirection":{"type":"number","enum":[0,1,-1],"description":"Sort direction\n\n- `0`: ASC\n- `1`: DESC"},"CreateOrUpdateViewRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the view.","example":"Urgent requests"},"icon":{"type":"string","description":"The name of the icon for the view.","example":"priority_high"},"tags":{"description":"A list of tag IDs for filtering.","default":[],"type":"array","items":{"type":"string"}},"unread":{"type":"boolean","description":"Display only unread conversations.","default":false},"sorting":{"type":"string","description":"Sort field (e.g., \"created\", \"updated\").","example":"updated"},"selfAssigned":{"type":"boolean","description":"Display only self-assigned conversations.","default":false},"open":{"type":"boolean","description":"Display open conversations.","default":true},"closed":{"type":"boolean","description":"Display closed conversations.","default":true},"inProgress":{"type":"boolean","description":"Display conversations in progress.","default":true},"sortingDirection":{"description":"Sort direction\n\n- `0`: ASC\n- `1`: DESC","default":1,"allOf":[{"$ref":"#/components/schemas/SortDirection"}]}},"required":["name","icon","tags","unread","sorting","selfAssigned","open","closed","inProgress","sortingDirection"]},"ViewDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the view.","example":"U0LXi1GyLR2Nj11Nt43J"},"created":{"type":"string","description":"Timestamp when the view was created.","example":"2025-10-07T14:00:00Z"},"updated":{"type":"string","description":"Timestamp when the view was last updated.","example":"2025-10-07T14:05:00Z"},"name":{"type":"string","description":"The name of the view.","example":"My VIP customers"},"icon":{"type":"string","description":"The name of the icon for the view.","example":"star"},"tags":{"description":"A list of tag IDs to filter by.","example":["XxFnGrkfHcrAFLXK9vMv"],"type":"array","items":{"type":"string"}},"unread":{"type":"boolean","description":"Filters only by unread conversations.","example":false},"sorting":{"type":"string","description":"The field to sort by.","example":"updated"},"selfAssigned":{"type":"boolean","description":"Filters only by conversations assigned to the current agent.","example":false},"open":{"type":"boolean","description":"Filters by open conversations.","example":true},"closed":{"type":"boolean","description":"Filters by closed conversations.","example":false},"inProgress":{"type":"boolean","description":"Filters by conversations in progress.","example":true},"sortingDirection":{"description":"The sort direction\n\n- `0`: ASC\n- `1`: DESC","example":1,"allOf":[{"$ref":"#/components/schemas/SortDirection"}]}},"required":["id","created","updated","name","icon","tags","unread","sorting","selfAssigned","open","closed","inProgress","sortingDirection"]},"ViewResponseDto":{"type":"object","properties":{"view":{"description":"The view.","nullable":true,"allOf":[{"$ref":"#/components/schemas/ViewDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["view"]},"ListViewsResponseDto":{"type":"object","properties":{"views":{"description":"The list of views.","type":"array","items":{"$ref":"#/components/schemas/ViewDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["views"]},"SendMessageRequestDto":{"type":"object","properties":{"conversationId":{"type":"string","description":"The ID of the conversation in which the message is sent.","example":"N1HSdvJSxAZmmcyVz5HW"},"text":{"type":"string","description":"The text content of the message. Either `text` or `attachmentRef` must be present.","example":"Hello, I have a question."},"attachmentRef":{"type":"string","description":"The reference to an uploaded attachment. Either `text` or `attachmentRef` must be present.","example":"z5AV6Eu3aBBdbu4sdjEa"}},"required":["conversationId"]},"MessagePersonaDto":{"type":"object","properties":{"image":{"type":"string","description":"The URL of the persona's avatar image.","example":"https://storage.example.com/avatars/support.png"},"name":{"type":"string","description":"The display name of the persona.","example":"Support Bot"}},"required":["image","name"]},"MessageContentFileDto":{"type":"object","properties":{"name":{"type":"string","description":"The file name.","example":"document.pdf"},"url":{"type":"string","description":"The URL where the file is hosted.","example":"https://storage.example.com/files/document.pdf"},"type":{"type":"string","description":"The type of file (e.g., image, document, audio).","example":"document"},"mimeType":{"type":"string","description":"The MIME type of the file.","example":"application/pdf"},"size":{"type":"number","description":"The file size in bytes.","example":102400},"attachmentRef":{"type":"string","description":"The reference ID for the attachment.","example":"att_abc123xyz"},"caption":{"type":"string","description":"An optional caption for the file.","example":"Project proposal document"},"transcript":{"type":"string","description":"The transcript of audio/video content.","example":"Hello, this is a voice message..."},"facebookAttachmentId":{"type":"string","description":"The Facebook attachment ID.","example":"fb_att_123456"},"whatsappAttachmentId":{"type":"string","description":"The WhatsApp attachment ID.","example":"wa_att_789012"},"instagramAttachmentId":{"type":"string","description":"The Instagram attachment ID.","example":"ig_att_345678"}},"required":["name","url","type","mimeType","size","attachmentRef"]},"MessageContentButtonDto":{"type":"object","properties":{"label":{"type":"string","description":"The display label of the button.","example":"View Details"},"type":{"type":"string","description":"The type of button (e.g., url, postback).","example":"postback"},"value":{"type":"string","description":"The value associated with the button.","example":"view_order_details"},"payload":{"type":"string","description":"An optional payload for the button.","example":"{\"orderId\": \"12345\"}"}},"required":["label","type","value"]},"MessageContentButtonsDto":{"type":"object","properties":{"buttons":{"description":"The list of buttons.","type":"array","items":{"$ref":"#/components/schemas/MessageContentButtonDto"}}},"required":["buttons"]},"MessageContentButtonReplyDto":{"type":"object","properties":{"label":{"type":"string","description":"The label of the selected button.","example":"Yes, confirm"},"value":{"type":"string","description":"The value of the selected button.","example":"confirm_order"},"payload":{"type":"string","description":"An optional payload from the button.","example":"{\"confirmed\": true}"},"type":{"type":"string","description":"The type of the button.","example":"postback"},"reference":{"type":"string","description":"The reference to the original button message.","example":"msg_abc123"}},"required":["label","value","reference"]},"MessageTemplateDto":{"type":"object","properties":{"body":{"type":"string","description":"The body text of the template.","example":"Thank you for your order {{1}}."},"header":{"type":"string","description":"The header text of the template.","example":"Order Confirmation"},"footer":{"type":"string","description":"The footer text of the template.","example":"Your Support Team"}},"required":["body"]},"MessageLocationDto":{"type":"object","properties":{"latitude":{"type":"number","description":"The latitude coordinate.","example":52.520008},"longitude":{"type":"number","description":"The longitude coordinate.","example":13.404954}},"required":["latitude","longitude"]},"MessageVoiceHangupDto":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for hanging up the call.","example":"Call completed"},"headers":{"type":"object","description":"Custom SIP headers for the hangup.","additionalProperties":{"type":"string"},"example":{"X-Custom-Header":"value"}}},"required":["reason","headers"]},"MessageVoiceTransferDto":{"type":"object","properties":{"target":{"type":"string","description":"The target phone number or SIP address for the transfer.","example":"+4930123456"},"reason":{"type":"string","description":"The reason for the transfer.","example":"Transferring to sales department"},"headers":{"type":"object","description":"Custom SIP headers for the transfer.","additionalProperties":{"type":"string"},"example":{"X-Transfer-Reason":"sales"}}},"required":["target","headers"]},"MessageAgentHandoverDto":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for the handover to an agent.","example":"Customer requested human support"},"timeoutSeconds":{"type":"number","description":"Timeout in seconds before the handover expires.","example":300},"agentId":{"type":"string","description":"The ID of the specific agent to hand over to.","example":"agent_abc123"},"groupId":{"type":"string","description":"The ID of the agent group to hand over to.","example":"group_support"},"assignmentMethod":{"type":"string","description":"The method for assigning the agent (e.g., round_robin, least_busy).","example":"round_robin"}},"required":["reason"]},"MessageContentEmailDto":{"type":"object","properties":{"subject":{"type":"string","description":"The subject of the email.","example":"Order Confirmation #12345"},"body":{"type":"string","description":"The body content of the email.","example":"Thank you for your order..."},"from":{"type":"string","description":"The sender email address.","example":"support@example.com"},"to":{"description":"The list of recipient email addresses.","example":["customer@example.com"],"type":"array","items":{"type":"string"}},"cc":{"description":"The list of CC recipient email addresses.","example":["manager@example.com"],"type":"array","items":{"type":"string"}},"bcc":{"description":"The list of BCC recipient email addresses.","example":["archive@example.com"],"type":"array","items":{"type":"string"}},"attachmentIds":{"description":"The list of attachment IDs.","example":["att_123","att_456"],"type":"array","items":{"type":"string"}},"references":{"description":"The list of email references for threading.","example":["<msg123@example.com>"],"type":"array","items":{"type":"string"}}},"required":["subject","body","from","to","cc","bcc","attachmentIds","references"]},"MessageContentTextToSpeechDto":{"type":"object","properties":{"text":{"type":"string","description":"The text to be converted to speech.","example":"Welcome to our service."},"speech":{"type":"string","description":"Pre-generated speech audio reference.","example":"speech_abc123"}},"required":["text"]},"MessageMetaWhatsAppTemplate_Header_FileDto":{"type":"object","properties":{"name":{"type":"string","description":"The file name.","example":"header_image.jpg"},"url":{"type":"string","description":"The URL where the file is hosted.","example":"https://storage.example.com/images/header.jpg"},"type":{"type":"string","description":"The type of file (e.g., image, document, video).","example":"image"},"mimeType":{"type":"string","description":"The MIME type of the file.","example":"image/jpeg"},"size":{"type":"number","description":"The file size in bytes.","example":51200},"attachmentRef":{"type":"string","description":"The reference ID for the attachment.","example":"att_header_123"}},"required":["name","url","type","mimeType","size","attachmentRef"]},"MessageMetaWhatsAppTemplate_HeaderDto":{"type":"object","properties":{"file":{"description":"The file attached to the header.","allOf":[{"$ref":"#/components/schemas/MessageMetaWhatsAppTemplate_Header_FileDto"}]},"parameters":{"description":"The list of parameter values for the header placeholders.","example":["John Doe"],"type":"array","items":{"type":"string"}}},"required":["parameters"]},"MessageMetaWhatsAppTemplate_ButtonDto":{"type":"object","properties":{"label":{"type":"string","description":"The display label of the button.","example":"Track Order"},"type":{"type":"string","description":"The type of button (e.g., url, quick_reply).","example":"url"},"url":{"type":"string","description":"The URL for URL-type buttons.","example":"https://example.com/track/{{1}}"},"value":{"type":"string","description":"The value for quick_reply-type buttons.","example":"track_order"}},"required":["label","type"]},"MessageMetaWhatsAppTemplateDto":{"type":"object","properties":{"templateName":{"type":"string","description":"The name of the template on Meta.","example":"order_shipped_notification"},"language":{"type":"string","description":"The language code of the template.","example":"DE"},"bodyText":{"type":"string","description":"The body text of the message. Placeholders are in the form `{{1}}`.","example":"Your order {{1}} has been shipped."},"headerText":{"type":"string","description":"The text in the header (if present)."},"footerText":{"type":"string","description":"The text in the footer (if present)."},"header":{"description":"The header component, which can contain a file or text parameters.","allOf":[{"$ref":"#/components/schemas/MessageMetaWhatsAppTemplate_HeaderDto"}]},"bodyParameters":{"description":"A list of values that replace the placeholders in the `bodyText`.","example":["#12345"],"type":"array","items":{"type":"string"}},"buttons":{"description":"A list of buttons attached to the message.","type":"array","items":{"$ref":"#/components/schemas/MessageMetaWhatsAppTemplate_ButtonDto"}}},"required":["templateName","language","bodyText","bodyParameters","buttons"]},"OperatorDto":{"type":"object","properties":{"operatorId":{"type":"string","description":"The unique identifier of the operator.","example":"op_abc123xyz"}},"required":["operatorId"]},"ContentDto":{"type":"object","properties":{"text":{"type":"string","description":"The text content of the message.","example":"Hello, how can I help you?"},"file":{"description":"A file attachment.","allOf":[{"$ref":"#/components/schemas/MessageContentFileDto"}]},"buttons":{"description":"Interactive buttons for the message.","allOf":[{"$ref":"#/components/schemas/MessageContentButtonsDto"}]},"selectedButton":{"description":"The button selected by the user.","allOf":[{"$ref":"#/components/schemas/MessageContentButtonReplyDto"}]},"template":{"description":"A message template.","allOf":[{"$ref":"#/components/schemas/MessageTemplateDto"}]},"location":{"description":"A location shared in the message.","allOf":[{"$ref":"#/components/schemas/MessageLocationDto"}]},"voiceHangup":{"description":"Voice hangup data.","allOf":[{"$ref":"#/components/schemas/MessageVoiceHangupDto"}]},"voiceTransfer":{"description":"Voice transfer data.","allOf":[{"$ref":"#/components/schemas/MessageVoiceTransferDto"}]},"agentHandover":{"description":"Agent handover data.","allOf":[{"$ref":"#/components/schemas/MessageAgentHandoverDto"}]},"email":{"description":"Email content data.","allOf":[{"$ref":"#/components/schemas/MessageContentEmailDto"}]},"textToSpeech":{"description":"Text-to-speech content data.","allOf":[{"$ref":"#/components/schemas/MessageContentTextToSpeechDto"}]},"metaWhatsappTemplate":{"description":"A Meta WhatsApp template message.","allOf":[{"$ref":"#/components/schemas/MessageMetaWhatsAppTemplateDto"}]},"operator":{"description":"Operator data for the message.","allOf":[{"$ref":"#/components/schemas/OperatorDto"}]},"delay":{"type":"number","description":"Delay in milliseconds before sending the message.","example":2000},"leadAiId":{"type":"string","description":"The ID of the Lead AI associated with this message.","example":"leadai_abc123"}}},"MessageDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the message.","example":"msg_abc123xyz"},"sender":{"type":"string","description":"The sender of the message (e.g., user, bot, agent).","example":"bot"},"type":{"type":"string","description":"The type of message (e.g., text, file, template).","example":"text"},"persona":{"description":"The persona representing the sender.","allOf":[{"$ref":"#/components/schemas/MessagePersonaDto"}]},"providerMessageId":{"type":"string","description":"The message ID from the external provider.","example":"wamid.HBgNNDkxNTEyNjAyNTQ1Ng=="},"status":{"type":"string","description":"The delivery status of the message.","example":"delivered"},"created":{"type":"string","description":"Timestamp when the message was created.","example":"2025-10-06T12:00:00Z"},"processed":{"type":"string","description":"Timestamp when the message was processed.","example":"2025-10-06T12:00:01Z"},"sent":{"type":"string","description":"Timestamp when the message was sent.","example":"2025-10-06T12:00:02Z"},"received":{"type":"string","description":"Timestamp when the message was received by the recipient.","example":"2025-10-06T12:00:03Z"},"read":{"type":"string","description":"Timestamp when the message was read by the recipient.","example":"2025-10-06T12:00:10Z"},"outgoing":{"type":"boolean","description":"Whether the message is outgoing (true) or incoming (false).","example":true},"messengerId":{"type":"string","description":"The messenger ID associated with the message.","example":"messenger_abc123"},"contextId":{"type":"string","description":"The context ID for message threading.","example":"ctx_xyz789"},"content":{"description":"The content of the message.","allOf":[{"$ref":"#/components/schemas/ContentDto"}]},"tags":{"description":"The list of tags associated with the message.","example":["important","follow-up"],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"Optional error message."},"isSensitive":{"type":"boolean","description":"Whether the message contains sensitive content.","example":false},"streamGroupId":{"type":"string","description":"The stream group ID for grouped streaming messages.","example":"stream_abc123"},"delay":{"type":"number","description":"Delay in milliseconds before sending the message.","example":1000}},"required":["id","sender","type","status","created","outgoing","content","tags"]},"SendMessageResponseDto":{"type":"object","properties":{"message":{"description":"The newly created message.","nullable":true,"allOf":[{"$ref":"#/components/schemas/MessageDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["message"]},"CreateInboxConversationRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the contact for the new conversation.","example":"John Doe"},"email":{"type":"string","format":"email","description":"The email address of the contact.","example":"john.doe@example.com"},"phone":{"type":"string","description":"The phone number of the contact.","example":"+4917612345678"},"channelId":{"type":"string","description":"The ID of the channel in which the conversation is created.","example":"sTjncRDMuTdv65ex4I05"}},"required":["name","channelId"]},"CreateInboxConversationResponseDto":{"type":"object","properties":{"conversationId":{"type":"string","description":"The ID of the newly created conversation.","example":"bI0xfJiGQuPXCJ9slT5G"},"error":{"type":"string","description":"Optional error message."}}},"SendNoteRequestDto":{"type":"object","properties":{"conversationId":{"type":"string","description":"The ID of the conversation to which the note is added.","example":"VWQB39R64JQQM9rMkqtK"},"text":{"type":"string","description":"The text content of the note.","example":"Customer asked for a discount."},"mentions":{"description":"A list of agent IDs mentioned in the note.","example":["wiDCerXfAVj0I1t5FbjR"],"type":"array","items":{"type":"string"}}},"required":["conversationId","text"]},"SendNoteResponseDto":{"type":"object","properties":{"message":{"description":"The message created as a note.","nullable":true,"allOf":[{"$ref":"#/components/schemas/MessageDto"}]},"error":{"type":"string","description":"An optional error message."}},"required":["message"]},"AnswerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the answer.","example":"mUfMNyuVSPSVgNVPdhLm"},"created":{"type":"string","description":"Timestamp when the answer was created.","example":"2025-10-06T12:00:00Z"},"updated":{"type":"string","description":"Timestamp when the answer was last updated.","example":"2025-10-06T12:05:00Z"},"name":{"type":"string","description":"The name/title of the text snippet.","example":"Salutation"},"message":{"type":"string","description":"The content of the text snippet.","example":"Best regards, your support team"}},"required":["id","created","updated","name","message"]},"ListAnswersResponseDto":{"type":"object","properties":{"answers":{"description":"The list of answers.","type":"array","items":{"$ref":"#/components/schemas/AnswerDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["answers"]},"CreateAnswerRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name/title of the text snippet.","example":"Opening hours"},"message":{"type":"string","description":"The content of the text snippet.","example":"We are open Monday to Friday from 9 AM to 5 PM."}},"required":["name","message"]},"AnswerResponseDto":{"type":"object","properties":{"answer":{"description":"The answer.","nullable":true,"allOf":[{"$ref":"#/components/schemas/AnswerDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["answer"]},"UpdateAnswerRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the text snippet.","example":"New opening hours"},"message":{"type":"string","description":"The new content of the text snippet.","example":"Our new opening hours are from 8 AM to 6 PM."}},"required":["name","message"]},"DeleteAnswerResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Optional error message."}}},"CreateChatSummaryResponseDto":{"type":"object","properties":{"summary":{"type":"string","description":"The generated summary of the conversation.","example":"The customer is asking about the status of their order #12345."},"error":{"type":"string","description":"Optional error message."}},"required":["summary"]},"CreateChatCompletionResponseDto":{"type":"object","properties":{"completion":{"type":"string","description":"The completed text suggestion.","example":"...and I wish you a nice day."},"error":{"type":"string","description":"Optional error message."}},"required":["completion"]},"CreateChatFormulationRequestDto":{"type":"object","properties":{"message":{"type":"string","description":"The message to be reformulated.","example":"Can you help me?"}},"required":["message"]},"CreateChatFormulationResponseDto":{"type":"object","properties":{"formulation":{"type":"string","description":"The reformulated text suggestion.","example":"Dear customer, how can I assist you?"}}},"AgentOnlineStateDto":{"type":"object","properties":{"agentId":{"type":"string","description":"The unique identifier of the agent.","example":"i1def0QdChav9VSVFqPi"},"online":{"type":"boolean","description":"Whether the agent is currently online.","example":true},"lastSeen":{"type":"string","description":"Timestamp of the last activity.","example":"2025-10-06T10:00:00Z"}},"required":["agentId","online","lastSeen"]},"ListAgentOnlineStateResponseDto":{"type":"object","properties":{"agents":{"description":"The list of agent online states.","type":"array","items":{"$ref":"#/components/schemas/AgentOnlineStateDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["agents"]},"SetAgentOnlineStateRequestDto":{"type":"object","properties":{"online":{"type":"boolean","description":"Sets the online status of the agent.","example":true},"clientTimestamp":{"type":"string","description":"The client timestamp when the request is made. This is used to resolve conflicts when multiple requests are made in a short period of time.","example":123456789}},"required":["online","clientTimestamp"]},"SetAgentOnlineStateResponseDto":{"type":"object","properties":{"agent":{"description":"The updated agent online state.","nullable":true,"allOf":[{"$ref":"#/components/schemas/AgentOnlineStateDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["agent"]},"AgentNotificationSettings_SettingDto":{"type":"object","properties":{"email":{"type":"boolean","description":"Enable/disable email notifications.","example":true},"browser":{"type":"boolean","description":"Enable/disable in-browser (push) notifications.","example":true}},"required":["email","browser"]},"UpdateAgentNotificationSettingsRequestDto":{"type":"object","properties":{"botHandoverToUnassigned":{"description":"Notification settings for bot handover to unassigned.","allOf":[{"$ref":"#/components/schemas/AgentNotificationSettings_SettingDto"}]},"botAssignsYou":{"description":"Notification settings for when bot assigns you.","allOf":[{"$ref":"#/components/schemas/AgentNotificationSettings_SettingDto"}]},"conversationsAssignedToYou":{"description":"Notification settings for conversations assigned to you.","allOf":[{"$ref":"#/components/schemas/AgentNotificationSettings_SettingDto"}]},"pushToken":{"type":"string","description":"The push token for browser notifications.","example":"cVA6cG-ztyB-M8_7yul:APAnGnnmmELFUbziLIVatyDVe_DyihdJhiaQHYw"}},"required":["botHandoverToUnassigned","botAssignsYou","conversationsAssignedToYou"]},"AgentNotificationSettingsDto":{"type":"object","properties":{"agentId":{"type":"string","description":"The unique identifier of the agent.","example":"Bs47n9wcxy6CWnt48Av3"},"botHandoverToUnassigned":{"description":"Notification settings for bot handover to unassigned.","allOf":[{"$ref":"#/components/schemas/AgentNotificationSettings_SettingDto"}]},"botAssignsYou":{"description":"Notification settings for when bot assigns you.","allOf":[{"$ref":"#/components/schemas/AgentNotificationSettings_SettingDto"}]},"conversationsAssignedToYou":{"description":"Notification settings for conversations assigned to you.","allOf":[{"$ref":"#/components/schemas/AgentNotificationSettings_SettingDto"}]},"pushToken":{"type":"string","description":"The push token for browser notifications.","example":"cVA6cG-ztyB-M8_7yul:APAnGnnmmELFUbziLIVatyDVe_DyihdJhiaQHYw"}},"required":["agentId","botHandoverToUnassigned","botAssignsYou","conversationsAssignedToYou"]},"AgentNotificationSettingsResponseDto":{"type":"object","properties":{"settings":{"description":"The agent notification settings.","nullable":true,"allOf":[{"$ref":"#/components/schemas/AgentNotificationSettingsDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["settings"]},"TeamDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the team.","example":"L1SQSnEeYL61pMtEKDln"},"name":{"type":"string","description":"The name of the team.","example":"First-Level-Support"},"created":{"type":"string","description":"Timestamp when the team was created.","example":"2025-10-07T10:00:00Z"},"updated":{"type":"string","description":"Timestamp when the team was last updated.","example":"2025-10-07T10:05:00Z"},"icon":{"type":"string","description":"The icon identifier for the team.","example":"support_agent"},"userIds":{"description":"The list of user IDs that are members of the team.","example":["uaYAdkVQteacOnKtQMhX"],"type":"array","items":{"type":"string"}}},"required":["id","name","created","updated","icon","userIds"]},"ListTeamsResponseDto":{"type":"object","properties":{"teams":{"description":"The list of teams.","type":"array","items":{"$ref":"#/components/schemas/TeamDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["teams"]},"TeamResponseDto":{"type":"object","properties":{"team":{"description":"The team.","nullable":true,"allOf":[{"$ref":"#/components/schemas/TeamDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["team"]},"CreateTeamRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the new team.","example":"Customer Service Team"}},"required":["name"]},"UpdateTeamDto":{"type":"object","properties":{"userIds":{"description":"A list of user IDs that should be members of the team.","example":["ZVfFkkOEuHzYWaSijjNk","SfHdrGq4Yosu5QeHYXVp"],"type":"array","items":{"type":"string"}},"name":{"type":"string","description":"The new name of the team.","example":"Second-Level-Support"}},"required":["userIds"]},"UpdateTeamRequestDto":{"type":"object","properties":{"updated":{"description":"The object containing the fields to be updated.","allOf":[{"$ref":"#/components/schemas/UpdateTeamDto"}]}},"required":["updated"]},"InboxWidgetFieldType":{"type":"number","enum":[0,1,2,3,4,-1],"description":"The type of the field.\n\n- `0`: TEXT\n- `1`: NUMBER\n- `2`: CHECKBOX\n- `3`: DROPDOWN\n- `4`: DATE"},"InboxWidgetFieldDto":{"type":"object","properties":{"label":{"type":"string","description":"The display label of the field.","example":"Customer Name"},"variable":{"type":"string","description":"The variable id used to bind field data.","example":"dcq55wcucbiwa212v"},"type":{"description":"The type of the field.\n\n- `0`: TEXT\n- `1`: NUMBER\n- `2`: CHECKBOX\n- `3`: DROPDOWN\n- `4`: DATE","example":0,"allOf":[{"$ref":"#/components/schemas/InboxWidgetFieldType"}]},"readonly":{"type":"boolean","description":"Whether the field is read-only.","example":false},"options":{"description":"The selectable options for DROPDOWN type fields.","example":["Option A","Option B"],"type":"array","items":{"type":"string"}},"position":{"type":"number","description":"The display position of the field in which they will be ordered by in the widget.","example":0}},"required":["label","variable","type","options","position"]},"CreateInboxWidgetRequestDto":{"type":"object","properties":{"title":{"type":"string","description":"The title of the widget.","example":"Customer Info"},"fields":{"description":"The fields for the widget.","type":"array","items":{"$ref":"#/components/schemas/InboxWidgetFieldDto"}}},"required":["title","fields"]},"InboxWidgetDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the widget.","example":"U0LXi1GyLR2Nj11Nt43J"},"title":{"type":"string","description":"The title of the widget.","example":"Customer Info"},"fields":{"description":"The fields contained in the widget.","type":"array","items":{"$ref":"#/components/schemas/InboxWidgetFieldDto"}},"created":{"type":"string","description":"Timestamp when the widget was created.","example":"2025-10-07T14:00:00Z"},"updated":{"type":"string","description":"Timestamp when the widget was last updated.","example":"2025-10-07T14:05:00Z"}},"required":["id","title","fields","created","updated"]},"InboxWidgetResponseDto":{"type":"object","properties":{"inboxWidget":{"description":"The widget.","nullable":true,"allOf":[{"$ref":"#/components/schemas/InboxWidgetDto"}]}}},"ListInboxWidgetsResponseDto":{"type":"object","properties":{"inboxWidgets":{"description":"The list of widgets.","type":"array","items":{"$ref":"#/components/schemas/InboxWidgetDto"}}},"required":["inboxWidgets"]},"InboxWidgetValuesResponseDto":{"type":"object","properties":{"fieldValues":{"description":"The widget values.","type":"array","items":{"type":"object"}}},"required":["fieldValues"]},"UpdateInboxWidgetRequestDto":{"type":"object","properties":{"title":{"type":"string","description":"The updated title of the widget.","example":"Updated Customer Info"},"fields":{"description":"The updated fields for the widget.","type":"array","items":{"$ref":"#/components/schemas/InboxWidgetFieldDto"}}},"required":["fields"]},"DeleteInboxWidgetResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Whether the widget was successfully deleted.","example":true}}},"ChannelDto":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the channel.","example":"chan59aBv7wzR9cxd1Pxyz"},"name":{"type":"string","description":"The name of the channel.","example":"My Web Channel"},"number":{"type":"string","description":"The phone number of the channel (In case of voice channel).","example":"+49123456789"},"status":{"type":"string","description":"The status of the channel.","example":"connected"},"token":{"type":"string","description":"The token of the channel.","example":"By4hQWBaJaRrwvxg5fWzhQWBaJaRrrwvxg5fWzhwvxg5fWzhQWBaJaRrr"},"type":{"type":"string","description":"The type of the channel.","example":"web","enum":["facebook","voice","audiocodes","web","meta-whatsapp","telegram","brevo","email","debug"]},"created":{"type":"string","description":"Creation timestamp (ISO format).","example":"2025-09-30T10:00:00Z"},"updated":{"type":"string","description":"Last updated timestamp (ISO format).","example":"2025-09-30T10:05:00Z"},"tokenValidUntil":{"type":"string","description":"The date until the token is valid (ISO format).","example":"2026-09-30T10:00:00Z"},"chatbotId":{"type":"string","description":"The Id of the chatbot the channel exists in.","example":"botKq8BxZaJd2wZR9cxd1P"},"environment":{"type":"string","description":"The environment the channel is in.","example":"dev","enum":["dev","test","prod"]},"mpId":{"type":"string","description":"The Id for the MP channel.","example":"550e8400-e29b-41d4-a716-446655440000"},"whatsappId":{"type":"string","description":"The Id for the WhatsApp provider.","example":"WH-123456789"},"facebookId":{"type":"string","description":"The Id for the Facebook Messenger provider.","example":"FB-987654321"},"telegramId":{"type":"string","description":"The Id for the Telegram provider.","example":"TG-11223344"},"instagramId":{"type":"string","description":"The Id for the Instagram provider.","example":"IG-55667788"},"audiocodesId":{"type":"string","description":"The Id for the AudioCodes voice gateway.","example":"AC-99001122"},"language":{"type":"string","description":"The language code for the channel.","example":"en"},"domains":{"description":"A list of domains on which the channel is used (In case of web-widget channel).","example":["https://my-website.de"],"type":"array","items":{"type":"string"}},"providerId":{"type":"string","description":"The Id of the provider.","example":"RFQWwJ3WdZnsl7qWJOfs"},"pin":{"type":"string","description":"The pin for the channel.","example":"1234"},"metadata":{"type":"object","description":"Additional custom metadata as key-value pairs.","additionalProperties":{"type":"string"}},"async":{"type":"boolean","description":"Indicates whether the channel is async or not.","example":true},"description":{"type":"string","description":"The description for the channel.","example":"This channel is used for..."},"email":{"type":"string","description":"The email of the channel (In case of email channel).","example":"example@email.com"}},"required":["id","name","status","token","type","created","updated","tokenValidUntil","chatbotId","environment","domains","providerId"]},"ListChannelsResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Optional error message."},"channels":{"description":"A list of retrieved channels.","type":"array","items":{"$ref":"#/components/schemas/ChannelDto"}}},"required":["channels"]},"ChannelType":{"type":"number","enum":[0,6]},"GenerateChannelTokenResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Optional error message."},"token":{"type":"string","description":"The generated token.","example":"cc-tok-very-long-secret-token-string"}}},"WebWidgetColorsDto":{"type":"object","properties":{"gradientFirst":{"type":"string","description":"First color for the header gradient (Hex).","example":"#176184"},"gradientSecond":{"type":"string","description":"Second color for the header gradient (Hex).","example":"#5fbed1"},"gradientThird":{"type":"string","description":"Third color for the header gradient (Hex).","example":"#FFFFFF"},"gradientText":{"type":"string","description":"Color for text placed over the header gradient.","example":"#FFFFFF"},"primary":{"type":"string","description":"Main branding color for the widget.","example":"#176184"},"onPrimary":{"type":"string","description":"Contrast color for text/icons on top of the primary color.","example":"#FFFFFF"},"secondary":{"type":"string","description":"Accent color used for highlights or secondary UI elements.","example":"#5fbed1"},"onSecondary":{"type":"string","description":"Contrast color for text/icons on top of the secondary color.","example":"#000000"},"button":{"type":"string","description":"Background color for primary action buttons.","example":"#176184"},"onButton":{"type":"string","description":"Color for text/icons inside buttons.","example":"#FFFFFF"},"dark":{"type":"boolean","description":"Activates dark mode.","example":false}},"required":["gradientFirst","gradientSecond","gradientThird","gradientText","primary","onPrimary","secondary","onSecondary","button","onButton","dark"]},"WebWidgetContentsDto":{"type":"object","properties":{"headline":{"type":"object","description":"Headline, multilingual.","additionalProperties":{"type":"string"},"example":{"DE":"Hallo!","EN-GB":"Hello!"}},"subHeadline":{"type":"object","description":"Sub-headline, multilingual.","additionalProperties":{"type":"string"},"example":{"DE":"Wie können wir helfen?","EN-GB":"How can we help?"}},"callToAction":{"type":"object","description":"Call-to-action text, multilingual.","additionalProperties":{"type":"string"},"example":{"DE":"Chat starten","EN-GB":"Start Chat"}},"callToActionSubtitle":{"type":"object","description":"Call-to-action subtitle, multilingual.","additionalProperties":{"type":"string"},"example":{"DE":"Antwortzeit: 2 Minuten","EN-GB":"Reply time: 2 minutes"}},"botName":{"type":"string","description":"The name of the chatbot displayed in the header.","example":"Support-Bot"},"hideBotAvatar":{"type":"boolean","description":"Hides the bot's avatar in the chat header.","example":false},"hideFileUpload":{"type":"boolean","description":"Hides the option to upload files.","example":false}},"required":["headline","subHeadline","callToAction","callToActionSubtitle","botName","hideBotAvatar","hideFileUpload"]},"WebWidgetSettingsDto":{"type":"object","properties":{"colors":{"description":"The widget's color settings.","nullable":true,"allOf":[{"$ref":"#/components/schemas/WebWidgetColorsDto"}]},"contents":{"description":"The widget's content settings.","nullable":true,"allOf":[{"$ref":"#/components/schemas/WebWidgetContentsDto"}]},"privacyConsent":{"type":"boolean","description":"Indicates whether the privacy policy must be accepted.","example":true},"updated":{"type":"string","description":"Last updated timestamp (ISO format).","example":"2025-09-30T12:00:00Z"},"created":{"type":"string","description":"Creation timestamp (ISO format).","example":"2025-01-01T12:00:00Z"}},"required":["colors","contents","privacyConsent","updated","created"]},"WebWidgetSettingsResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Optional error message"},"webWidgetSettings":{"description":"The widgets settings.","nullable":true,"allOf":[{"$ref":"#/components/schemas/WebWidgetSettingsDto"}]}}},"UpdateWebWidgetDto":{"type":"object","properties":{"colors":{"description":"The widget's color settings.","nullable":true,"allOf":[{"$ref":"#/components/schemas/WebWidgetColorsDto"}]},"contents":{"description":"The widget's content settings.","nullable":true,"allOf":[{"$ref":"#/components/schemas/WebWidgetContentsDto"}]},"privacyConsent":{"type":"boolean","description":"Indicates whether the privacy policy must be accepted.","example":true}},"required":["colors","contents","privacyConsent"]},"UpdateWebWidgetSettingsRequestDto":{"type":"object","properties":{"updateWebWidget":{"description":"The object containing the widget settings to be updated.","nullable":true,"allOf":[{"$ref":"#/components/schemas/UpdateWebWidgetDto"}]}},"required":["updateWebWidget"]},"SearchResultFacet_CountDto":{"type":"object","properties":{"count":{"type":"number","description":"The number of results for this facet value.","example":42},"highlighted":{"type":"string","description":"The highlighted facet value.","example":"<em>whatsapp</em>"},"value":{"type":"string","description":"The facet value.","example":"whatsapp"}},"required":["count","highlighted","value"]},"SearchResultFacet_StatsDto":{"type":"object","properties":{"max":{"type":"number","description":"The maximum value.","example":100},"avg":{"type":"number","description":"The average value.","example":45.5},"min":{"type":"number","description":"The minimum value.","example":1},"sum":{"type":"number","description":"The sum of all values.","example":1820}}},"SearchResultFacetDto":{"type":"object","properties":{"counts":{"description":"The facet value counts.","type":"array","items":{"$ref":"#/components/schemas/SearchResultFacet_CountDto"}},"fieldName":{"type":"string","description":"The name of the faceted field.","example":"channelType"},"stats":{"description":"Statistics for numeric facets.","allOf":[{"$ref":"#/components/schemas/SearchResultFacet_StatsDto"}]}},"required":["counts","fieldName"]},"ConversationBlockDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the block.","example":"blk_abc123"},"name":{"type":"string","description":"The display name of the block.","example":"Welcome Message"}},"required":["id","name"]},"ConversationNotesDto":{"type":"object","properties":{"notes":{"description":"List of notes attached to the conversation.","example":["Customer prefers email contact","VIP customer"],"type":"array","items":{"type":"string"}}},"required":["notes"]},"ConversationUserInputDto":{"type":"object","properties":{"redirect":{"type":"string","description":"The redirect destination for user input.","example":"flow_abc123"},"isSensitive":{"type":"boolean","description":"Whether the user input contains sensitive data.","example":false}},"required":["redirect"]},"ConversationLeadAiConversationDto":{"type":"object","properties":{"flowId":{"type":"string","description":"The ID of the flow being executed.","example":"flow_xyz789"},"stepId":{"type":"string","description":"The ID of the current step in the flow.","example":"step_abc123"},"interactions":{"type":"number","description":"The number of interactions in this conversation.","example":5},"executionId":{"type":"string","description":"The unique execution ID for this conversation flow.","example":"exec_def456"}},"required":["flowId","stepId","interactions","executionId"]},"ConversationTeamDto":{"type":"object","properties":{"teamId":{"type":"string","description":"The ID of the team assigned to this conversation.","example":"team_support_01"}},"required":["teamId"]},"ConversationStatus":{"type":"number","enum":[0,1,2,3,-1],"description":"The current state of the conversation.\n\n- `0`: OPEN\n- `1`: BOT\n- `2`: IN_PROGRESS\n- `3`: CLOSED"},"ConversationDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the conversation.","example":"conv_abc123xyz"},"contactId":{"type":"string","description":"The ID of the contact associated with this conversation.","example":"contact_def456"},"archived":{"type":"boolean","description":"Whether the conversation is archived.","example":false},"channelId":{"type":"string","description":"The ID of the channel for this conversation.","example":"channel_ghi789"},"channelType":{"type":"string","description":"The type of channel (e.g., web, whatsapp, telegram).","example":"whatsapp"},"chatbotId":{"type":"string","description":"The ID of the chatbot handling this conversation.","example":"bot_jkl012"},"idToken":{"type":"string","description":"The ID token for this conversation.","example":"token_mno345"},"language":{"type":"string","description":"The language code of the conversation.","example":"DE"},"operatorId":{"type":"string","description":"The ID of the assigned operator.","example":"op_pqr678"},"photoUrl":{"type":"string","description":"The URL of the contact's photo.","example":"https://example.com/photos/user123.jpg"},"sessionCount":{"type":"number","description":"The number of sessions in this conversation.","example":3},"tags":{"description":"Tags associated with this conversation.","example":["vip","sales"],"type":"array","items":{"type":"string"}},"unread":{"type":"boolean","description":"Whether the conversation has unread messages.","example":true},"variables":{"type":"object","description":"Custom variables for this conversation.","additionalProperties":{"type":"string"},"example":{"customer_name":"John","order_id":"12345"}},"lastBlock":{"description":"The last block visited in the flow.","allOf":[{"$ref":"#/components/schemas/ConversationBlockDto"}]},"lastButton":{"description":"The last button clicked by the user.","allOf":[{"$ref":"#/components/schemas/ConversationBlockDto"}]},"created":{"type":"string","description":"Timestamp when the conversation was created.","example":"2025-10-05T10:00:00Z"},"updated":{"type":"string","description":"Timestamp when the conversation was last updated.","example":"2025-10-05T12:30:00Z"},"providerId":{"type":"string","description":"The external provider ID for this conversation.","example":"wa_123456789"},"name":{"type":"string","description":"The display name of the contact.","example":"John Doe"},"lastMessage":{"description":"The content of the last message in the conversation.","allOf":[{"$ref":"#/components/schemas/ContentDto"}]},"snoozed":{"type":"string","description":"Timestamp until which the conversation is snoozed.","example":"2025-10-06T09:00:00Z"},"lastUserAction":{"type":"string","description":"Timestamp of the last user action.","example":"2025-10-05T12:25:00Z"},"mentions":{"description":"List of user IDs mentioned in this conversation.","example":["user_123","user_456"],"type":"array","items":{"type":"string"}},"mentionsRead":{"type":"object","description":"Map of mentions to their read status.","additionalProperties":{"type":"boolean"},"example":{"user_123":true,"user_456":false}},"notes":{"description":"Notes attached to this conversation.","allOf":[{"$ref":"#/components/schemas/ConversationNotesDto"}]},"lastSender":{"type":"string","description":"The type of the last sender (user, bot, operator).","example":"user"},"userInput":{"description":"Current user input state.","allOf":[{"$ref":"#/components/schemas/ConversationUserInputDto"}]},"environment":{"type":"string","description":"The environment.","example":"test","enum":["dev","test","prod"]},"metadata":{"type":"object","description":"Custom metadata for this conversation.","additionalProperties":{"type":"string"},"example":{"source":"website","campaign":"summer_sale"}},"lastUserInput":{"type":"string","description":"The last user input text.","example":"I need help with my order"},"leadAiConversation":{"description":"Lead AI conversation state.","allOf":[{"$ref":"#/components/schemas/ConversationLeadAiConversationDto"}]},"team":{"description":"The team assigned to this conversation.","allOf":[{"$ref":"#/components/schemas/ConversationTeamDto"}]},"state":{"description":"The current state of the conversation.\n\n- `0`: OPEN\n- `1`: BOT\n- `2`: IN_PROGRESS\n- `3`: CLOSED","allOf":[{"$ref":"#/components/schemas/ConversationStatus"}]},"lastAssignedOperatorId":{"type":"string","description":"The ID of the last assigned operator.","example":"op_xyz789"},"lastSeen":{"type":"string","description":"Timestamp when the conversation was last seen.","example":"2025-10-05T12:30:00Z"}},"required":["id","contactId","archived","channelId","channelType","chatbotId","idToken","language","operatorId","photoUrl","sessionCount","tags","unread","variables","created","updated","name","snoozed","lastUserAction","mentions","mentionsRead","environment","metadata","state"]},"HighlightResultDto":{"type":"object","properties":{"field":{"type":"string","description":"The field where the hit was found.","example":"content.text"},"matchedTokens":{"description":"The exact words that matched.","type":"array","items":{"type":"string"}},"snippet":{"type":"string","description":"A short excerpt of the text with highlights."}},"required":["field","matchedTokens","snippet"]},"SearchResultHitDto":{"type":"object","properties":{"conversation":{"description":"The matching conversation.","allOf":[{"$ref":"#/components/schemas/ConversationDto"}]},"highlights":{"description":"List of highlighted match results.","type":"array","items":{"$ref":"#/components/schemas/HighlightResultDto"}},"textMatch":{"type":"string","description":"A combined string of all text matches.","example":"order confirmation shipping"}},"required":["conversation","highlights","textMatch"]},"SearchConversationResultDto":{"type":"object","properties":{"facetCounts":{"description":"The facet counts for the search.","type":"array","items":{"$ref":"#/components/schemas/SearchResultFacetDto"}},"found":{"type":"number","description":"Total number of results found.","example":150},"hits":{"description":"The search result hits.","type":"array","items":{"$ref":"#/components/schemas/SearchResultHitDto"}},"outOf":{"type":"number","description":"Total number of documents searched.","example":10000},"page":{"type":"number","description":"The current page of search results.","example":1},"searchTimeMs":{"type":"number","description":"The duration of the search in milliseconds.","example":25}},"required":["facetCounts","found","hits","outOf","page","searchTimeMs"]},"SearchConversationsResponseDto":{"type":"object","properties":{"results":{"description":"The search results.","nullable":true,"allOf":[{"$ref":"#/components/schemas/SearchConversationResultDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["results"]},"ListConversationsResponseDto":{"type":"object","properties":{"conversations":{"description":"The list of conversations.","type":"array","items":{"$ref":"#/components/schemas/ConversationDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["conversations"]},"FindConversationResponseDto":{"type":"object","properties":{"conversation":{"description":"The found conversation.","allOf":[{"$ref":"#/components/schemas/ConversationDto"}]},"error":{"type":"string","description":"Optional error message."}}},"ConversationResponseDto":{"type":"object","properties":{"conversation":{"description":"The conversation.","allOf":[{"$ref":"#/components/schemas/ConversationDto"}]},"error":{"type":"string","description":"Optional error message."}}},"CreateConversationTagsDto":{"type":"object","properties":{"tags":{"description":"List of tags to attach to the conversation.","example":["vip","sales"],"type":"array","items":{"type":"string"}}},"required":["tags"]},"CreateConversationNotesDto":{"type":"object","properties":{"notes":{"description":"List of notes to attach to the conversation.","example":["Initial contact via web widget"],"type":"array","items":{"type":"string"}}},"required":["notes"]},"CreateConversationMentionsDto":{"type":"object","properties":{"mentions":{"description":"List of user IDs to mention in the conversation.","example":["user_123","user_456"],"type":"array","items":{"type":"string"}}},"required":["mentions"]},"CreateConversationDto":{"type":"object","properties":{"contactId":{"type":"string","description":"The ID of the contact for this conversation.","example":"contact_abc123"},"channelId":{"type":"string","description":"The ID of the channel for this conversation.","example":"channel_def456"},"channelType":{"type":"string","description":"The type of channel.","example":"web","enum":["facebook","voice","audiocodes","web","meta-whatsapp","telegram","brevo","email","debug"]},"name":{"type":"string","description":"The display name of the contact.","example":"John Doe"},"environment":{"type":"string","description":"The environment.","example":"test","enum":["dev","test","prod"]},"providerId":{"type":"string","description":"The external provider ID for this conversation.","example":"wa_123456789"},"unread":{"type":"boolean","description":"Whether the conversation has unread messages.","example":true},"archived":{"type":"boolean","description":"Whether the conversation is archived.","example":false},"tags":{"description":"Tags to attach to the conversation.","allOf":[{"$ref":"#/components/schemas/CreateConversationTagsDto"}]},"notes":{"description":"Notes to attach to the conversation.","allOf":[{"$ref":"#/components/schemas/CreateConversationNotesDto"}]},"lastMessage":{"description":"The content of the last message.","allOf":[{"$ref":"#/components/schemas/ContentDto"}]},"operatorId":{"type":"string","description":"The ID of the assigned operator.","example":"op_xyz789"},"snoozed":{"type":"string","description":"Timestamp until which the conversation is snoozed.","example":"2025-10-06T09:00:00Z"},"lastUserAction":{"type":"string","description":"Timestamp of the last user action.","example":"2025-10-05T12:25:00Z"},"lastSender":{"type":"string","description":"The type of the last sender (user, bot, operator).","example":"user"},"mentions":{"description":"User mentions for this conversation.","allOf":[{"$ref":"#/components/schemas/CreateConversationMentionsDto"}]},"metadata":{"type":"object","description":"Custom metadata for this conversation.","additionalProperties":{"type":"string"},"example":{"source":"website","campaign":"summer_sale"}},"language":{"type":"string","description":"The language code of the conversation.","example":"DE"},"lastAssignedOperatorId":{"type":"string","description":"The ID of the last assigned operator.","example":"op_abc123"},"lastSeen":{"type":"string","description":"Timestamp when the conversation was last seen.","example":"2025-10-05T12:30:00Z"}},"required":["contactId","channelId","channelType","name","environment"]},"CreateConversationRequestDto":{"type":"object","properties":{"conversation":{"description":"The conversation data to create.","allOf":[{"$ref":"#/components/schemas/CreateConversationDto"}]}},"required":["conversation"]},"UpdateConversation_TagsDto":{"type":"object","properties":{"tags":{"description":"The tags to set on the conversation.","example":["priority","sales"],"type":"array","items":{"type":"string"}}},"required":["tags"]},"ConversationButtonDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the button.","example":"btn_abc123"},"text":{"type":"string","description":"The display text of the button.","example":"Learn More"},"value":{"type":"string","description":"The value sent when the button is clicked.","example":"learn_more_clicked"}},"required":["id"]},"UpdateConversation_NotesDto":{"type":"object","properties":{"notes":{"description":"The notes to set on the conversation.","example":["Customer escalated to supervisor"],"type":"array","items":{"type":"string"}}},"required":["notes"]},"UpdateConversation_MentionsDto":{"type":"object","properties":{"mentions":{"description":"The user IDs to mention in the conversation.","example":["user_789"],"type":"array","items":{"type":"string"}}},"required":["mentions"]},"UpdateConversation_UserInputDto":{"type":"object","properties":{"redirect":{"type":"string","description":"The redirect destination for user input.","example":"flow_xyz789"},"isSensitive":{"type":"boolean","description":"Whether the user input contains sensitive data.","example":true}},"required":["redirect"]},"UpdateConversation_MetadataDto":{"type":"object","properties":{"metadata":{"type":"object","description":"The metadata to set on the conversation.","additionalProperties":{"type":"string"},"example":{"source":"website","campaign":"summer_sale"}}},"required":["metadata"]},"UpdateConversation_LeadAiConversationDto":{"type":"object","properties":{"flowId":{"type":"string","description":"The ID of the flow being executed.","example":"flow_abc123"},"stepId":{"type":"string","description":"The ID of the current step in the flow.","example":"step_def456"},"interactions":{"type":"number","description":"The number of interactions in this conversation.","example":10},"executionId":{"type":"string","description":"The unique execution ID for this conversation flow.","example":"exec_ghi789"}},"required":["flowId","stepId","interactions","executionId"]},"UpdateConversation_ConversationTeamDto":{"type":"object","properties":{"teamId":{"type":"string","description":"The ID of the team to assign to this conversation.","example":"team_sales_02"}},"required":["teamId"]},"UpdateConversationDto":{"type":"object","properties":{"contactId":{"type":"string","description":"The new contact ID.","example":"contact_xyz789"},"archived":{"type":"boolean","description":"Whether to archive the conversation.","example":true},"idToken":{"type":"string","description":"The new ID token.","example":"token_abc123"},"language":{"type":"string","description":"The new language code.","example":"en"},"operatorId":{"type":"string","description":"The new assigned operator ID.","example":"op_def456"},"photoUrl":{"type":"string","description":"The new photo URL for the contact.","example":"https://example.com/photos/user123.jpg"},"sessionCount":{"type":"number","description":"The new session count.","example":5},"tags":{"description":"Tags to set on the conversation.","allOf":[{"$ref":"#/components/schemas/UpdateConversation_TagsDto"}]},"unread":{"type":"boolean","description":"Whether the conversation has unread messages.","example":false},"lastBlock":{"description":"The last visited block in the flow.","allOf":[{"$ref":"#/components/schemas/ConversationBlockDto"}]},"lastButton":{"description":"The last clicked button.","allOf":[{"$ref":"#/components/schemas/ConversationButtonDto"}]},"providerId":{"type":"string","description":"The new external provider ID.","example":"wa_987654321"},"lastMessage":{"description":"The content of the last message.","allOf":[{"$ref":"#/components/schemas/ContentDto"}]},"notes":{"description":"Notes to set on the conversation.","allOf":[{"$ref":"#/components/schemas/UpdateConversation_NotesDto"}]},"snoozed":{"type":"string","description":"Timestamp until which the conversation is snoozed.","example":"2025-10-07T09:00:00Z"},"lastUserAction":{"type":"string","description":"Timestamp of the last user action.","example":"2025-10-05T14:30:00Z"},"mentions":{"description":"User mentions to set on the conversation.","allOf":[{"$ref":"#/components/schemas/UpdateConversation_MentionsDto"}]},"lastSender":{"type":"string","description":"The type of the last sender (user, bot, operator).","example":"operator"},"name":{"type":"string","description":"The new display name of the contact.","example":"Jane Doe"},"userInput":{"description":"The user input state.","allOf":[{"$ref":"#/components/schemas/UpdateConversation_UserInputDto"}]},"metadata":{"description":"Metadata to set on the conversation.","allOf":[{"$ref":"#/components/schemas/UpdateConversation_MetadataDto"}]},"leadAiConversation":{"description":"Lead AI conversation state.","allOf":[{"$ref":"#/components/schemas/UpdateConversation_LeadAiConversationDto"}]},"team":{"description":"The team to assign to this conversation.","allOf":[{"$ref":"#/components/schemas/UpdateConversation_ConversationTeamDto"}]},"lastUserInput":{"type":"string","description":"The last user input text.","example":"I need help with my order"},"state":{"description":"The new conversation state.\n\n- `0`: OPEN\n- `1`: BOT\n- `2`: IN_PROGRESS\n- `3`: CLOSED","allOf":[{"$ref":"#/components/schemas/ConversationStatus"}]},"lastAssignedOperatorId":{"type":"string","description":"The ID of the last assigned operator.","example":"op_ghi789"},"lastSeen":{"type":"string","description":"Timestamp when the conversation was last seen.","example":"2025-10-05T15:00:00Z"}}},"UpdateConversationRequestDto":{"type":"object","properties":{"conversation":{"description":"The conversation data to update.","allOf":[{"$ref":"#/components/schemas/UpdateConversationDto"}]}},"required":["conversation"]},"DeleteConversationResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the deletion was successful.","example":true},"error":{"type":"string","description":"Optional error message."}}},"HandleNewIncomingMessageRequest_MessageDto":{"type":"object","properties":{"providerMessageId":{"type":"string","description":"The message ID from the external provider.","example":"wamid.abc123xyz"},"content":{"description":"The content of the message.","allOf":[{"$ref":"#/components/schemas/ContentDto"}]},"sender":{"type":"string","description":"The sender type (user, bot, operator).","example":"user"},"type":{"type":"string","description":"The type of message content.","example":"text"},"status":{"type":"string","description":"The delivery status of the message.","example":"received"},"created":{"type":"string","description":"Timestamp when the message was created (ISO format).","example":"2025-10-05T10:00:00Z"},"outgoing":{"type":"boolean","description":"Whether this is an outgoing message.","example":false},"processed":{"type":"string","description":"Timestamp when the message was processed.","example":"2025-10-05T10:00:01Z"},"sent":{"type":"string","description":"Timestamp when the message was sent.","example":"2025-10-05T10:00:02Z"},"received":{"type":"string","description":"Timestamp when the message was received.","example":"2025-10-05T10:00:03Z"},"read":{"type":"string","description":"Timestamp when the message was read.","example":"2025-10-05T10:01:00Z"},"contextId":{"type":"string","description":"The context ID for message threading.","example":"ctx_abc123"},"messengerId":{"type":"string","description":"The messenger-specific ID.","example":"fb_msg_123"},"detectedLanguage":{"type":"string","description":"The detected language code of the message.","example":"en"}},"required":["providerMessageId","content","sender","type","status","created","outgoing"]},"HandleNewIncomingMessageRequest_ProfileDataDto":{"type":"object","properties":{"providerProfileId":{"type":"string","description":"The profile ID from the external provider.","example":"49123456789"},"name":{"type":"string","description":"The display name of the user.","example":"John Doe"},"profilePhotoUrl":{"type":"string","description":"The URL of the user's profile photo.","example":"https://example.com/photos/profile.jpg"},"language":{"type":"string","description":"The user's preferred language code.","example":"DE"},"timezone":{"type":"string","description":"The user's timezone.","example":"Europe/Berlin"},"email":{"type":"string","description":"The user's email address.","example":"john.doe@example.com"},"phoneNumber":{"type":"string","description":"The user's phone number.","example":"+49123456789"},"subject":{"type":"string","description":"The subject of the message (for email channels).","example":"Order inquiry"}}},"HandleNewIncomingMessageRequestDto":{"type":"object","properties":{"chatbotId":{"type":"string","description":"The ID of the chatbot.","example":"bot_abc123xyz"},"channelId":{"type":"string","description":"The ID of the channel.","example":"channel_def456"},"channelName":{"type":"string","description":"The name of the channel.","example":"WhatsApp Business"},"providerId":{"type":"string","description":"The external provider ID for the conversation.","example":"49123456789"},"message":{"description":"The incoming message data.","allOf":[{"$ref":"#/components/schemas/HandleNewIncomingMessageRequest_MessageDto"}]},"profileData":{"description":"The user's profile data.","allOf":[{"$ref":"#/components/schemas/HandleNewIncomingMessageRequest_ProfileDataDto"}]},"callee":{"type":"string","description":"The callee phone number (for voice channels).","example":"+4930123456"},"async":{"type":"boolean","description":"Whether to process the message asynchronously.","example":false}},"required":["chatbotId","channelId","channelName","providerId","message","profileData"]},"HandleIncomingResponseDto":{"type":"object","properties":{"conversationId":{"type":"string","description":"The ID of the affected conversation.","example":"conv_abc123xyz"},"messageId":{"type":"string","description":"The ID of the newly created message.","example":"msg_def456uvw"},"messages":{"description":"A list of messages generated as a response.","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["conversationId","messageId","messages"]},"HandleNewIncomingEventRequestDto":{"type":"object","properties":{"chatbotId":{"type":"string","description":"The ID of the chatbot.","example":"bot_abc123xyz"},"channelId":{"type":"string","description":"The ID of the channel.","example":"channel_def456"},"channelName":{"type":"string","description":"The name of the channel.","example":"WhatsApp Business"},"providerId":{"type":"string","description":"The external provider ID for the conversation.","example":"49123456789"},"profileData":{"description":"The user's profile data.","allOf":[{"$ref":"#/components/schemas/HandleNewIncomingMessageRequest_ProfileDataDto"}]},"event":{"type":"string","description":"The triggering event.","example":"user_seen_message"},"callee":{"type":"string","description":"The callee phone number (for voice channels).","example":"+4930123456"},"async":{"type":"boolean","description":"Whether to process the event asynchronously.","example":false}},"required":["chatbotId","channelId","channelName","providerId","profileData","event"]},"HandleNewIncomingStepPayloadRequestDto":{"type":"object","properties":{"chatbotId":{"type":"string","description":"The ID of the chatbot.","example":"bot_abc123xyz"},"conversationId":{"type":"string","description":"The ID of the conversation.","example":"conv_def456uvw"},"flowId":{"type":"string","description":"The ID of the flow to execute.","example":"flow_ghi789"},"stepId":{"type":"string","description":"The ID of the step to execute.","example":"step_jkl012"},"event":{"type":"string","description":"The event name to trigger.","example":"custom_event"},"eventPayload":{"type":"string","description":"JSON payload for the event.","example":"{\"orderId\": \"12345\"}"},"async":{"type":"boolean","description":"Whether to process asynchronously.","example":false},"isDebug":{"type":"boolean","description":"Whether this is a debug request.","example":false}},"required":["chatbotId","conversationId"]},"TriggerCustomConversationEventRequestDto":{"type":"object","properties":{"chatbotId":{"type":"string","description":"The ID of the chatbot.","example":"bot_abc123xyz"},"conversationId":{"type":"string","description":"The ID of the conversation.","example":"conv_def456uvw"},"event":{"type":"string","description":"The custom event name to trigger.","example":"order_completed"}},"required":["chatbotId","conversationId","event"]},"TriggerCustomConversationEventResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Optional error message."}}},"ListMessagesResponseDto":{"type":"object","properties":{"messages":{"description":"The list of messages.","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["messages"]},"MessageResponseDto":{"type":"object","properties":{"message":{"description":"The message.","allOf":[{"$ref":"#/components/schemas/MessageDto"}]},"error":{"type":"string","description":"Optional error message."}}},"CreateMessageDto":{"type":"object","properties":{"content":{"description":"The content of the message.","allOf":[{"$ref":"#/components/schemas/ContentDto"}]},"sender":{"type":"string","description":"The sender type.","example":"agent","enum":["agent","bot","user"]},"type":{"type":"string","description":"The type of message content.","example":"text"},"persona":{"description":"The persona used for this message.","allOf":[{"$ref":"#/components/schemas/MessagePersonaDto"}]},"providerMessageId":{"type":"string","description":"The message ID from the external provider.","example":"wamid.abc123xyz"},"status":{"type":"string","description":"The delivery status of the message.","example":"sent"},"created":{"type":"string","description":"Timestamp when the message was created (ISO format).","example":"2025-10-05T10:10:00Z"},"processed":{"type":"string","description":"Timestamp when the message was processed.","example":"2025-10-05T10:10:01Z"},"sent":{"type":"string","description":"Timestamp when the message was sent.","example":"2025-10-05T10:10:02Z"},"received":{"type":"string","description":"Timestamp when the message was received.","example":"2025-10-05T10:10:03Z"},"read":{"type":"string","description":"Timestamp when the message was read.","example":"2025-10-05T10:11:00Z"},"outgoing":{"type":"boolean","description":"Whether this is an outgoing message from the bot/operator.","example":false},"contextId":{"type":"string","description":"The context ID for message threading.","example":"ctx_abc123"},"messengerId":{"type":"string","description":"The messenger-specific ID.","example":"fb_msg_123"},"author":{"type":"string","description":"The author of the message (operator ID).","example":"op_john_doe"},"error":{"type":"string","description":"Optional error message."},"isSensitive":{"type":"boolean","description":"Whether the message contains sensitive data.","example":false},"leadAiId":{"type":"string","description":"The Lead AI ID associated with this message.","example":"lai_xyz789"},"streamGroupId":{"type":"string","description":"The stream group ID for grouped messages.","example":"stream_abc123"},"delay":{"type":"number","description":"Delay in milliseconds before sending.","example":1000}},"required":["content","sender","type","status","created","outgoing"]},"CreateMessageRequestDto":{"type":"object","properties":{"disableSending":{"type":"boolean","description":"Whether to skip sending the message to the channel.","example":false},"message":{"description":"The message data to create.","allOf":[{"$ref":"#/components/schemas/CreateMessageDto"}]}},"required":["disableSending","message"]},"UpdateMessage_TagsDto":{"type":"object","properties":{"tags":{"description":"The tags to set on the message.","example":["important","follow-up"],"type":"array","items":{"type":"string"}}},"required":["tags"]},"UpdateMessageDto":{"type":"object","properties":{"providerMessageId":{"type":"string","description":"The new provider message ID.","example":"wamid.xyz789"},"status":{"type":"string","description":"The new delivery status.","example":"delivered"},"processed":{"type":"string","description":"Timestamp when the message was processed.","example":"2025-10-05T10:10:01Z"},"sent":{"type":"string","description":"Timestamp when the message was sent.","example":"2025-10-05T10:10:02Z"},"received":{"type":"string","description":"Timestamp when the message was received.","example":"2025-10-05T10:10:03Z"},"read":{"type":"string","description":"Timestamp when the message was read.","example":"2025-10-05T10:11:00Z"},"tags":{"description":"Tags to set on the message.","allOf":[{"$ref":"#/components/schemas/UpdateMessage_TagsDto"}]},"messengerId":{"type":"string","description":"The new messenger-specific ID.","example":"fb_msg_456"},"transcript":{"type":"string","description":"The transcript of audio/video content.","example":"Hello, this is a voice message..."},"deleted":{"type":"boolean","description":"Whether to mark the message as deleted.","example":false},"error":{"type":"string","description":"Optional error message."},"isSensitive":{"type":"boolean","description":"Whether the message contains sensitive data.","example":false},"streamGroupId":{"type":"string","description":"The stream group ID for grouped messages.","example":"stream_def456"},"delay":{"type":"number","description":"Delay in milliseconds before sending.","example":500}}},"UpdateMessageRequestDto":{"type":"object","properties":{"message":{"description":"The message data to update.","allOf":[{"$ref":"#/components/schemas/UpdateMessageDto"}]}},"required":["message"]},"AddressDto":{"type":"object","properties":{"street":{"type":"string","description":"The street name.","example":"Example Street"},"country":{"type":"string","description":"The country name.","example":"Germany"},"zipcode":{"type":"string","description":"The postal/zip code.","example":"12345"},"houseNumber":{"type":"string","description":"The house number.","example":"1a"},"location":{"type":"string","description":"The city or location name.","example":"Berlin"}}},"OrganizationDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the organization.","example":"39aBv7wzR9cxd1Pxyz"},"name":{"type":"string","description":"The name of the organization.","example":"Example Company Ltd."},"created":{"type":"string","description":"Timestamp when the organization was created.","example":"2025-10-05T12:00:00Z"},"updated":{"type":"string","description":"Timestamp when the organization was last updated.","example":"2025-10-05T12:05:00Z"},"email":{"type":"string","format":"email","description":"The email address of the organization.","example":"contact@examplecompany.de"},"website":{"type":"string","format":"uri","description":"The website URL of the organization.","example":"https://www.examplecompany.de"},"size":{"type":"number","description":"The number of employees in the organization.","example":50},"industry":{"type":"string","description":"The industry of the organization.","example":"Software Development"},"address":{"description":"The address of the organization.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"variables":{"type":"object","description":"Custom variables as key-value pairs.","additionalProperties":{"type":"string"},"example":{"customer_number":"KD-12345"}}},"required":["id","name","created","updated","variables"]},"ListOrganizationsResponseDto":{"type":"object","properties":{"organizations":{"description":"The list of organizations.","type":"array","items":{"$ref":"#/components/schemas/OrganizationDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["organizations"]},"SearchResultHitOrganizationDto":{"type":"object","properties":{"organization":{"description":"The matching organization.","allOf":[{"$ref":"#/components/schemas/OrganizationDto"}]},"highlights":{"description":"List of highlighted match results.","type":"array","items":{"$ref":"#/components/schemas/HighlightResultDto"}},"textMatch":{"type":"string","description":"A combined string of all text matches.","example":"Musterfirma GmbH Software"}},"required":["organization","highlights","textMatch"]},"SearchOrganizationResultDto":{"type":"object","properties":{"facetCounts":{"description":"The facet counts for the search.","type":"array","items":{"$ref":"#/components/schemas/SearchResultFacetDto"}},"found":{"type":"number","description":"Total number of results found.","example":42},"hits":{"description":"The search result hits.","type":"array","items":{"$ref":"#/components/schemas/SearchResultHitOrganizationDto"}},"outOf":{"type":"number","description":"Total number of documents searched.","example":500},"page":{"type":"number","description":"The current page of search results.","example":1},"searchTimeMs":{"type":"number","description":"The search duration in milliseconds.","example":12}},"required":["facetCounts","found","hits","outOf","page","searchTimeMs"]},"SearchOrganizationResponseDto":{"type":"object","properties":{"results":{"description":"The search results.","nullable":true,"allOf":[{"$ref":"#/components/schemas/SearchOrganizationResultDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["results"]},"ContactDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the contact.","example":"59aBv7wzR9cxd1Pxyz"},"name":{"type":"string","description":"The display name of the contact.","example":"Max Mustermann"},"created":{"type":"string","description":"Timestamp when the contact was created.","example":"2025-10-05T10:00:00Z"},"updated":{"type":"string","description":"Timestamp when the contact was last updated.","example":"2025-10-05T10:05:00Z"},"email":{"type":"string","description":"The email address of the contact.","example":"max.mustermann@example.com"},"address":{"description":"The address of the contact.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"phoneNumber":{"type":"string","description":"The phone number of the contact.","example":"+4917612345678"},"variables":{"type":"object","description":"Custom variables as key-value pairs.","additionalProperties":{"type":"string"},"example":{"customer_id":"12345"}},"organizationIds":{"description":"List of organization IDs this contact belongs to.","example":["uq8BxZaJd2wZR9cxd1P"],"type":"array","items":{"type":"string"}},"whatsappId":{"type":"string","description":"The WhatsApp ID of the contact.","example":"49123456789"},"telegramId":{"type":"string","description":"The Telegram ID of the contact.","example":"123456789"},"facebookId":{"type":"string","description":"The Facebook ID of the contact.","example":"10158123456789012"},"instagramId":{"type":"string","description":"The Instagram ID of the contact.","example":"17841400123456789"},"avatar":{"type":"string","description":"The URL to the contact's avatar image.","example":"https://example.com/avatar.png"}},"required":["id","name","created","updated","variables","organizationIds"]},"ListOrganizationContactsResponseDto":{"type":"object","properties":{"contacts":{"description":"The list of contacts in the organization.","type":"array","items":{"$ref":"#/components/schemas/ContactDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["contacts"]},"CreateOrganizationRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the organization.","example":"Neue Firma GmbH"},"email":{"type":"string","description":"The email address of the organization.","example":"info@neue-firma.de"},"website":{"type":"string","description":"The website URL of the organization.","example":"https://neue-firma.de"},"size":{"type":"number","description":"The number of employees in the organization.","example":10},"industry":{"type":"string","description":"The industry of the organization.","example":"E-Commerce"},"address":{"description":"The address of the organization.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"phoneNumber":{"type":"string","description":"The phone number of the organization.","example":"+4915198765432"}},"required":["name"]},"OrganizationResponseDto":{"type":"object","properties":{"organization":{"description":"The organization.","allOf":[{"$ref":"#/components/schemas/OrganizationDto"}]},"error":{"type":"string","description":"Optional error message."}}},"UpdateOrganizationDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the organization.","example":"Updated Firma GmbH"},"email":{"type":"string","description":"The new email address of the organization.","example":"updated@firma.de"},"website":{"type":"string","description":"The new website URL of the organization.","example":"https://updated-firma.de"},"size":{"type":"number","description":"The new number of employees.","example":100},"industry":{"type":"string","description":"The new industry of the organization.","example":"Technology"},"address":{"description":"The new address of the organization.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"variables":{"type":"object","description":"Custom variables to set on the organization.","additionalProperties":{"type":"string"},"example":{"customer_number":"KD-67890"}}},"required":["variables"]},"UpdateOrganizationRequestDto":{"type":"object","properties":{"organization":{"description":"The organization data to update.","allOf":[{"$ref":"#/components/schemas/UpdateOrganizationDto"}]}},"required":["organization"]},"DeleteOrganizationResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the organization was successfully deleted.","example":true},"error":{"type":"string","description":"Optional error message."}}},"GetOrganizationContactsCountResponseDto":{"type":"object","properties":{"count":{"type":"number","description":"The number of contacts in the organization.","example":42},"error":{"type":"string","description":"Optional error message."}}},"VariableDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the variable (corresponds to the global variable ID).","example":"oxFRSIOBMF3gaiD3XRGK"},"name":{"type":"string","description":"The programmatic name of the variable.","example":"customer_name"},"type":{"type":"string","description":"The data type of the variable.","example":"string"},"value":{"type":"string","description":"The value assigned in this conversation.","example":"Max Mustermann"},"updated":{"type":"string","description":"The timestamp of the last update.","example":"2025-10-06T10:00:00Z"}},"required":["id","name","type","value","updated"]},"ListVariablesResponseDto":{"type":"object","properties":{"variables":{"description":"The list of conversation variables.","type":"array","items":{"$ref":"#/components/schemas/VariableDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["variables"]},"VariableResponseDto":{"type":"object","properties":{"variable":{"description":"The variable.","allOf":[{"$ref":"#/components/schemas/VariableDto"}]},"error":{"type":"string","description":"Optional error message."}}},"AssignValueToConversationVariableRequestDto":{"type":"object","properties":{"value":{"type":"string","description":"The new value to be assigned to the variable.","example":"Custom Value"}},"required":["value"]},"DeleteVariablesResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the deletion operation was successful.","example":true},"error":{"type":"string","description":"Optional error message."}}},"AssignValueToVariableRequestDto":{"type":"object","properties":{"value":{"type":"string","description":"The new value to be assigned to the variable.","example":"Custom Value"},"contactId":{"type":"string","description":"The id of the contact to assign the variable to.","example":"fdnklxaCACfw92b01v"}},"required":["value"]},"SearchResultHitContactDto":{"type":"object","properties":{"contact":{"description":"The matching contact.","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"highlights":{"description":"List of highlighted match results.","type":"array","items":{"type":"object"}},"textMatch":{"type":"string","description":"A combined string of all text matches.","example":"John Doe example@email.com"}},"required":["contact","highlights","textMatch"]},"SearchContactResultDto":{"type":"object","properties":{"facetCounts":{"description":"The facet counts for the search.","type":"array","items":{"type":"object"}},"found":{"type":"number","description":"Total number of results found.","example":42},"hits":{"description":"The search result hits.","type":"array","items":{"$ref":"#/components/schemas/SearchResultHitContactDto"}},"outOf":{"type":"number","description":"Total number of documents searched.","example":1000},"page":{"type":"number","description":"The current page of search results.","example":1},"searchTimeMs":{"type":"number","description":"The duration of the search in milliseconds.","example":15}},"required":["facetCounts","found","hits","outOf","page","searchTimeMs"]},"SearchContactsResponseDto":{"type":"object","properties":{"results":{"description":"The search results.","nullable":true,"allOf":[{"$ref":"#/components/schemas/SearchContactResultDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["results"]},"ListContactsResponseDto":{"type":"object","properties":{"contacts":{"description":"The list of contacts.","type":"array","items":{"$ref":"#/components/schemas/ContactDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["contacts"]},"ContactResponseDto":{"type":"object","properties":{"contact":{"description":"The contact.","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"error":{"type":"string","description":"Optional error message."}}},"CreateContactRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the contact.","example":"Max Example"},"language":{"type":"string","description":"The language of the contact.","example":"EN"},"email":{"type":"string","description":"The email address of the contact.","example":"max.mustermann@example.com"},"phoneNumber":{"type":"string","description":"The phone number of the contact.","example":"+4917612345678"},"whatsappId":{"type":"string","description":"The WhatsApp ID of the contact.","example":"49123456789"},"webId":{"type":"string","description":"The web channel ID of the contact.","example":"web_abc123xyz"},"instagramId":{"type":"string","description":"The Instagram ID of the contact.","example":"17841400123456789"},"facebookId":{"type":"string","description":"The Facebook ID of the contact.","example":"10158123456789012"},"telegramId":{"type":"string","description":"The Telegram ID of the contact.","example":"123456789"},"providerId":{"type":"string","description":"The ID of the contact with the external provider.","example":"provider_abc123"},"avatar":{"type":"string","format":"uri","description":"The URL to the avatar image of the contact.","example":"https://example.com/avatar.png"}},"required":["language"]},"UpdateContactDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the contact.","example":"Maximilian Example"},"email":{"type":"string","description":"The new email address of the contact.","example":"maximilian.mustermann@example.com"},"address":{"description":"The new address of the contact.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"phoneNumber":{"type":"string","description":"The new phone number of the contact.","example":"+4917612345678"},"variables":{"type":"object","description":"Custom variables to set on the contact.","additionalProperties":{"type":"string"},"example":{"customer_id":"12345"}},"organizationIds":{"description":"List of organization IDs to associate with the contact.","example":["uq8BxZaJd2wZR9cxd1P"],"type":"array","items":{"type":"string"}},"avatar":{"type":"string","format":"uri","description":"The URL to the contact's avatar image.","example":"https://example.com/avatar.png"},"language":{"type":"string","description":"The language code of the contact.","example":"EN"}},"required":["variables","organizationIds"]},"UpdateContactRequestDto":{"type":"object","properties":{"contact":{"description":"The contact data to update.","allOf":[{"$ref":"#/components/schemas/UpdateContactDto"}]}},"required":["contact"]},"DeleteContactResponseDto":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the contact was successfully deleted.","example":true},"error":{"type":"string","description":"Optional error message."}}},"ListContactOrganizationsResponseDto":{"type":"object","properties":{"organizations":{"description":"The list of organizations.","type":"array","items":{"$ref":"#/components/schemas/OrganizationDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["organizations"]},"AddConversationNotesRequestDto":{"type":"object","properties":{"notes":{"minItems":1,"description":"The notes to add to the conversation.","example":["Customer requested callback","Issue escalated to supervisor"],"type":"array","items":{"type":"string"}}},"required":["notes"]},"ConversationNotesResponseDto":{"type":"object","properties":{}},"RemoveConversationNotesRequestDto":{"type":"object","properties":{"notes":{"minItems":1,"description":"The notes to remove from the conversation.","example":["Resolved","Duplicate inquiry"],"type":"array","items":{"type":"string"}}},"required":["notes"]},"StatsExportResponseDto":{"type":"object","properties":{"exportId":{"type":"string","description":"The ID of the started export job.","example":"stsXOuKC7E4oNjym4Uy1"},"error":{"type":"string","description":"Optional error message."}},"required":["exportId"]},"GetStatsExportStatusResponseDto":{"type":"object","properties":{"status":{"type":"string","description":"The status of the export.","example":"completed"},"downloadUrl":{"type":"string","description":"URL to download the file when the export is completed.","example":"https://storage.googleapis.com/exports/export-123.csv"},"error":{"type":"string","description":"Optional error message."}},"required":["status"]},"AgentPerformanceEntryDto":{"type":"object","properties":{"operatorId":{"type":"string","description":"The unique identifier of the operator.","example":"op_abc123xyz"},"acceptedCount":{"type":"number","description":"The number of conversations accepted by the agent.","example":25},"avgJoinTimeSeconds":{"type":"number","description":"The average time in seconds for the agent to join a conversation.","example":45.5},"operatorName":{"type":"string","description":"The name of the operator.","example":"John Doe"}},"required":["operatorId","acceptedCount","avgJoinTimeSeconds","operatorName"]},"InboxReportDataDto":{"type":"object","properties":{"transferredToAgentCount":{"type":"number","description":"The number of conversations transferred to an agent.","example":150},"conversationAcceptedCount":{"type":"number","description":"The number of conversations accepted by agents.","example":120},"conversationNotAcceptedCount":{"type":"number","description":"The number of conversations not accepted by agents.","example":30},"averageJoinTimeSeconds":{"type":"number","description":"The average time in seconds for agents to join conversations.","example":60},"agentPerformance":{"description":"The list of agent performance entries.","type":"array","items":{"$ref":"#/components/schemas/AgentPerformanceEntryDto"}}},"required":["transferredToAgentCount","conversationAcceptedCount","conversationNotAcceptedCount","averageJoinTimeSeconds","agentPerformance"]},"GetInboxReportResponseDto":{"type":"object","properties":{"data":{"description":"The inbox report data.","nullable":true,"allOf":[{"$ref":"#/components/schemas/InboxReportDataDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["data"]},"StatsChatbotChannelDto":{"type":"object","properties":{"channelId":{"type":"string","description":"The unique id of the channel.","example":"656DSztzc13rF"},"channelName":{"type":"string","description":"The display name of the channel.","example":"Web Support"},"channelType":{"type":"string","description":"The type of the channel.","example":"voice"}},"required":["channelId","channelName","channelType"]},"StatsGetChannelsResponseDto":{"type":"object","properties":{"channels":{"description":"The list of channels associated with the chatbot.","type":"array","items":{"$ref":"#/components/schemas/StatsChatbotChannelDto"}}},"required":["channels"]},"ListWidgetConversationMessagesResponseDto":{"type":"object","properties":{"messages":{"description":"The list of messages.","type":"array","items":{"$ref":"#/components/schemas/MessageDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["messages"]},"CreateWidgetConversationRequestDto":{"type":"object","properties":{"widgetToken":{"type":"string","description":"The widget authentication token.","example":"widget_token_abc123xyz"},"channelId":{"type":"string","description":"The ID of the channel.","example":"channel_abc123"},"language":{"type":"string","description":"The language code for the conversation.","example":"DE"}},"required":["widgetToken","channelId","language"]},"CreateWidgetConversationResponseDto":{"type":"object","properties":{"conversation":{"description":"The newly created conversation.","nullable":true,"allOf":[{"$ref":"#/components/schemas/ConversationDto"}]},"newWebToken":{"type":"string","description":"A new web token if the previous one expired.","example":"new_widget_token_abc123"},"error":{"type":"string","description":"Optional error message."}},"required":["conversation"]},"CreateWidgetContactRequestDto":{"type":"object","properties":{"channelId":{"type":"string","description":"The ID of the channel.","example":"channel_abc123"},"channelToken":{"type":"string","description":"The channel authentication token.","example":"channel_token_xyz789"},"originUrl":{"type":"string","description":"The origin URL where the widget is embedded.","example":"https://example.com/contact"},"language":{"type":"string","description":"The language code for the widget.","example":"DE"}},"required":["channelId","channelToken","originUrl","language"]},"CreateWidgetContactResponseDto":{"type":"object","properties":{"contactId":{"type":"string","description":"The ID of the newly created contact.","example":"contact_abc123xyz"},"widgetToken":{"type":"string","description":"The widget authentication token for the new contact.","example":"widget_token_xyz789"},"error":{"type":"string","description":"Optional error message."}}},"KnowledgeSourceType":{"type":"number","enum":[0,1,-1],"description":"Sets the type of the source.\n\n- `0`: WEBSITE\n- `1`: PDF\n"},"KnowledgeSourceStatus":{"type":"number","enum":[0,1,2,3,4,-1],"description":"Sets the status of the source.\n\n- `0`: PENDING\n- `1`: INDEXING\n- `2`: INDEXED\n- `3`: ERROR\n- `4`: DELETING"},"KnowledgeSourceDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the knowledge source.","example":"bWDWW8q3ks31wQsc6xiD"},"source":{"type":"string","description":"The url or filepath of the source.","example":"https://www.example-company.com/faq"},"groupIds":{"description":"A list of group ID's that the source is used in.","example":["meEcrKgnNHuBqDFXc3Pv"],"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean","description":"Indicates whether the knowledge source is enabled (true) or disabled (false).","example":true},"isIndexing":{"type":"boolean","description":"Sets the indexing status of the source.","example":false},"created":{"type":"string","description":"Creation timestamp (ISO format).","example":"2025-09-29T10:00:00Z"},"type":{"description":"Sets the type of the source.\n\n- `0`: WEBSITE\n- `1`: PDF\n","example":0,"allOf":[{"$ref":"#/components/schemas/KnowledgeSourceType"}]},"status":{"description":"Sets the status of the source.\n\n- `0`: PENDING\n- `1`: INDEXING\n- `2`: INDEXED\n- `3`: ERROR\n- `4`: DELETING","example":2,"allOf":[{"$ref":"#/components/schemas/KnowledgeSourceStatus"}]},"name":{"type":"string","description":"Sets the name of the source.","example":"FAQ page"},"errorReason":{"type":"string","description":"The reason for the potential error.","example":"Source not found."},"metadata":{"type":"object","description":"Additional custom metadata as key-value pairs.","additionalProperties":{"type":"string"}}},"required":["id","source","groupIds","enabled","isIndexing","created","type","status","name","metadata"]},"ListKnowledgeSourcesResponseDto":{"type":"object","properties":{"sources":{"description":"A list of retrieved knowledge sources.","type":"array","items":{"$ref":"#/components/schemas/KnowledgeSourceDto"}},"error":{"type":"string","description":"Optional error message"},"pageToken":{"type":"string","description":"The date of the latest fetched source.","example":"2025-09-29T07:08:00Z"}},"required":["sources","pageToken"]},"GetKnowledgeSourceResponseDto":{"type":"object","properties":{"source":{"description":"The retrieved knowledge source.","nullable":true,"allOf":[{"$ref":"#/components/schemas/KnowledgeSourceDto"}]},"error":{"type":"string","description":"Optional error message"},"chunksContent":{"description":"Content of the source split into chunks.","example":["Some Paragraph.","Another Paragraph"],"type":"array","items":{"type":"string"}}},"required":["source","chunksContent"]},"DeleteKnowledgeSourceBatchRequestDto":{"type":"object","properties":{"sourceIds":{"description":"A list of deleted source Id's.","examples":["10ß443d31264etg","ufhiew7820ja"],"type":"array","items":{"type":"string"}}},"required":["sourceIds"]},"DeleteKnowledgeSourceResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Optional error message."},"deleted":{"type":"boolean","description":"Indicates whether the deletion succeeded.","example":true}},"required":["deleted"]},"UploadFilesDto":{"type":"object","properties":{"files":{"type":"array","description":"Files to be uploaded as knowledge sources.","items":{"type":"string","format":"binary"}}},"required":["files"]},"UploadKnowledgeSourceFilesResponseDto":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the upload was successful.","example":true},"error":{"type":"string","description":"Optional error message."}}},"KnowledgeGroupDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the knowledge group.","example":"zwMeh3bYIMZQfzOqDFiO"},"name":{"type":"string","description":"Name of the knowledge group.","example":"General FAQs"},"created":{"type":"string","description":"Creation timestamp (ISO format).","example":"2025-09-29T07:08:00Z"},"systemDefault":{"type":"boolean","description":"Indicates whether this is a system-created default group.","example":false},"sourceIds":{"description":"List of source IDs assigned to this group.","example":["2BkwBSWySONimJWNwtws"],"type":"array","items":{"type":"string"}}},"required":["id","name","created","systemDefault","sourceIds"]},"ListKnowledgeGroupsResponseDto":{"type":"object","properties":{"groups":{"description":"A list of groups.","type":"array","items":{"$ref":"#/components/schemas/KnowledgeGroupDto"}},"error":{"type":"string","description":"Optional error message."},"pageToken":{"type":"string","description":"The date of the latest fetched group.","example":"2025-09-29T07:08:00Z"}},"required":["groups","pageToken"]},"CreateKnowledgeGroupRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the new knowledge group.","example":"General FAQs"}},"required":["name"]},"KnowledgeGroupResponseDto":{"type":"object","properties":{"group":{"description":"A knowledge group containing knowledge sources.","nullable":true,"allOf":[{"$ref":"#/components/schemas/KnowledgeGroupDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["group"]},"UpdateKnowledgeGroupDto":{"type":"object","properties":{"name":{"type":"string","description":"Optional new name of the knowledge group.","example":"Product information Q4 2025"},"sourceIds":{"description":"List of source IDs that should be linked to the knowledge group.","example":["hC79d9u4lUjGWUCTzhSF","PkF60rG0wzDg3ZhJlaXp"],"type":"array","items":{"type":"string"}}},"required":["sourceIds"]},"UpdateKnowledgeGroupRequestDto":{"type":"object","properties":{"updated":{"description":"Object containing the knowledge group fields to update.","nullable":true,"allOf":[{"$ref":"#/components/schemas/UpdateKnowledgeGroupDto"}]}},"required":["updated"]},"DeleteKnowledgeGroupResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Optional error message."}}},"AudiocodesSettings_TtsDto":{"type":"object","properties":{"provider":{"type":"string","description":"The TTS provider.","example":"11labs"},"voice":{"type":"string","description":"The ID of the voice to be used.","example":"elevenlabs:CwhRBWXzGAHq8TQ4Fs17"},"languageDetectable":{"type":"boolean","description":"Whether this voice is available for language detection.","example":true}},"required":["provider","voice","languageDetectable"]},"ConfusionMatrixEntryDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the confusion matrix entry.","example":"entry1"},"normalizedValue":{"type":"number","description":"The normalized value of the entry.","example":0.5},"rawValue":{"type":"number","description":"The raw value of the entry.","example":50}},"required":["id","normalizedValue","rawValue"]},"ConfusionMatrixDto":{"type":"object","properties":{"confusionMatrixEntries":{"description":"The entries of the confusion matrix.","type":"array","items":{"$ref":"#/components/schemas/ConfusionMatrixEntryDto"}}},"required":["confusionMatrixEntries"]},"EvaluationMetricsDto":{"type":"object","properties":{"f1":{"type":"number","description":"The F1 score.","example":0.95},"precision":{"type":"number","description":"The precision score.","example":0.94},"recall":{"type":"number","description":"The recall score.","example":0.96},"truePositiveCount":{"type":"number","description":"The number of true positives.","example":96},"trueNegativeCount":{"type":"number","description":"The number of true negatives.","example":98},"falsePositiveCount":{"type":"number","description":"The number of false positives.","example":2},"falseNegativeCount":{"type":"number","description":"The number of false negatives.","example":4}},"required":["f1","precision","recall","truePositiveCount","trueNegativeCount","falsePositiveCount","falseNegativeCount"]},"StepFlowOutletDto":{"type":"object","properties":{"stepId":{"type":"string","description":"The ID of the step this outlet points to.","example":"step123"},"name":{"type":"string","description":"The name of the flow outlet.","example":"Success"}},"required":["stepId","name"]},"WhatsAppTemplateTranslationsButtonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of the button (e.g., QUICK_REPLY, URL, PHONE_NUMBER).","example":"QUICK_REPLY"},"text":{"type":"string","description":"The display text of the button.","example":"Confirm"},"url":{"type":"string","description":"The URL to open when the button is clicked (for URL type buttons).","example":"https://example.com/order/{{1}}"},"phoneNumber":{"type":"string","description":"The phone number to call when the button is clicked (for PHONE_NUMBER type buttons).","example":"+1234567890"}},"required":["type","text"]},"WhatsAppTemplateTranslationsCreateDto":{"type":"object","properties":{"bodyText":{"type":"string","description":"The body text of the template. Supports placeholders like {{1}}.","example":"Thank you for your order {{1}}."},"buttons":{"description":"The buttons to attach to the template.","type":"array","items":{"$ref":"#/components/schemas/WhatsAppTemplateTranslationsButtonDto"}},"footerText":{"type":"string","description":"The text to display in the footer.","example":"Your support team"},"headerText":{"type":"string","description":"The text to display in the header.","example":"Order confirmation"},"headerType":{"type":"string","description":"The type of the header (e.g., TEXT, IMAGE, VIDEO, DOCUMENT).","example":"TEXT"},"language":{"type":"string","description":"The language code (ISO 639-1) for this translation.","example":"DE"}},"required":["bodyText","buttons","footerText","headerText","headerType","language"]},"WhatsAppTemplateTranslationsDto":{"type":"object","properties":{"bodyText":{"type":"string","description":"The body text of the translation.","example":"Thank you for your order {{1}}."},"buttonType":{"type":"string","description":"The type of buttons.","example":"QUICK_REPLY"},"buttons":{"description":"The buttons attached to the template.","type":"array","items":{"$ref":"#/components/schemas/WhatsAppTemplateTranslationsButtonDto"}},"createdAt":{"type":"string","description":"Timestamp of creation.","example":"2025-10-03T12:00:00Z"},"footerText":{"type":"string","description":"The text in the footer.","example":"Your support team"},"headerMediaType":{"type":"string","description":"The media type of the header (e.g., \"TEXT\").","example":"TEXT"},"headerText":{"type":"string","description":"The text in the header.","example":"Order confirmation"},"headerType":{"type":"string","description":"The type of the header.","example":"TEXT"},"language":{"type":"string","description":"The language code (ISO 639-1).","example":"DE"},"rejectReason":{"type":"string","description":"The reason for rejection, if applicable.","example":"Content policy violation"},"status":{"type":"string","description":"The status of the translation (e.g., \"APPROVED\").","example":"APPROVED"},"templateId":{"type":"string","description":"The ID of the template at Meta.","example":"123456789012345"},"updatedAt":{"type":"string","description":"Timestamp of the last update.","example":"2025-10-03T12:05:00Z"}},"required":["bodyText","buttons","createdAt","footerText","headerMediaType","headerText","headerType","language","rejectReason","status","templateId","updatedAt"]}}}}