Bot
Bots are your Virtual Agents.
Paginations and Listings
A valid uuid of organization
A valid uuid of environment
Term being searched. This expects one optional String matching the name of a bot, left to right from the begining of it's name.
Current page, starting at 1.
1Items per page, defaulted to 7.
7Criteria to order result, defaulted to createdAt date.
createdAtOrder direction(ASC/DESC), defaulted to DESC
DESCGET /org/{orgUUID}/env/{envUUID}/bots HTTP/1.1
Host:
Accept: */*
{
"totalPages": 1,
"totalElements": 1,
"pageable": {
"unpaged": true,
"paged": true,
"pageNumber": 1,
"pageSize": 1,
"offset": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"numberOfElements": 1,
"size": 1,
"content": [
{
"uuid": "text",
"name": "text",
"description": "text",
"industry": "text",
"locale": "text",
"nlpId": 1,
"nlp": "text",
"metadata": "text",
"image": "text",
"contentType": "text",
"botHasCustomImage": true,
"isClever": true,
"isBotLLM": true,
"api_key": "text"
}
],
"number": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"first": true,
"last": true,
"empty": true
}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.
A valid organization Uuid
A valid environment Uuid
Term being searched
How many items will be returned in the list. Defaults to 6.
6GET /org/{orgUUID}/env/{envUUID}/quicksearch?searchTerm=text HTTP/1.1
Host:
Accept: */*
[
"text"
]A valid uuid of organization
A valid uuid of environment
GET /org/{orgUUID}/env/{envUUID}/bots/simple HTTP/1.1
Host:
Accept: */*
{
"data": [
{
"uuid": "text",
"name": "text",
"locale": "text",
"image": "text"
}
]
}CRUD Operation
A valid uuid of organization
A valid uuid of environment
Data to create a new bot
Name of the bot
Description of the bot
Type of bot business
Locale of the bot
Base64 of the bot's image in the DataURI format.
[DEPRECATED] Content-type of the bot image. Inferred from the image field.
Metadata of bot's nlp engine. OBS: Its not required if wants to insert or update bot clever
Name of the first channel to create with the bot
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
Description of the first channel to create with the bot
NlpName of the bot. Options: Clever, Watson, Luis, DialogFlow, Lex, Azure OpenAI, OpenAI, eva Azure OpenAI
Api key of the analytic platform: Dashbot, Chatbase...
POST /org/{orgUUID}/env/{envUUID}/bots HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 2055
{
"name": "text",
"description": "text",
"industry": "text",
"locale": "text",
"image": "text",
"contentType": "text",
"metadata": "text",
"channelName": "text",
"channelType": 1,
"channelDescription": "text",
"nlpName": "text",
"ivrConfiguration": {
"vendor": "text",
"dnis": "text",
"secret": "text",
"fetchData": {
"timeoutInterval": 45000,
"audio": {
"url": "text",
"delay": 0,
"minimum": 0,
"interval": 0
}
},
"transferCall": {
"uui": "text",
"destination": "text"
},
"defaultErrorHandling": {
"transferOnError": true,
"audio": {
"url": "text",
"delay": 0,
"minimum": 0,
"interval": 0
},
"tts": "text",
"transferCall": {
"uui": "text",
"destination": "text"
}
},
"callEstablishmentErrorHandling": {
"transferOnError": true,
"audio": {
"url": "text",
"delay": 0,
"minimum": 0,
"interval": 0
},
"tts": "text",
"transferCall": {
"uui": "text",
"destination": "text"
}
},
"settings": {
"firstConversationRequest": "{\"text\":\"\",\"code\":\"%EVA_WELCOME_MSG\",\"context\":{}}",
"conversationTimeout": 40000,
"sendPostCallEvents": true,
"regionalExpressionsFileUrl": "text",
"welcomeTimeout": 40000,
"maxCallDuration": 300000
},
"ttsAudioConfiguration": {
"mask": "text",
"tts": {
"voiceProvider": "AZURE_WHISPER",
"voiceProviderConfig": "{\"azureOpenAIKey\":\"your-azure-openai-key\",\"azureOpenAIEndpoint\":\"your-azure-openai-endpoint\",\"gptDeployment\":\"your-gpt-deployment\",\"whisperDeployment\":\"your-whisper-deployment\",\"languageCode\":\"your-language-code\",\"prompt\":\"your-prompt\"}"
},
"flush": false,
"bargeIn": false,
"voiceBargeIn": false,
"bargeInOffset": 1,
"time": 1
},
"dtmfMenu": {
"interdigitTimeout": 5000,
"numberOfDigits": 1,
"timeoutInterval": 15000,
"terminationTimeout": 2500,
"terminationCharacter": "#"
},
"voiceMenu": {
"timeoutInterval": 15000,
"sensitivity": 0.25,
"confidence": 0.6,
"maxSpeechTimeout": 20000,
"incompleteTimeout": 20000,
"asr": {
"voiceProvider": "AZURE_WHISPER",
"voiceProviderConfig": "{\"azureOpenAIKey\":\"your-azure-openai-key\",\"azureOpenAIEndpoint\":\"your-azure-openai-endpoint\",\"gptDeployment\":\"your-gpt-deployment\",\"whisperDeployment\":\"your-whisper-deployment\",\"languageCode\":\"your-language-code\",\"prompt\":\"your-prompt\"}"
}
}
},
"api_key": "text"
}{
"uuid": "text",
"name": "text",
"description": "text",
"industry": "text",
"locale": "text",
"nlpId": 1,
"nlp": "text",
"metadata": "text",
"image": "text",
"contentType": "text",
"botHasCustomImage": true,
"isClever": true,
"isBotLLM": true,
"channel": {
"uuid": "text",
"botUuid": "text",
"name": "text",
"description": "text",
"channelType": {
"id": 1,
"name": "text",
"image": "text",
"channelClassification": {
"id": 1,
"name": "text"
}
},
"createdAt": "2025-07-01T20:55:18.385Z",
"updatedAt": "2025-07-01T20:55:18.385Z"
},
"api_key": "text"
}A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
Controls wether the returned default image is a thumbnail version or full image; user-submitted images are unaffected. Default value is false. (Full version)
falseGET /org/{orgUUID}/env/{envUUID}/bots/{botUUID} HTTP/1.1
Host:
Accept: */*
{
"uuid": "text",
"name": "text",
"description": "text",
"industry": "text",
"locale": "text",
"nlpId": 1,
"nlp": "text",
"metadata": "text",
"image": "text",
"contentType": "text",
"botHasCustomImage": true,
"isClever": true,
"isBotLLM": true,
"api_key": "text"
}A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
Data to update bot
Name of the bot
Description of the bot
Type of bot business
Locale of the bot
Base64 of the bot's image in the DataURI format.
[DEPRECATED] Content-type of the bot image. Inferred from the image field.
Metadata of bot's nlp engine. OBS: Its not required if wants to insert or update bot clever
Api key of the analytic platform: Dashbot, Chatbase...
PUT /org/{orgUUID}/env/{envUUID}/bots/{botUUID} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 141
{
"name": "text",
"description": "text",
"industry": "text",
"locale": "text",
"image": "text",
"contentType": "text",
"metadata": "text",
"api_key": "text"
}{
"uuid": "text",
"name": "text",
"description": "text",
"industry": "text",
"locale": "text",
"nlpId": 1,
"nlp": "text",
"metadata": "text",
"image": "text",
"contentType": "text",
"botHasCustomImage": true,
"isClever": true,
"isBotLLM": true,
"api_key": "text"
}A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
DELETE /org/{orgUUID}/env/{envUUID}/bots/{botUUID} HTTP/1.1
Host:
Accept: */*
No content
LLM Engine
Using the endpoit and api-key entered as parameters for this service, it will list the models and deploys available.
A valid uuid of organization
A valid uuid of environment
Contains the data needed to consult account data
User account endpoint
User account api-key
LLM engine type
POST /org/{orgUUID}/env/{envUUID}/engines/llm/account-details HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 85
{
"endpoint": "text",
"apiKey": "text",
"engineType": "LLMEngineType.OPENAI(value=OpenAI)"
}{
"models": [
{
"name": "text",
"deploy": {
"name": "text"
}
}
]
}Last updated
Was this helpful?