Bot

Bots are your Virtual Agents.

API SUBPATH: eva-bot

Paginations and Listings

Pages of all bots not removed of an user

get

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Query parameters

searchTermstringOptional

Term being searched. This expects one optional String matching the name of a bot, left to right from the begining of it's name.

pageinteger · int32Optional

Current page, starting at 1.

Default: 1

linesPerPageinteger · int32Optional

Items per page, defaulted to 7.

Default: 7

orderBystringOptional

Criteria to order result, defaulted to createdAt date.

Default: createdAt

directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

Default: DESC

Responses

*/*

objectOptional

*/*

*/*

*/*

*/*

*/*

*/*

*/*

get

HTTPcURLJavaScriptPython

GET /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.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

Query parameters

searchTermstringRequired

Term being searched

limitinteger · int32Optional

How many items will be returned in the list. Defaults to 6.

Default: 6

Responses

*/*

string[]Optional

*/*

*/*

*/*

*/*

*/*

*/*

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Simple list of all bots not removed inside an environment

get

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Responses

*/*

objectOptional

List returned with simple information about bots of environment.

*/*

*/*

*/*

*/*

*/*

*/*

*/*

get

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bots/simple HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "locale": "text",
      "image": "text"
    }
  ]
}

CRUD Operation

Create a new bot with his dependencies: nlpEngine, bot-admin, channels and parameters

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Body

Data to create a new bot

namestringRequired

Name of the bot

descriptionstring · max: 250Optional

Description of the bot

industrystringOptional

Type of bot business

localestringRequired

Locale of the bot

imagestringOptional

Base64 of the bot's image in the DataURI format.

contentTypestringOptional

[DEPRECATED] Content-type of the bot image. Inferred from the image field.

metadatastringOptional

Metadata of bot's nlp engine. OBS: Its not required if wants to insert or update bot clever

channelNamestringRequired

Name of the first channel to create with the bot

channelTypeinteger · int64Required

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

channelDescriptionstringOptional

Description of the first channel to create with the bot

nlpNamestringRequired

NlpName of the bot. Options: Clever, Watson, Luis, DialogFlow, Lex, Azure OpenAI, OpenAI, eva Azure OpenAI

ivrConfigurationobjectOptional

Represents the IVR configuration for a channel.

api_keystringOptional

Api key of the analytic platform: Dashbot, Chatbase...

Responses

*/*

objectOptional

*/*

*/*

*/*

*/*

*/*

*/*

*/*

post

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bots HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1955

{
  "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": 1,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      }
    },
    "transferCall": {
      "uui": "text",
      "destination": "text"
    },
    "defaultErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "callEstablishmentErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 1,
        "minimum": 1,
        "interval": 1
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "settings": {
      "firstConversationRequest": "text",
      "conversationTimeout": 1,
      "sendPostCallEvents": true,
      "regionalExpressionsFileUrl": "text",
      "welcomeTimeout": 1,
      "maxCallDuration": 1
    },
    "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": true,
      "bargeIn": true,
      "voiceBargeIn": true,
      "bargeInOffset": 1,
      "time": 1
    },
    "dtmfMenu": {
      "interdigitTimeout": 1,
      "numberOfDigits": 1,
      "timeoutInterval": 1,
      "terminationTimeout": 1,
      "terminationCharacter": "text"
    },
    "voiceMenu": {
      "timeoutInterval": 1,
      "sensitivity": 1,
      "confidence": 1,
      "maxSpeechTimeout": 1,
      "incompleteTimeout": 1,
      "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-04-19T02:25:34.505Z",
    "updatedAt": "2025-04-19T02:25:34.505Z"
  },
  "api_key": "text"
}

Find a bot

get

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters

thumbnailbooleanOptional

Controls wether the returned default image is a thumbnail version or full image; user-submitted images are unaffected. Default value is false. (Full version)

Default: false

Responses

*/*

objectOptional

Response when search for a bot

*/*

*/*

*/*

*/*

*/*

*/*

*/*

get

HTTPcURLJavaScriptPython

GET /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"
}

Update a bot

put

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Data to update bot

namestringRequired

Name of the bot

descriptionstring · max: 250Optional

Description of the bot

industrystringOptional

Type of bot business

localestringRequired

Locale of the bot

imagestringOptional

Base64 of the bot's image in the DataURI format.

contentTypestringOptional

[DEPRECATED] Content-type of the bot image. Inferred from the image field.

metadatastringOptional

Metadata of bot's nlp engine. OBS: Its not required if wants to insert or update bot clever

api_keystringOptional

Api key of the analytic platform: Dashbot, Chatbase...

Responses

*/*

objectOptional

Response when search for a bot

*/*

*/*

*/*

*/*

*/*

*/*

*/*

put

HTTPcURLJavaScriptPython

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"
}

Delete a bot

delete

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

delete

HTTPcURLJavaScriptPython

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.

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Body

Contains the data needed to consult account data

endpointstringOptional

User account endpoint

apiKeystringOptional

User account api-key

engineTypestring · enumOptional

LLM engine type

Available options:

Responses

*/*

objectOptional

Contains a list of available models and deploys

*/*

*/*

*/*

*/*

*/*

*/*

*/*

post

HTTPcURLJavaScriptPython

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"
      }
    }
  ]
}