Bots

Defining a Smart Bot

A Smart Bot is a custom Bot defined and deployed to your environment and usually maintained by Kore.ai. For a detailed overview, click here. This document deals with how you can create your own Smart Bots and use it within your enterprise account. Creating a Smart Bot is similar to…

Supported Entity Types

The Entity Type provides the NLP Interpreter with the expected type of data from a user utterance to enhance recognition and system performance. The Kore.ai NLP interpreter extracts the entity from the user utterance. If the user does not enter a required entity, you can define a Bot Response node…

Debug Logs API

To get debug logs of a specific conversation (currently supported only for IVR Channel). To use this API, app needs the Bot Builder API scope of Debug Logs. GET https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotID Bot ID or Stream ID. You can access it…

Get User Roles Details API

To get full information of all users and their associated roles in the account. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Role Management under Role Management. GET https://{{host}}/api/public/alluserroles? Query Parameters Parameter Description…

Publish Bot API

Used to initiate a publish request for a bot. Before calling the Publish Bot API, make sure that at least one channel is enabled for the bot. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API…

Bot Import Status API

Used to get the status of the bot import request initiated using Import Bot as New Bot API or Import Bot into an Existing Bot API. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope…

Import Bot into an Existing Bot API

Used to import bot definition file into an existing bot for upgrading to a new version or restoring to an earlier version. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Bot Import under…

Upload File API

Used to Upload the botdefinition, botconfig, and botfunction file (if any) as well as the bot icon to the local server and get the file ID to be used in Import Bot API. You need to upload the files separately. POST https://{{host}}/api/public/uploadfile Query Parameters Parameter Description host Environment URL, for…

Import Bot as a New Bot API

Import Bot as a New Bot API is used to create a new bot in the account owner’s Builder Tool using the File IDs generated by uploading the files to the local server. Refer to Upload File API on how to upload and obtain the File Id. This API requires…

Bot Export – Status API

Gets the status of Bot Export request and also provides the download link of the bot export copy after the export is completed. Refer here for initiating Bot Export API. To use this API, app needs the Admin API Scope of Bot Export under Bot Definition. GEThttps://{{host}}/api/public/bot/{{BotID}}/export/status Query Parameters Parameter…