API Guide

To import bot or admin roles into an account. This is typically used to import roles from one environment to another. 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…

To get the list of changes made to the bot definition for a given date period. To use this API, app needs the Admin API Scope of Logs History under Logs. GET https://{{host}}/api/public/bot/{{BotID}}/changelogs Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or…

To get the status of the FAQ training. To use this API, app needs the Admin API Scope of Train FAQ under Test and Train. GET https://{{host}}/api/public/bot/{{BotID}}/faqs/train/status?language={{Lang}}&state={{state}} Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or Stream ID. You can access it…

To initiate the training of the knowledge graph. To use this API, app needs the Admin API Scope of Train FAQ under Test and Train. POST https://{{host}}/api/public/bot/{{BotID}}/faqs/train Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or Stream ID. You can access it…

Gets the download link of the ML Utterances export copy. To use this API, app needs the Bot Builder API scope of Utterances Export. OR the Admin API Scope of Utterances Export under Test and Train. GET https://{{host}}/api/public/bot/{{BotID}}/mlexport/status Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai…

Gets the status of the ML utterances import request made through Import ML Utterances API. To use this API, app needs the Bot Builder API scope of Utterances Import. OR the Admin API Scope of Utterances Import under Test and Train. GET https://{{host}}/api/public/bot/{{BotID}}/mlimport/status/{{MLutteranceID}} Path Parameters Parameter Required/Optional Description host Required…

Imports ML Utterances into a bot. To use this API, app needs the Bot Builder API scope of Utterances Import. OR the Admin API Scope of Utterances Import under Test and Train. POST https://{{host}}/api/public/bot/{{BotID}}/mlimport Query Parameters Parameter Required/Optional Description host Required The bot environment URL, for example, https://bots.kore.ai BotID Required…

To get the status of the ML training. To use this API, app needs the Admin API Scope of Train ML under Test and Train. GET https://{{host}}/api/public/bot/{{BotID}}/ml/train/status?language={{lang}}&state={{state}} Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or Stream ID. You can access it…

To initiate ML training of a bot. To use this API, app needs the Admin API Scope of Train ML under Test and Train. POST https://{{host}}/api/public/bot/{{BotID}}/ml/train Query Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or Stream ID. You can access it from…

Exports global and content variables from a bot. To use this API, app needs the Bot Builder API scope of Export Variables. POST https://{{host}}/api/{{version}}/public/builder/stream/{{BotID}}/variables/export Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotID Bot ID. You can access it from the General Settings page of the bot. Authorization…