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

orgUUIDstringrequired

A valid uuid of environment

envUUIDstringrequired

A valid uuid of environment

Responses

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

409

422

500

200

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

OK

Retrieves all existing bots per botUUID.

get

/org/{orgUUID}/env/{envUUID}/bots-admin/{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 \
  --url '/org/{orgUUID}/env/{envUUID}/bots-admin/{botUUID}'

200

400

409

422

500

200

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

OK