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
Path parameters
orgUUIDstringRequired

A valid uuid of environment

envUUIDstringRequired

A valid uuid of environment

Responses
200
OK
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bots-admin HTTP/1.1
Host: 
Accept: */*
{
  "bots": [
    {
      "uuid": "text",
      "environmentUuid": "text",
      "name": "text",
      "image": "text"
    }
  ]
}

Retrieves all existing bots per botUUID.

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Responses
200
OK
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bots-admin/{botUUID} HTTP/1.1
Host: 
Accept: */*
{
  "uuid": "text",
  "environmentUuid": "text",
  "name": "text",
  "image": "text"
}

Last updated

Was this helpful?