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

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

sizeinteger (int32)

contentarray of BotDataDTO (object)

numberinteger (int32)

sortSortObject (object)

firstboolean

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bots', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "unpaged": false,
    "paged": false,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "industry": "text",
      "locale": "text",
      "nlpId": 0,
      "nlp": "text",
      "metadata": "text",
      "image": "text",
      "contentType": "text",
      "botHasCustomImage": false,
      "isClever": false,
      "isBotLLM": false,
      "api_key": "text"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

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

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/quicksearch?searchTerm=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "text"
]

Simple list of all bots not removed inside an environment

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

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

Response

200400401403404409422500

Ok

Body

*/*

dataarray of SimpleBotDTO (object)

Data

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bots/simple', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "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/org/{orgUUID}/env/{envUUID}/bots

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

Body

application/json

name*string

Name of the bot

descriptionstring

Description of the bot

industrystring

Type of bot business

locale*string

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

channelName*string

Name of the first channel to create with the bot

channelType*integer (int64)

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

nlpName*string

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

ivrConfigurationIvrConfigurationDTO (object)

Represents the IVR configuration for a channel.

api_keystring

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

Response

201400401403404409422500

Ok

Body

*/*

uuidstring

Bot's uuid

namestring

Bot's name

descriptionstring

Bot's description

industrystring

Type of bot business

localestring

Bot's locale

nlpIdinteger (int64)

Bot's nlp id

nlpstring

Bot's nlp

metadatastring

Bot's metadata nlp

imagestring

Bot's url image

contentTypestring

Bot's content type of image

botHasCustomImageboolean

Tells you wether received image belongs to bot or is a default image

isCleverboolean

True if bot is clever, false if not

isBotLLMboolean

True if bot is LLM, false if not

channelChannelCreatedDTO (object)

Channel created when bot is created

api_keystring

Bot's key to analytic platform. Ex: chatbase, dashbot...

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bots', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "channelName": "text",
      "channelType": 0,
      "locale": "text",
      "name": "text",
      "nlpName": "text"
    }),
});
const data = await response.json();

Response

201400401403404409422500

{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "industry": "text",
  "locale": "text",
  "nlpId": 0,
  "nlp": "text",
  "metadata": "text",
  "image": "text",
  "contentType": "text",
  "botHasCustomImage": false,
  "isClever": false,
  "isBotLLM": false,
  "channel": {
    "uuid": "text",
    "botUuid": "text",
    "name": "text",
    "description": "text",
    "channelType": {
      "id": 0,
      "name": "text",
      "image": "text",
      "channelClassification": {
        "id": 0,
        "name": "text"
      }
    },
    "createdAt": "2024-12-21T11:36:57.688Z",
    "updatedAt": "2024-12-21T11:36:57.688Z"
  },
  "api_key": "text"
}

Find a bot

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

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

botUUID*string

A valid uuid of bot

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

uuidstring

Bot's uuid

namestring

Bot's name

descriptionstring

Bot's description

industrystring

Type of bot business

localestring

Bot's locale

nlpIdinteger (int64)

Bot's nlp id

nlpstring

Bot's nlp

metadatastring

Bot's metadata nlp

imagestring

Bot's url image

contentTypestring

Bot's content type of image

botHasCustomImageboolean

Tells you wether received image belongs to bot or is a default image

isCleverboolean

True if bot is clever, false if not

isBotLLMboolean

True if bot is LLM, false if not

api_keystring

Bot's key to analytic platform. Ex: chatbase, dashbot...

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bots/{botUUID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "industry": "text",
  "locale": "text",
  "nlpId": 0,
  "nlp": "text",
  "metadata": "text",
  "image": "text",
  "contentType": "text",
  "botHasCustomImage": false,
  "isClever": false,
  "isBotLLM": false,
  "api_key": "text"
}

Update a bot

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

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

botUUID*string

A valid uuid of bot

Body

application/json

name*string

Name of the bot

descriptionstring

Description of the bot

industrystring

Type of bot business

locale*string

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

Response

200400401403404409422500

Ok

Body

*/*

uuidstring

Bot's uuid

namestring

Bot's name

descriptionstring

Bot's description

industrystring

Type of bot business

localestring

Bot's locale

nlpIdinteger (int64)

Bot's nlp id

nlpstring

Bot's nlp

metadatastring

Bot's metadata nlp

imagestring

Bot's url image

contentTypestring

Bot's content type of image

botHasCustomImageboolean

Tells you wether received image belongs to bot or is a default image

isCleverboolean

True if bot is clever, false if not

isBotLLMboolean

True if bot is LLM, false if not

api_keystring

Bot's key to analytic platform. Ex: chatbase, dashbot...

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bots/{botUUID}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "locale": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "industry": "text",
  "locale": "text",
  "nlpId": 0,
  "nlp": "text",
  "metadata": "text",
  "image": "text",
  "contentType": "text",
  "botHasCustomImage": false,
  "isClever": false,
  "isBotLLM": false,
  "api_key": "text"
}

Delete a bot

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

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

botUUID*string

A valid uuid of bot

Response

204400401403404409422500

Ok

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bots/{botUUID}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

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

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

Body

application/json

endpointstring

User account endpoint

apiKeystring

User account api-key

engineTypeenum

LLM engine type

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

Response

200400401403404409422500

OK

Body

*/*

modelsarray of ModelDTO (object)

Models data

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/engines/llm/account-details', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409422500

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