API Docs
EVA USER GUIDE
API Docs
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer API
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboards
          • Dialog Manager
          • Entity
          • Generative Services
          • Intent
          • Parameters
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
      • Webhooks
    • Infrastructure Guidelines
      • eva server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • eva Data Structure
      • Admin Data Structure
      • Environment Data Structure
Powered by GitBook
On this page

Was this helpful?

  1. API DOCS
  2. API Guidelines
  3. Management API
  4. Instance API

Bot

Bots are your Virtual Agents.

PreviousAutomated TestsNextBroker

Last updated 1 year ago

Was this helpful?

API SUBPATH: eva-bot

Paginations and Listings

CRUD Operations

Paginates through all Bots in an Environment. Removed Bots are not retrieved, and neither are Bots whose the current used has no access to.

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Query parameters
searchTermstringOptional

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 · int32Optional

Current page, starting at 1.

Default: 1
linesPerPageinteger · int32Optional

Items per page, defaulted to 7.

Default: 7
orderBystringOptional

Criteria to order result, defaulted to createdAt date.

Default: createdAt
directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

Default: DESC
Responses
200
Ok
*/*
403
Forbidden
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bots HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "locale": "text",
      "nlpId": 1,
      "nlp": "text",
      "metadata": "text",
      "image": "text",
      "contentType": "text",
      "botHasCustomImage": true,
      "isClever": true,
      "api_key": "text"
    }
  ],
  "number": 1,
  "empty": true
}

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

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

Query parameters
searchTermstringRequired

Term being searched

limitinteger · int32Optional

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

Default: 6
Responses
200
Ok
*/*
Responsestring[]
422
Unprocessable Entity
*/*
get
GET /org/{orgUUID}/env/{envUUID}/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*
[
  "text"
]

Retrieves a list containing simplified information from all Bots within an Environment. Does not retrieve removed Bots.

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Responses
200
Ok
*/*
403
Forbidden
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bots/simple HTTP/1.1
Host: 
Accept: */*
{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "locale": "text",
      "image": "text"
    }
  ]
}

Retrieves complete information from a Bot given it's UUID

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters
thumbnailbooleanOptional

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

Default: false
Responses
200
Ok
*/*
403
Forbidden
*/*
404
Not Found
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bots/{botUUID} HTTP/1.1
Host: 
Accept: */*
{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "locale": "text",
  "nlpId": 1,
  "nlp": "text",
  "metadata": "text",
  "image": "text",
  "contentType": "text",
  "botHasCustomImage": true,
  "isClever": true,
  "api_key": "text"
}

Delete a bot

delete
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Responses
204
Ok
403
Forbidden
422
Unprocessable entity
*/*
500
Internal Server Error
*/*
delete
DELETE /org/{orgUUID}/env/{envUUID}/bots/{botUUID} HTTP/1.1
Host: 
Accept: */*

No content

Returns the image of a Bot given it's UUID. If a Bot doesn't have image, returns a default image instead.

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters
thumbstringOptional

If return default image and has this parameter, will return default image thumb version

Responses
200
Ok
*/*
Responsestring · byte
403
Forbidden
*/*
422
Unprocessable Entity
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bots/{botUUID}/image HTTP/1.1
Host: 
Accept: */*
Ynl0ZXM=
  • Paginations and Listings
  • GETPaginates through all Bots in an Environment. Removed Bots are not retrieved, and neither are Bots whose the current used has no access to.
  • GETSearches (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.
  • GETRetrieves a list containing simplified information from all Bots within an Environment. Does not retrieve removed Bots.
  • CRUD Operations
  • GETRetrieves complete information from a Bot given it's UUID
  • POSTCreate a new bot with his dependencies: nlpEngine, bot-admin, channels and parameters
  • PUTUpdate a bot
  • DELETEDelete a bot
  • GETReturns the image of a Bot given it's UUID. If a Bot doesn't have image, returns a default image instead.

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

post
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Body

Data to create a new bot

namestringRequired

Name of the bot

localestringRequired

Locale of the bot

imagestringOptional

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

contentTypestringOptional

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

metadatastringOptional

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

channelDescriptionstringOptional

Description of the first channel to create with the bot

nlpNamestringRequired

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

api_keystringOptional

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

Responses
201
Ok
*/*
403
Forbidden
*/*
422
Unprocessable entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bots HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "name": "text",
  "locale": "text",
  "image": "text",
  "contentType": "text",
  "metadata": "text",
  "channelName": "text",
  "channelType": 1,
  "channelDescription": "text",
  "nlpName": "text",
  "api_key": "text"
}
{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "locale": "text",
  "nlpId": 1,
  "nlp": "text",
  "metadata": "text",
  "image": "text",
  "contentType": "text",
  "botHasCustomImage": true,
  "isClever": true,
  "api_key": "text"
}

Update a bot

put
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Data to update bot

namestringRequired

Name of the bot

localestringRequired

Locale of the bot

imagestringOptional

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

contentTypestringOptional

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

metadatastringOptional

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

api_keystringOptional

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

Responses
200
Ok
*/*
403
Forbidden
*/*
422
Unprocessable entity
*/*
500
Internal Server Error
*/*
put
PUT /org/{orgUUID}/env/{envUUID}/bots/{botUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "name": "text",
  "locale": "text",
  "image": "text",
  "contentType": "text",
  "metadata": "text",
  "api_key": "text"
}
{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "locale": "text",
  "nlpId": 1,
  "nlp": "text",
  "metadata": "text",
  "image": "text",
  "contentType": "text",
  "botHasCustomImage": true,
  "isClever": true,
  "api_key": "text"
}