# Bot
{% hint style="info" %}
**API SUBPATH**: eva-bot
{% endhint %}
### Paginations and Listings
## List bots (v2)
> Returns a paginated list of bots for a given user, environment, and organization. Supports search and sorting.
```json
{"openapi":"3.0.1","info":{"title":"eva-bot API Documentation","version":"4.8.0"},"tags":[{"name":"bots","description":"External management for Bots"}],"paths":{"/org/{orgUUID}/env/{envUUID}/v2/bots":{"get":{"tags":["bots"],"summary":"List bots (v2)","description":"Returns a paginated list of bots for a given user, environment, and organization. Supports search and sorting.","operationId":"listBotsV2","parameters":[{"name":"orgUUID","in":"path","description":"A valid UUID of the organization","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid UUID of the environment","required":true,"schema":{"type":"string"}},{"name":"searchTerm","in":"query","description":"Optional search term to filter bots","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number (1-based index)","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"linesPerPage","in":"query","description":"Number of items per page","required":false,"schema":{"type":"integer","format":"int32","default":7}},{"name":"orderBy","in":"query","description":"Field to sort by","required":false,"schema":{"type":"string","default":"createdAt"}},{"name":"direction","in":"query","description":"Sort direction: ASC or DESC","required":false,"schema":{"type":"string","default":"DESC"}}],"responses":{"200":{"description":"List of bots returned successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentResponseDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}}}}}},"components":{"schemas":{"AgentResponseDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of the bot"},"name":{"type":"string","description":"Name of the bot"},"description":{"type":"string","description":"Description of the bot"},"companyName":{"type":"string","description":"Name of the company associated with the bot"},"locale":{"type":"string","description":"Locale or language of the bot"},"industry":{"type":"string","description":"Industry in which the bot operates"},"image":{"$ref":"#/components/schemas/ImageResponseDTO"},"engine":{"$ref":"#/components/schemas/EngineResponseDTO"},"channel":{"$ref":"#/components/schemas/ChannelCreatedDTO"},"analytic":{"$ref":"#/components/schemas/AnalyticDTO"}},"description":"DTO representing a bot's metadata and configuration details."},"ImageResponseDTO":{"type":"object","properties":{"url":{"type":"string","description":"URL of the bot's image"},"contentType":{"type":"string","description":"MIME type of the image"},"botHasCustomImage":{"type":"boolean","description":"Indicates whether the bot has a custom image"}},"description":"DTO containing metadata about the bot's image"},"EngineResponseDTO":{"type":"object","properties":{"nlu":{"$ref":"#/components/schemas/NLUEngineConfigurationResponseDTO"},"kai":{"$ref":"#/components/schemas/KAIEngineConfigurationResponseDTO"},"agentic":{"$ref":"#/components/schemas/AgenticEngineConfigurationResponseDTO"},"isHybrid":{"type":"boolean","description":"Indicates whether the engine setup is hybrid"},"isAgentic":{"type":"boolean","description":"Indicates whether the engine setup is agentic"},"isClever":{"type":"boolean","description":"Indicates whether the engine is clever"},"isBotLLM":{"type":"boolean","description":"Indicates whether the engine is based on a bot LLM"}},"description":"DTO representing the response configuration of multiple engines"},"NLUEngineConfigurationResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the NLU engine","format":"int64"},"name":{"type":"string","description":"Name of the NLU engine"},"first":{"type":"boolean","description":"Indicates whether this is the first engine"},"metadata":{"type":"string","description":"Additional metadata related to the engine"},"nlutype":{"type":"string","description":"Enumeration of supported NLU engine types","enum":["NLUEngineType.CLEVER(value=Clever)","NLUEngineType.DIALOGFLOW(value=DialogFlow)","NLUEngineType.LEX(value=Lex)","NLUEngineType.LUIS(value=Luis)","NLUEngineType.WATSON(value=Watson)","NLUEngineType.OPENAI(value=OpenAI)","NLUEngineType.AZURE_OPENAI(value=Azure OpenAI)","NLUEngineType.EVA_AZURE_OPENAI(value=eva Azure OpenAI)"]}},"description":"DTO representing the configuration response of an NLU engine"},"KAIEngineConfigurationResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the KAI engine.","format":"int64"},"name":{"type":"string","description":"Name of the KAI engine"},"metadata":{"type":"string","description":"Additional metadata related to the engine"}},"description":"Represents the configuration response of the KAI Engine."},"AgenticEngineConfigurationResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the AGENTIC engine.","format":"int64"},"name":{"type":"string","description":"Name of the AGENTIC engine"},"first":{"type":"boolean","description":"Indicates whether this is the first engine"},"metadata":{"type":"string","description":"Additional metadata related to the engine"}},"description":"Represents the configuration response of the Agentic Engine."},"ChannelCreatedDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of the channel"},"botUuid":{"type":"string","description":"Unique identifier of the associated bot"},"name":{"type":"string","description":"Name of the channel"},"description":{"type":"string","description":"Description of the channel"},"channelType":{"$ref":"#/components/schemas/ChannelTypeDTO"},"createdAt":{"type":"string","description":"Timestamp when the channel was created","format":"date-time"},"updatedAt":{"type":"string","description":"Timestamp when the channel was last updated","format":"date-time"}},"description":"DTO representing a created channel"},"ChannelTypeDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the channel type","format":"int64"},"name":{"type":"string","description":"Name of the channel type"},"image":{"type":"string","description":"Image path representing the channel type"},"channelClassification":{"$ref":"#/components/schemas/ChannelClassificationDTO"}},"description":"DTO representing a channel type"},"ChannelClassificationDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the classification","format":"int64"},"name":{"type":"string","description":"Name of the classification"}},"description":"DTO representing a channel classification"},"AnalyticDTO":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key used for analytics integration"}},"description":"DTO containing the analytics API key used for bot monitoring and tracking"},"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"BotErrorDTO":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}}}}}
```
## GET /org/{orgUUID}/env/{envUUID}/bots
> Paginates through all Bots in an Environment. Removed Bots are not\
> retrieved, and neither are Bots whose the current used has no access to.
```json
{"openapi":"3.0.1","info":{"title":"eva-bot API Documentation","version":"4.8.0"},"tags":[{"name":"bots","description":"External management for Bots"}],"paths":{"/org/{orgUUID}/env/{envUUID}/bots":{"get":{"tags":["bots"],"summary":"Paginates through all Bots in an Environment. Removed Bots are not\nretrieved, and neither are Bots whose the current used has no access to.\n","operationId":"listBots","parameters":[{"name":"orgUUID","in":"path","description":"A valid uuid of organization","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid uuid of environment","required":true,"schema":{"type":"string"}},{"name":"searchTerm","in":"query","description":"Term being searched. This expects one optional String matching the name of a bot, left to right from the beginning of it's name.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Current page, starting at 1.","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"linesPerPage","in":"query","description":"Items per page, defaulted to 7.","required":false,"schema":{"type":"integer","format":"int32","default":7}},{"name":"orderBy","in":"query","description":"Criteria to order result, defaulted to createdAt date.","required":false,"schema":{"type":"string","default":"createdAt"}},{"name":"direction","in":"query","description":"Order direction(ASC/DESC), defaulted to DESC","required":false,"schema":{"type":"string","default":"DESC"}}],"responses":{"200":{"description":"Ok","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageChannelBotDataDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}}}}}},"components":{"schemas":{"PageChannelBotDataDTO":{"type":"object","properties":{"totalPages":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"pageable":{"$ref":"#/components/schemas/PageableObject"},"numberOfElements":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"$ref":"#/components/schemas/ChannelBotDataDTO"}},"number":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/SortObject"},"first":{"type":"boolean"},"last":{"type":"boolean"},"empty":{"type":"boolean"}}},"PageableObject":{"type":"object","properties":{"paged":{"type":"boolean"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"unpaged":{"type":"boolean"},"offset":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/SortObject"}}},"SortObject":{"type":"object","properties":{"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"},"empty":{"type":"boolean"}}},"ChannelBotDataDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Bot's uuid"},"name":{"type":"string","description":"Bot's name"},"description":{"type":"string","description":"Bot's description"},"industry":{"type":"string","description":"Type of bot business"},"locale":{"type":"string","description":"Bot's locale"},"nlpId":{"type":"integer","description":"Bot's nlp id","format":"int64"},"nlp":{"type":"string","description":"Bot's nlp"},"metadata":{"type":"string","description":"Bot's metadata nlp"},"image":{"type":"string","description":"Bot's url image"},"contentType":{"type":"string","description":"Bot's content type of image"},"botHasCustomImage":{"type":"boolean","description":"Tells you whether received image belongs to bot or is a default image"},"isClever":{"type":"boolean","description":"True if bot is clever, false if not"},"isBotLLM":{"type":"boolean","description":"True if bot is LLM, false if not"},"channel":{"$ref":"#/components/schemas/ChannelCreatedDTO"},"api_key":{"type":"string","description":"Bot's key to analytic platform. Ex: chatbase, dashbot..."}},"description":"DTO returned when a bot is created, including the associated channel data."},"ChannelCreatedDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of the channel"},"botUuid":{"type":"string","description":"Unique identifier of the associated bot"},"name":{"type":"string","description":"Name of the channel"},"description":{"type":"string","description":"Description of the channel"},"channelType":{"$ref":"#/components/schemas/ChannelTypeDTO"},"createdAt":{"type":"string","description":"Timestamp when the channel was created","format":"date-time"},"updatedAt":{"type":"string","description":"Timestamp when the channel was last updated","format":"date-time"}},"description":"DTO representing a created channel"},"ChannelTypeDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the channel type","format":"int64"},"name":{"type":"string","description":"Name of the channel type"},"image":{"type":"string","description":"Image path representing the channel type"},"channelClassification":{"$ref":"#/components/schemas/ChannelClassificationDTO"}},"description":"DTO representing a channel type"},"ChannelClassificationDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the classification","format":"int64"},"name":{"type":"string","description":"Name of the classification"}},"description":"DTO representing a channel classification"},"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"BotErrorDTO":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}}}}}
```
## GET /org/{orgUUID}/env/{envUUID}/quicksearch
> Searches (greedily) for any tag names that exists in a bot, matching the typed term, left-to-right, and returns a list of up to 6 Strings, ordered alphabetically.
```json
{"openapi":"3.0.1","info":{"title":"eva-bot API Documentation","version":"4.8.0"},"tags":[{"name":"bots","description":"External management for Bots"}],"paths":{"/org/{orgUUID}/env/{envUUID}/quicksearch":{"get":{"tags":["bots"],"summary":"Searches (greedily) for any tag names that exists in a bot, matching the typed term, left-to-right, and returns a list of up to 6 Strings, ordered alphabetically.","operationId":"autocompleteSearch","parameters":[{"name":"orgUUID","in":"path","description":"A valid organization Uuid","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid environment Uuid","required":true,"schema":{"type":"string"}},{"name":"searchTerm","in":"query","description":"Term being searched","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"How many items will be returned in the list. Defaults to 6.","required":false,"schema":{"type":"integer","format":"int32","default":6}}],"responses":{"200":{"description":"Ok","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}}}}}},"components":{"schemas":{"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"BotErrorDTO":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}}}}}
```
## GET /org/{orgUUID}/env/{envUUID}/bots/simple
> Retrieves a list containing simplified information from all Bots within an Environment. Does not retrieve removed Bots.
```json
{"openapi":"3.0.1","info":{"title":"eva-bot API Documentation","version":"4.8.0"},"tags":[{"name":"bots","description":"External management for Bots"}],"paths":{"/org/{orgUUID}/env/{envUUID}/bots/simple":{"get":{"tags":["bots"],"summary":"Retrieves a list containing simplified information from all Bots within an Environment. Does not retrieve removed Bots.","operationId":"findSimpleBotList","parameters":[{"name":"orgUUID","in":"path","description":"A valid uuid of organization","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid uuid of environment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SimpleBotListDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}}}}}},"components":{"schemas":{"SimpleBotListDTO":{"type":"object","properties":{"data":{"type":"array","description":"Data","items":{"$ref":"#/components/schemas/SimpleBotDTO"}}},"description":"List returned with simple information about bots of environment."},"SimpleBotDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Bot's uuid"},"name":{"type":"string","description":"Bot's name"},"locale":{"type":"string","description":"Bot's locale"},"image":{"type":"string","description":"Bot's image"}},"description":"Simple data of bot."},"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"BotErrorDTO":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}}}}}
```
### CRUD Operation
## Create a new bot (v2)
> Creates a new bot in the specified environment and organization using the provided configuration data.
```json
{"openapi":"3.0.1","info":{"title":"eva-bot API Documentation","version":"4.8.0"},"tags":[{"name":"bots","description":"External management for Bots"}],"paths":{"/org/{orgUUID}/env/{envUUID}/v2/bots":{"post":{"tags":["bots"],"summary":"Create a new bot (v2)","description":"Creates a new bot in the specified environment and organization using the provided configuration data.","operationId":"createV2","parameters":[{"name":"orgUUID","in":"path","description":"A valid UUID of the organization","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid UUID of the environment","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRequestDTO"}}},"required":true},"responses":{"201":{"description":"Bot created successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentResponseDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden - user does not have permission to create a bot","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity - invalid input data","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}}}}}},"components":{"schemas":{"AgentRequestDTO":{"required":["channel","companyName","description","engine","industry","locale","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the agent"},"description":{"type":"string","description":"A brief description of the agent"},"locale":{"type":"string","description":"The locale of the agent"},"industry":{"type":"string","description":"The industry the agent is associated with"},"companyName":{"type":"string","description":"The name of the company"},"image":{"type":"string","description":"Optional image URL or base64 string"},"engine":{"$ref":"#/components/schemas/EngineRequestDTO"},"analytic":{"$ref":"#/components/schemas/AnalyticDTO"},"channel":{"$ref":"#/components/schemas/ChannelDTO"}},"description":"Data to create a new bot"},"EngineRequestDTO":{"type":"object","properties":{"nlu":{"$ref":"#/components/schemas/NLUEngineConfigurationDTO"},"agentic":{"$ref":"#/components/schemas/PersonaAgenticEngineConfigurationDTO"},"llm":{"type":"boolean"}},"description":"DTO that encapsulates configuration data for NLU and Agentic engines used by an agent."},"NLUEngineConfigurationDTO":{"required":["first","metadata","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the NLU engine"},"first":{"type":"boolean","description":"Indicates whether this engine should be executed first"},"metadata":{"type":"string","description":"Metadata associated with the engine configuration"},"nlutype":{"type":"string","description":"Enumeration of supported NLU engine types","enum":["NLUEngineType.CLEVER(value=Clever)","NLUEngineType.DIALOGFLOW(value=DialogFlow)","NLUEngineType.LEX(value=Lex)","NLUEngineType.LUIS(value=Luis)","NLUEngineType.WATSON(value=Watson)","NLUEngineType.OPENAI(value=OpenAI)","NLUEngineType.AZURE_OPENAI(value=Azure OpenAI)","NLUEngineType.EVA_AZURE_OPENAI(value=eva Azure OpenAI)"]}},"description":"Configuration DTO for an NLU engine."},"PersonaAgenticEngineConfigurationDTO":{"required":["first","metadata","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the Agentic engine"},"first":{"type":"boolean","description":"Indicates if this engine should be executed first"},"metadata":{"type":"string","description":"Metadata associated with the engine configuration"},"persona":{"$ref":"#/components/schemas/PersonaDTO"},"agenticType":{"type":"string","description":"Enumeration of supported Agentic LLM engine types.","enum":["AgenticEngineType.OPENAI(value=OpenAI)","AgenticEngineType.AZURE_OPENAI(value=Azure OpenAI)","AgenticEngineType.EVA_AZURE_OPENAI(value=eva Azure OpenAI)"]}},"description":"Configuration DTO for an Agentic engine within a persona."},"PersonaDTO":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the persona"},"image":{"type":"string","description":"An optional image representing the persona"},"backstory":{"type":"string","description":"A narrative backstory that defines the persona's origin or context"},"personality":{"type":"string","description":"A description of the persona's personality traits"},"communicationStyle":{"type":"string","description":"Enumeration of communication styles used by an agent.","enum":["POLITE_AND_PERSUASIVE","WITTY_AND_CASUAL","EMPATHETIC_AND_HELPFUL","CONCISE_AND_PROFESSIONAL","FRIENDLY_AND_APPROACHABLE"]}},"description":"DTO representing a persona configuration for an Agentic engine."},"AnalyticDTO":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key used for analytics integration"}},"description":"DTO containing the analytics API key used for bot monitoring and tracking"},"ChannelDTO":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the communication channel"},"description":{"type":"string","description":"An optional description of the channel"},"type":{"type":"integer","description":"Numeric identifier representing the type of channel","format":"int64"},"ivrConfiguration":{"$ref":"#/components/schemas/IvrConfigurationDTO"}},"description":"DTO representing a communication channel configuration for an agent."},"IvrConfigurationDTO":{"required":["dnis","secret","vendor"],"type":"object","properties":{"vendor":{"maxLength":14,"type":"string","description":"Type of ivr, e.g. EVG and VXML."},"dnis":{"type":"string","description":"Number where the call was received. This is usually the local call center number."},"secret":{"type":"string","description":"Authentication key for the IVR."},"fetchData":{"$ref":"#/components/schemas/FetchDataDTO"},"transferCall":{"$ref":"#/components/schemas/TransferCallDTO"},"defaultErrorHandling":{"$ref":"#/components/schemas/ErrorHandlingDTO"},"callEstablishmentErrorHandling":{"$ref":"#/components/schemas/ErrorHandlingDTO"},"settings":{"$ref":"#/components/schemas/SettingsDTO"},"ttsAudioConfiguration":{"$ref":"#/components/schemas/TtsAudioConfigurationDTO"},"dtmfMenu":{"$ref":"#/components/schemas/DtmfMenuDTO"},"voiceMenu":{"$ref":"#/components/schemas/VoiceMenuDTO"}},"description":"Represents the IVR configuration for a channel."},"FetchDataDTO":{"required":["timeoutInterval"],"type":"object","properties":{"timeoutInterval":{"maximum":60000,"minimum":10,"type":"integer","description":"The default amount of time in milliseconds the IVR will wait for a page/json fetch.","format":"int64","default":45000},"audio":{"$ref":"#/components/schemas/AudioDTO"}},"description":"Represents the configuration for fetching data during an IVR interaction."},"AudioDTO":{"type":"object","properties":{"url":{"maxLength":2048,"type":"string","description":"The path to the default audio file to be used during IVR platform fetch events."},"delay":{"maximum":60000,"minimum":0,"type":"integer","description":"The default value for the fetch audio delay","format":"int64","default":0},"minimum":{"maximum":60000,"minimum":0,"type":"integer","description":"The minimum time in milliseconds to play a fetch audio source","format":"int64","default":0},"interval":{"maximum":60000,"minimum":0,"type":"integer","description":"Controls the time interval between fetch audio loops","format":"int64","default":0}},"description":"Represents the audio configuration for fetch events in IVR."},"TransferCallDTO":{"type":"object","properties":{"uui":{"maxLength":4096,"type":"string","description":"A custom message that will be transferred along with the call via the user-to-user SIP header. We recommend to use a hexadecimal encoding."},"destination":{"maxLength":4096,"type":"string","description":"Call destination, where it will be transferred to. You can declare it as sip or tel."}},"description":"Represents the transfer call information."},"ErrorHandlingDTO":{"required":["transferOnError"],"type":"object","properties":{"transferOnError":{"type":"boolean","description":"When set to true the call will be transferred after the message is played, when set to false or when the property is not specified the call will be terminated after the message. To make the call transfer we will use the default transfer settings."},"audio":{"$ref":"#/components/schemas/AudioDTO"},"tts":{"maxLength":4096,"type":"string","description":"The field content will be synthesized by the IVR, you can fill it with free text or with an SSML."},"transferCall":{"$ref":"#/components/schemas/TransferCallDTO"}},"description":"Represents error handling configurations for the IVR."},"SettingsDTO":{"required":["conversationTimeout","firstConversationRequest","maxCallDuration","regionalExpressionsFileUrl","sendPostCallEvents","welcomeTimeout"],"type":"object","properties":{"firstConversationRequest":{"maximum":4096,"type":"string","description":"If you want to start the conversation with a different flow, fill in this field.","default":"{\"text\":\"\",\"code\":\"%EVA_WELCOME_MSG\",\"context\":{}}"},"conversationTimeout":{"maximum":300000,"minimum":10,"type":"integer","description":"Maximum waiting time for eva response.","format":"int64","default":40000},"sendPostCallEvents":{"type":"boolean","description":"Sends messages to eva such as: user disconnected.","default":true},"regionalExpressionsFileUrl":{"maxLength":2048,"type":"string","description":"This property gives a contextual understanding of expressions and words variations. For example, in English it's common to say O (letter) instead of zero when giving a phone number. To help the STT intelligence understand this is the number 0 and not a letter, you can use a JSON file that gathers all 'Regional Expressions'"},"welcomeTimeout":{"maximum":300000,"minimum":10,"type":"integer","description":"Maximum waiting time for eva response the welcome flow.","format":"int64","default":40000},"maxCallDuration":{"maximum":1800000,"minimum":1000,"type":"integer","description":"Maximum temple that a call can be active, property used to counter loop errors.","format":"int64","default":300000}},"description":"Represents settings for IVR configuration."},"TtsAudioConfigurationDTO":{"required":["bargeIn","bargeInOffset","flush","mask","tts","voiceBargeIn"],"type":"object","properties":{"mask":{"maxLength":4096,"type":"string","description":"In the example above, we used a mask with the variable $TEXT to replace with the content you have written in the text template, so you don't have to repeat it in the xml. If the content of the answer is an xml starting with \" Fetches the details of a specific bot by its UUID within a given organization and environment. Optionally includes a thumbnail.
```json
{"openapi":"3.0.1","info":{"title":"eva-bot API Documentation","version":"4.8.0"},"tags":[{"name":"bots","description":"External management for Bots"}],"paths":{"/org/{orgUUID}/env/{envUUID}/v2/bots/{botUUID}":{"get":{"tags":["bots"],"summary":"Retrieve a bot (v2)","description":"Fetches the details of a specific bot by its UUID within a given organization and environment. Optionally includes a thumbnail.","operationId":"findBotV2","parameters":[{"name":"orgUUID","in":"path","description":"A valid UUID of the organization","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid UUID of the environment","required":true,"schema":{"type":"string"}},{"name":"botUUID","in":"path","description":"A valid UUID of the bot","required":true,"schema":{"type":"string"}},{"name":"thumbnail","in":"query","description":"Whether to include a thumbnail in the response","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Bot retrieved successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentResponseDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden - user does not have permission to view the bot","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"404":{"description":"Bot not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}}}}}},"components":{"schemas":{"AgentResponseDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of the bot"},"name":{"type":"string","description":"Name of the bot"},"description":{"type":"string","description":"Description of the bot"},"companyName":{"type":"string","description":"Name of the company associated with the bot"},"locale":{"type":"string","description":"Locale or language of the bot"},"industry":{"type":"string","description":"Industry in which the bot operates"},"image":{"$ref":"#/components/schemas/ImageResponseDTO"},"engine":{"$ref":"#/components/schemas/EngineResponseDTO"},"channel":{"$ref":"#/components/schemas/ChannelCreatedDTO"},"analytic":{"$ref":"#/components/schemas/AnalyticDTO"}},"description":"DTO representing a bot's metadata and configuration details."},"ImageResponseDTO":{"type":"object","properties":{"url":{"type":"string","description":"URL of the bot's image"},"contentType":{"type":"string","description":"MIME type of the image"},"botHasCustomImage":{"type":"boolean","description":"Indicates whether the bot has a custom image"}},"description":"DTO containing metadata about the bot's image"},"EngineResponseDTO":{"type":"object","properties":{"nlu":{"$ref":"#/components/schemas/NLUEngineConfigurationResponseDTO"},"kai":{"$ref":"#/components/schemas/KAIEngineConfigurationResponseDTO"},"agentic":{"$ref":"#/components/schemas/AgenticEngineConfigurationResponseDTO"},"isHybrid":{"type":"boolean","description":"Indicates whether the engine setup is hybrid"},"isAgentic":{"type":"boolean","description":"Indicates whether the engine setup is agentic"},"isClever":{"type":"boolean","description":"Indicates whether the engine is clever"},"isBotLLM":{"type":"boolean","description":"Indicates whether the engine is based on a bot LLM"}},"description":"DTO representing the response configuration of multiple engines"},"NLUEngineConfigurationResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the NLU engine","format":"int64"},"name":{"type":"string","description":"Name of the NLU engine"},"first":{"type":"boolean","description":"Indicates whether this is the first engine"},"metadata":{"type":"string","description":"Additional metadata related to the engine"},"nlutype":{"type":"string","description":"Enumeration of supported NLU engine types","enum":["NLUEngineType.CLEVER(value=Clever)","NLUEngineType.DIALOGFLOW(value=DialogFlow)","NLUEngineType.LEX(value=Lex)","NLUEngineType.LUIS(value=Luis)","NLUEngineType.WATSON(value=Watson)","NLUEngineType.OPENAI(value=OpenAI)","NLUEngineType.AZURE_OPENAI(value=Azure OpenAI)","NLUEngineType.EVA_AZURE_OPENAI(value=eva Azure OpenAI)"]}},"description":"DTO representing the configuration response of an NLU engine"},"KAIEngineConfigurationResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the KAI engine.","format":"int64"},"name":{"type":"string","description":"Name of the KAI engine"},"metadata":{"type":"string","description":"Additional metadata related to the engine"}},"description":"Represents the configuration response of the KAI Engine."},"AgenticEngineConfigurationResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the AGENTIC engine.","format":"int64"},"name":{"type":"string","description":"Name of the AGENTIC engine"},"first":{"type":"boolean","description":"Indicates whether this is the first engine"},"metadata":{"type":"string","description":"Additional metadata related to the engine"}},"description":"Represents the configuration response of the Agentic Engine."},"ChannelCreatedDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of the channel"},"botUuid":{"type":"string","description":"Unique identifier of the associated bot"},"name":{"type":"string","description":"Name of the channel"},"description":{"type":"string","description":"Description of the channel"},"channelType":{"$ref":"#/components/schemas/ChannelTypeDTO"},"createdAt":{"type":"string","description":"Timestamp when the channel was created","format":"date-time"},"updatedAt":{"type":"string","description":"Timestamp when the channel was last updated","format":"date-time"}},"description":"DTO representing a created channel"},"ChannelTypeDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the channel type","format":"int64"},"name":{"type":"string","description":"Name of the channel type"},"image":{"type":"string","description":"Image path representing the channel type"},"channelClassification":{"$ref":"#/components/schemas/ChannelClassificationDTO"}},"description":"DTO representing a channel type"},"ChannelClassificationDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the classification","format":"int64"},"name":{"type":"string","description":"Name of the classification"}},"description":"DTO representing a channel classification"},"AnalyticDTO":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key used for analytics integration"}},"description":"DTO containing the analytics API key used for bot monitoring and tracking"},"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"BotErrorDTO":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}}}}}
```
## Update an existing bot (v2)
> Updates the configuration of an existing bot identified by its UUID within a specific organization and environment.
```json
{"openapi":"3.0.1","info":{"title":"eva-bot API Documentation","version":"4.8.0"},"tags":[{"name":"bots","description":"External management for Bots"}],"paths":{"/org/{orgUUID}/env/{envUUID}/v2/bots/{botUUID}":{"put":{"tags":["bots"],"summary":"Update an existing bot (v2)","description":"Updates the configuration of an existing bot identified by its UUID within a specific organization and environment.","operationId":"updateV2","parameters":[{"name":"orgUUID","in":"path","description":"A valid UUID of the organization","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid UUID of the environment","required":true,"schema":{"type":"string"}},{"name":"botUUID","in":"path","description":"A valid UUID of the bot","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentBaseRequestDTO"}}},"required":true},"responses":{"200":{"description":"Bot updated successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AgentResponseDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden - user does not have permission to update the bot","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity - invalid input data","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}}}}}},"components":{"schemas":{"AgentBaseRequestDTO":{"required":["companyName","description","engine","industry","locale","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the agent"},"description":{"type":"string","description":"A brief description of the agent"},"locale":{"type":"string","description":"The locale of the agent"},"industry":{"type":"string","description":"The industry the agent is associated with"},"companyName":{"type":"string","description":"The name of the company"},"image":{"type":"string","description":"Optional image URL or base64 string"},"engine":{"$ref":"#/components/schemas/EngineRequestDTO"},"analytic":{"$ref":"#/components/schemas/AnalyticDTO"}},"description":"Data to update the bot"},"EngineRequestDTO":{"type":"object","properties":{"nlu":{"$ref":"#/components/schemas/NLUEngineConfigurationDTO"},"agentic":{"$ref":"#/components/schemas/PersonaAgenticEngineConfigurationDTO"},"llm":{"type":"boolean"}},"description":"DTO that encapsulates configuration data for NLU and Agentic engines used by an agent."},"NLUEngineConfigurationDTO":{"required":["first","metadata","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the NLU engine"},"first":{"type":"boolean","description":"Indicates whether this engine should be executed first"},"metadata":{"type":"string","description":"Metadata associated with the engine configuration"},"nlutype":{"type":"string","description":"Enumeration of supported NLU engine types","enum":["NLUEngineType.CLEVER(value=Clever)","NLUEngineType.DIALOGFLOW(value=DialogFlow)","NLUEngineType.LEX(value=Lex)","NLUEngineType.LUIS(value=Luis)","NLUEngineType.WATSON(value=Watson)","NLUEngineType.OPENAI(value=OpenAI)","NLUEngineType.AZURE_OPENAI(value=Azure OpenAI)","NLUEngineType.EVA_AZURE_OPENAI(value=eva Azure OpenAI)"]}},"description":"Configuration DTO for an NLU engine."},"PersonaAgenticEngineConfigurationDTO":{"required":["first","metadata","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the Agentic engine"},"first":{"type":"boolean","description":"Indicates if this engine should be executed first"},"metadata":{"type":"string","description":"Metadata associated with the engine configuration"},"persona":{"$ref":"#/components/schemas/PersonaDTO"},"agenticType":{"type":"string","description":"Enumeration of supported Agentic LLM engine types.","enum":["AgenticEngineType.OPENAI(value=OpenAI)","AgenticEngineType.AZURE_OPENAI(value=Azure OpenAI)","AgenticEngineType.EVA_AZURE_OPENAI(value=eva Azure OpenAI)"]}},"description":"Configuration DTO for an Agentic engine within a persona."},"PersonaDTO":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the persona"},"image":{"type":"string","description":"An optional image representing the persona"},"backstory":{"type":"string","description":"A narrative backstory that defines the persona's origin or context"},"personality":{"type":"string","description":"A description of the persona's personality traits"},"communicationStyle":{"type":"string","description":"Enumeration of communication styles used by an agent.","enum":["POLITE_AND_PERSUASIVE","WITTY_AND_CASUAL","EMPATHETIC_AND_HELPFUL","CONCISE_AND_PROFESSIONAL","FRIENDLY_AND_APPROACHABLE"]}},"description":"DTO representing a persona configuration for an Agentic engine."},"AnalyticDTO":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key used for analytics integration"}},"description":"DTO containing the analytics API key used for bot monitoring and tracking"},"AgentResponseDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of the bot"},"name":{"type":"string","description":"Name of the bot"},"description":{"type":"string","description":"Description of the bot"},"companyName":{"type":"string","description":"Name of the company associated with the bot"},"locale":{"type":"string","description":"Locale or language of the bot"},"industry":{"type":"string","description":"Industry in which the bot operates"},"image":{"$ref":"#/components/schemas/ImageResponseDTO"},"engine":{"$ref":"#/components/schemas/EngineResponseDTO"},"channel":{"$ref":"#/components/schemas/ChannelCreatedDTO"},"analytic":{"$ref":"#/components/schemas/AnalyticDTO"}},"description":"DTO representing a bot's metadata and configuration details."},"ImageResponseDTO":{"type":"object","properties":{"url":{"type":"string","description":"URL of the bot's image"},"contentType":{"type":"string","description":"MIME type of the image"},"botHasCustomImage":{"type":"boolean","description":"Indicates whether the bot has a custom image"}},"description":"DTO containing metadata about the bot's image"},"EngineResponseDTO":{"type":"object","properties":{"nlu":{"$ref":"#/components/schemas/NLUEngineConfigurationResponseDTO"},"kai":{"$ref":"#/components/schemas/KAIEngineConfigurationResponseDTO"},"agentic":{"$ref":"#/components/schemas/AgenticEngineConfigurationResponseDTO"},"isHybrid":{"type":"boolean","description":"Indicates whether the engine setup is hybrid"},"isAgentic":{"type":"boolean","description":"Indicates whether the engine setup is agentic"},"isClever":{"type":"boolean","description":"Indicates whether the engine is clever"},"isBotLLM":{"type":"boolean","description":"Indicates whether the engine is based on a bot LLM"}},"description":"DTO representing the response configuration of multiple engines"},"NLUEngineConfigurationResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the NLU engine","format":"int64"},"name":{"type":"string","description":"Name of the NLU engine"},"first":{"type":"boolean","description":"Indicates whether this is the first engine"},"metadata":{"type":"string","description":"Additional metadata related to the engine"},"nlutype":{"type":"string","description":"Enumeration of supported NLU engine types","enum":["NLUEngineType.CLEVER(value=Clever)","NLUEngineType.DIALOGFLOW(value=DialogFlow)","NLUEngineType.LEX(value=Lex)","NLUEngineType.LUIS(value=Luis)","NLUEngineType.WATSON(value=Watson)","NLUEngineType.OPENAI(value=OpenAI)","NLUEngineType.AZURE_OPENAI(value=Azure OpenAI)","NLUEngineType.EVA_AZURE_OPENAI(value=eva Azure OpenAI)"]}},"description":"DTO representing the configuration response of an NLU engine"},"KAIEngineConfigurationResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the KAI engine.","format":"int64"},"name":{"type":"string","description":"Name of the KAI engine"},"metadata":{"type":"string","description":"Additional metadata related to the engine"}},"description":"Represents the configuration response of the KAI Engine."},"AgenticEngineConfigurationResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the AGENTIC engine.","format":"int64"},"name":{"type":"string","description":"Name of the AGENTIC engine"},"first":{"type":"boolean","description":"Indicates whether this is the first engine"},"metadata":{"type":"string","description":"Additional metadata related to the engine"}},"description":"Represents the configuration response of the Agentic Engine."},"ChannelCreatedDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of the channel"},"botUuid":{"type":"string","description":"Unique identifier of the associated bot"},"name":{"type":"string","description":"Name of the channel"},"description":{"type":"string","description":"Description of the channel"},"channelType":{"$ref":"#/components/schemas/ChannelTypeDTO"},"createdAt":{"type":"string","description":"Timestamp when the channel was created","format":"date-time"},"updatedAt":{"type":"string","description":"Timestamp when the channel was last updated","format":"date-time"}},"description":"DTO representing a created channel"},"ChannelTypeDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the channel type","format":"int64"},"name":{"type":"string","description":"Name of the channel type"},"image":{"type":"string","description":"Image path representing the channel type"},"channelClassification":{"$ref":"#/components/schemas/ChannelClassificationDTO"}},"description":"DTO representing a channel type"},"ChannelClassificationDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the classification","format":"int64"},"name":{"type":"string","description":"Name of the classification"}},"description":"DTO representing a channel classification"},"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"BotErrorDTO":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}}}}}
```
{% openapi src="" path="/org/{orgUUID}/env/{envUUID}/bots/{botUUID}" method="delete" %}
[eva-bot-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2FlAfxbIY5xXoYMT7mUt6b%2Feva-bot-4.7.0.yaml?alt=media\&token=66a7a840-92c5-4582-9630-68b07cd740cf)
{% endopenapi %}
### Deprecated Endpoints
## POST /org/{orgUUID}/env/{envUUID}/bots
> Create a new bot with his dependencies: nlpEngine, bot-admin, channels and parameters
```json
{"openapi":"3.0.1","info":{"title":"eva-bot API Documentation","version":"4.8.0"},"tags":[{"name":"bots","description":"External management for Bots"}],"paths":{"/org/{orgUUID}/env/{envUUID}/bots":{"post":{"tags":["bots"],"summary":"Create a new bot with his dependencies: nlpEngine, bot-admin, channels and parameters","operationId":"insert","parameters":[{"name":"orgUUID","in":"path","description":"A valid uuid of organization","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid uuid of environment","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotInsertRequestDTO"}}},"required":true},"responses":{"201":{"description":"Ok","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChannelBotDataDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}}}}}},"components":{"schemas":{"BotInsertRequestDTO":{"required":["channelName","channelType","locale","name","nlpName"],"type":"object","properties":{"name":{"type":"string","description":"Name of the bot"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Description of the bot"},"industry":{"type":"string","description":"Type of bot business"},"locale":{"type":"string","description":"Locale of the bot"},"image":{"type":"string","description":"Base64 of the bot's image in the DataURI format."},"contentType":{"type":"string","description":"[DEPRECATED] Content-Type of the bot image. Inferred from the image field.","deprecated":true},"metadata":{"type":"string","description":"Metadata of bot's nlp engine. OBS: Its not required if wants to insert or update bot clever"},"channelName":{"type":"string","description":"Name of the first channel to create with the bot"},"channelType":{"type":"integer","description":"Type of the first channel to create with the bot. Types: 1 - Amazon Echo, 2 - Google Home, 4 - Jibo, 5 - Alexa, 6 - Cortana, 7 - Google Assistant, 8 - Siri, 9 - Facebook, 10 - RCS, 11 - SMS, 12 - Skype, 13 - ARCore, 14 - ARKit, 15 - Android, 16 - iOS, 17 - IVR, 18 - VR, 19 - Web, 20 - Web Mobile, 21 - App Mobile, 22 - WhatsApp, 24 - Skype for Business, 25 - Telegram, 26 - Twitter, 27 - WhatsApp (Infobip), 28 - HTC Vive, 29 - Oculus Rift, 30 - Oculus Go, 31 - Samsung Gear VR, 32 - Hololens, 33 - Apple Business Chat, 34 - Microsoft Teams","format":"int64"},"channelDescription":{"type":"string","description":"Description of the first channel to create with the bot"},"nlpName":{"type":"string","description":"NlpName of the bot. Options: Clever, Watson, Luis, DialogFlow, Lex, Azure OpenAI, OpenAI, eva Azure OpenAI"},"ivrConfiguration":{"$ref":"#/components/schemas/IvrConfigurationDTO"},"api_key":{"type":"string","description":"Api key of the analytic platform: Dashbot, Chatbase..."}},"description":"Data to create a new bot"},"IvrConfigurationDTO":{"required":["dnis","secret","vendor"],"type":"object","properties":{"vendor":{"maxLength":14,"type":"string","description":"Type of ivr, e.g. EVG and VXML."},"dnis":{"type":"string","description":"Number where the call was received. This is usually the local call center number."},"secret":{"type":"string","description":"Authentication key for the IVR."},"fetchData":{"$ref":"#/components/schemas/FetchDataDTO"},"transferCall":{"$ref":"#/components/schemas/TransferCallDTO"},"defaultErrorHandling":{"$ref":"#/components/schemas/ErrorHandlingDTO"},"callEstablishmentErrorHandling":{"$ref":"#/components/schemas/ErrorHandlingDTO"},"settings":{"$ref":"#/components/schemas/SettingsDTO"},"ttsAudioConfiguration":{"$ref":"#/components/schemas/TtsAudioConfigurationDTO"},"dtmfMenu":{"$ref":"#/components/schemas/DtmfMenuDTO"},"voiceMenu":{"$ref":"#/components/schemas/VoiceMenuDTO"}},"description":"Represents the IVR configuration for a channel."},"FetchDataDTO":{"required":["timeoutInterval"],"type":"object","properties":{"timeoutInterval":{"maximum":60000,"minimum":10,"type":"integer","description":"The default amount of time in milliseconds the IVR will wait for a page/json fetch.","format":"int64","default":45000},"audio":{"$ref":"#/components/schemas/AudioDTO"}},"description":"Represents the configuration for fetching data during an IVR interaction."},"AudioDTO":{"type":"object","properties":{"url":{"maxLength":2048,"type":"string","description":"The path to the default audio file to be used during IVR platform fetch events."},"delay":{"maximum":60000,"minimum":0,"type":"integer","description":"The default value for the fetch audio delay","format":"int64","default":0},"minimum":{"maximum":60000,"minimum":0,"type":"integer","description":"The minimum time in milliseconds to play a fetch audio source","format":"int64","default":0},"interval":{"maximum":60000,"minimum":0,"type":"integer","description":"Controls the time interval between fetch audio loops","format":"int64","default":0}},"description":"Represents the audio configuration for fetch events in IVR."},"TransferCallDTO":{"type":"object","properties":{"uui":{"maxLength":4096,"type":"string","description":"A custom message that will be transferred along with the call via the user-to-user SIP header. We recommend to use a hexadecimal encoding."},"destination":{"maxLength":4096,"type":"string","description":"Call destination, where it will be transferred to. You can declare it as sip or tel."}},"description":"Represents the transfer call information."},"ErrorHandlingDTO":{"required":["transferOnError"],"type":"object","properties":{"transferOnError":{"type":"boolean","description":"When set to true the call will be transferred after the message is played, when set to false or when the property is not specified the call will be terminated after the message. To make the call transfer we will use the default transfer settings."},"audio":{"$ref":"#/components/schemas/AudioDTO"},"tts":{"maxLength":4096,"type":"string","description":"The field content will be synthesized by the IVR, you can fill it with free text or with an SSML."},"transferCall":{"$ref":"#/components/schemas/TransferCallDTO"}},"description":"Represents error handling configurations for the IVR."},"SettingsDTO":{"required":["conversationTimeout","firstConversationRequest","maxCallDuration","regionalExpressionsFileUrl","sendPostCallEvents","welcomeTimeout"],"type":"object","properties":{"firstConversationRequest":{"maximum":4096,"type":"string","description":"If you want to start the conversation with a different flow, fill in this field.","default":"{\"text\":\"\",\"code\":\"%EVA_WELCOME_MSG\",\"context\":{}}"},"conversationTimeout":{"maximum":300000,"minimum":10,"type":"integer","description":"Maximum waiting time for eva response.","format":"int64","default":40000},"sendPostCallEvents":{"type":"boolean","description":"Sends messages to eva such as: user disconnected.","default":true},"regionalExpressionsFileUrl":{"maxLength":2048,"type":"string","description":"This property gives a contextual understanding of expressions and words variations. For example, in English it's common to say O (letter) instead of zero when giving a phone number. To help the STT intelligence understand this is the number 0 and not a letter, you can use a JSON file that gathers all 'Regional Expressions'"},"welcomeTimeout":{"maximum":300000,"minimum":10,"type":"integer","description":"Maximum waiting time for eva response the welcome flow.","format":"int64","default":40000},"maxCallDuration":{"maximum":1800000,"minimum":1000,"type":"integer","description":"Maximum temple that a call can be active, property used to counter loop errors.","format":"int64","default":300000}},"description":"Represents settings for IVR configuration."},"TtsAudioConfigurationDTO":{"required":["bargeIn","bargeInOffset","flush","mask","tts","voiceBargeIn"],"type":"object","properties":{"mask":{"maxLength":4096,"type":"string","description":"In the example above, we used a mask with the variable $TEXT to replace with the content you have written in the text template, so you don't have to repeat it in the xml. If the content of the answer is an xml starting with \" Retrieves complete information from a Bot given it's UUID
```json
{"openapi":"3.0.1","info":{"title":"eva-bot API Documentation","version":"4.8.0"},"tags":[{"name":"bots","description":"External management for Bots"}],"paths":{"/org/{orgUUID}/env/{envUUID}/bots/{botUUID}":{"get":{"tags":["bots"],"summary":"Retrieves complete information from a Bot given it's UUID","operationId":"findBot","parameters":[{"name":"orgUUID","in":"path","description":"A valid uuid of organization","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid uuid of environment","required":true,"schema":{"type":"string"}},{"name":"botUUID","in":"path","description":"A valid uuid of bot","required":true,"schema":{"type":"string"}},{"name":"thumbnail","in":"query","description":"Controls whether the returned default image is a thumbnail version or full image; user-submitted images are unaffected. Default value is false. (Full version)","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Ok","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotDataDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BotErrorDTO"}}}}}}}},"components":{"schemas":{"BotDataDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Bot's uuid"},"name":{"type":"string","description":"Bot's name"},"description":{"type":"string","description":"Bot's description"},"industry":{"type":"string","description":"Type of bot business"},"locale":{"type":"string","description":"Bot's locale"},"nlpId":{"type":"integer","description":"Bot's nlp id","format":"int64"},"nlp":{"type":"string","description":"Bot's nlp"},"metadata":{"type":"string","description":"Bot's metadata nlp"},"image":{"type":"string","description":"Bot's url image"},"contentType":{"type":"string","description":"Bot's content type of image"},"botHasCustomImage":{"type":"boolean","description":"Tells you whether received image belongs to bot or is a default image"},"isClever":{"type":"boolean","description":"True if bot is clever, false if not"},"isBotLLM":{"type":"boolean","description":"True if bot is LLM, false if not"},"api_key":{"type":"string","description":"Bot's key to analytic platform. Ex: chatbase, dashbot..."}},"description":"Response when search for a bot"},"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"BotErrorDTO":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}}}}}
```
{% openapi src="" path="/org/{orgUUID}/env/{envUUID}/bots/{botUUID}" method="put" %}
[eva-bot-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2FlAfxbIY5xXoYMT7mUt6b%2Feva-bot-4.7.0.yaml?alt=media\&token=66a7a840-92c5-4582-9630-68b07cd740cf)
{% endopenapi %}
### LLM Engine
{% openapi src="" path="/org/{orgUUID}/env/{envUUID}/engines/llm/account-details" method="post" %}
[eva-bot-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2FlAfxbIY5xXoYMT7mUt6b%2Feva-bot-4.7.0.yaml?alt=media\&token=66a7a840-92c5-4582-9630-68b07cd740cf)
{% endopenapi %}