API Guide

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

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…

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/bot/{{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, the app needs the Bot Builder API scope of Intent and Entity Detection. POST https://{{host}}/api/v1.1/rest/bot/{{BotID}}/findIntent?fetchConfiguredTasks=false Query Parameters Parameter Description Required/Optional host Environment URL, for example, https://bots.kore.ai required BotID Bot ID. You can access…

Using Kore.ai APIs

Kore.ai Bots Platform provides access to bot development using secured APIs. All key developer activities like bot creation, bot import and export, training, and publishing are available using these APIs. Key account management activities like managing Bot Builder access, managing admin, and bot roles can also be performed via secured…