Docs

FAQ Training Status API

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}} 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…

FAQ Training API

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…

ML Utterances Export Status API

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…

ML Utterances Import Status API

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…

ML Utterances Import API

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…

ML Utterance Train Status API

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 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…

ML Utterances Train API

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…

Role Management

Roles and Permissions help in organizing the developer community based on the scope of their work. By default the roles of Master Admin, Bot Owner, Bot Developer and Bot Tester are created by the system. Each role has set of permissions allowed. You can edit the permission settings for Bot…

Event Based Bot Actions

Bot Events are triggered when specific actions occur during bot conversation or when specific events are triggered on bot channels. For example, when a user clicks the Get Started button to initiate a chat with your FB Messenger bot, it triggers the Facebook Welcome event. You can use this event…

Implementing Custom Authentication

You can implement custom authentication for your bot by providing URL from the service node to an external application that manages the authentication. The platform provides the necessary functionality to handle successful and failed authentication scenarios and manage the corresponding task flows. Bot Builder mechanism to implement custom authentication involves…