Bot

Bots are your Virtual Agents.

API SUBPATH: eva-bot

Paginations and Listings

Pages of all bots not removed of an user

get

/org/{orgUUID}/env/{envUUID}/bots

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

Query parameters

searchTermstring

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 · int32 · default: 1

Current page, starting at 1.

linesPerPageinteger · int32 · default: 7

Items per page, defaulted to 7.

orderBystring · default: createdAt

Criteria to order result, defaulted to createdAt date.

directionstring · default: DESC

Order direction(ASC/DESC), defaulted to DESC

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bots'

200

400

401

403

404

409

422

500

200

{
  "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,
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true,
  "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"
    }
  ]
}

Ok

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

/org/{orgUUID}/env/{envUUID}/quicksearch

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

Query parameters

searchTermstringrequired

Term being searched

limitinteger · int32 · default: 6

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/quicksearch?searchTerm=text'

200

400

401

403

404

409

422

500

200

[
  "text"
]

Ok

Simple list of all bots not removed inside an environment

get

/org/{orgUUID}/env/{envUUID}/bots/simple

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bots/simple'

200

400

401

403

404

409

422

500

200

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

Ok

CRUD Operation

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

post

/org/{orgUUID}/env/{envUUID}/bots

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

Body

namestringrequired

Name of the bot

descriptionstring · max: 250

Description of the bot

industrystring

Type of bot business

localestringrequired

Locale of the bot

imagestring

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

contentTypestring

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

metadatastring

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

channelDescriptionstring

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

ivrConfigurationobject

Represents the IVR configuration for a channel.

api_keystring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bots' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","locale":"text","channelName":"text","channelType":1,"nlpName":"text","ivrConfiguration":{"vendor":"text","dnis":"text","secret":"text","fetchData":{"timeoutInterval":45000,"audio":{"delay":0,"minimum":0,"interval":0}},"transferCall":{},"defaultErrorHandling":{"transferOnError":true,"audio":{"delay":0,"minimum":0,"interval":0},"transferCall":{}},"callEstablishmentErrorHandling":{"transferOnError":true,"audio":{"delay":0,"minimum":0,"interval":0},"transferCall":{}},"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},"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\"}"}}}}'

201

400

401

403

404

409

422

500

201

{
  "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-02-21T18:14:17.464Z",
    "updatedAt": "2025-02-21T18:14:17.464Z"
  },
  "api_key": "text"
}

Ok

Find a bot

get

/org/{orgUUID}/env/{envUUID}/bots/{botUUID}

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

botUUIDstringrequired

A valid uuid of bot

Query parameters

thumbnailboolean

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bots/{botUUID}'

200

400

401

403

404

409

422

500

200

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

Ok

Update a bot

put

/org/{orgUUID}/env/{envUUID}/bots/{botUUID}

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

botUUIDstringrequired

A valid uuid of bot

Body

namestringrequired

Name of the bot

descriptionstring · max: 250

Description of the bot

industrystring

Type of bot business

localestringrequired

Locale of the bot

imagestring

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

contentTypestring

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

metadatastring

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

api_keystring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bots/{botUUID}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","locale":"text"}'

200

400

401

403

404

409

422

500

200

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

Ok

Delete a bot

delete

/org/{orgUUID}/env/{envUUID}/bots/{botUUID}

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

botUUIDstringrequired

A valid uuid of bot

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bots/{botUUID}'

204

400

401

403

404

409

422

500

204

No body

Ok

LLM Engine

Using the endpoit and api-key entered as parameters for this service, it will list the models and deploys available.

post

/org/{orgUUID}/env/{envUUID}/engines/llm/account-details

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

Body

endpointstring

User account endpoint

apiKeystring

User account api-key

engineTypestring · enum

LLM engine type

Options: LLMEngineType.OPENAI(value=OpenAI), LLMEngineType.AZURE_OPENAI(value=Azure OpenAI), LLMEngineType.EVA_AZURE_OPENAI(value=eva Azure OpenAI)

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/engines/llm/account-details' \
  --header 'Content-Type: application/json' \
  --data '{"engineType":"LLMEngineType.OPENAI(value=OpenAI)"}'

200

400

401

403

404

409

422

500

200

{
  "models": [
    {
      "name": "text",
      "deploy": {
        "name": "text"
      }
    }
  ]
}

OK