Bots

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…

Knowledge Extraction

The Knowledge Graph Extraction Service enables you to effortlessly move your enterprise’s existing Frequently Asked Questions- FAQ content - into bot Knowledge Graph. The feature supports the extraction from unstructured content such as web pages and PDF documents as well as from structured content such as CSV files. After completing…

Bot Variables Export API

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…

Bot Variables Import API

Imports global and content variables into the bot. To use this API, app needs the Bot Builder API scope of Import Variables. POST https://{{host}}/api/{{version}}/public/builder/stream/{{BotID}}/variables/import 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. Body…

Conversation History API (old)

Fetches the conversational messages between the bot and user in reverse chronological order. This API supports pagination. You can provide offset/skip and limit to get a certain number of messages at a time. Note: This API is currently accessible only if BotKit SDK or Agent Transfer is enabled for a…

Find Intent API

Fetches the intent recognition result and the scoring from NLP and ML engines. To use this API, app needs the Bot Builder API scope of Intent and Entity Detection. POST https://{{host}}/api/v1.1/rest/streams/{{BotID}}/findIntent?fetchConfiguredTasks=false Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotID Bot ID. You can access it from the…