Bot Admin

The Bot Admin API handles a universal lookup and the relations of Virtual Agents across all environments.

API SUBPATH: eva-bot-admin

The single method exposed here is used to retrieve the list of bots available within an Environment.

Retrieves all existing bots per envUUID.

GET/org/{orgUUID}/env/{envUUID}/bots-admin

Path parameters

orgUUID*string

A valid uuid of environment

envUUID*string

A valid uuid of environment

Response

200400409422500

OK

Body

*/*

botsarray of BotAdminResponseDTO (object)

Request

JavaScriptCurlPython

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

Response

200400409422500

{
  "bots": [
    {
      "uuid": "text",
      "environmentUuid": "text",
      "name": "text",
      "image": "text"
    }
  ]
}

Retrieves all existing bots per botUUID.

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

200400409422500

OK

Body

*/*

uuid*string

Bots's uuid

environmentUuidstring

namestring

imagestring

Request

JavaScriptCurlPython

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

Response

200400409422500

{
  "uuid": "text",
  "environmentUuid": "text",
  "name": "text",
  "image": "text"
}