API Guide

To initiate the training of the knowledge graph.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/faqs/train Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Train FAQ Admin Console: Test and Train > Train FAQ   Path Parameters Parameter Description Mandate host The environment URL.…

To get the download link of the ML Utterances export copy.   Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/mlexport/status Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Utterances Export Admin Console: Test > Utterances Export and Train   Path Parameters Parameter Required/Optional Description host…

To get the status of the ML utterances import request made through Import ML Utterances API.   Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/mlimport/status/{{MLutteranceID}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Utterances Import Admin Console: Test and Train > Utterances Import   Path…

To import the ML Utterances into a bot.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/mlimport Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Utterances Import Admin Console: Test > Utterances Import and Train   Query Parameters Parameter Description Mandate host The environment URL.…

To get the ML training status.   Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/ml/train/status?language={{lang}}&state={{state}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Train ML Admin Console: Test and Train > Train ML   Path Parameters Parameter Description Mandate host The environment URL. For example,…

To initiate the ML training for a bot.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/ml/train Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Train ML Admin Console: Test and Train > Train ML   Query Parameters Parameter Description Mandate host The environment URL.…

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…

To import global and content variables into the bot.   Method POST Endpoint https://{{host}}/api/{{version}}/public/builder/bot/{{BotID}}/variables/import Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Import Variables Admin Console: Not Applicable   Query Parameters Parameter Description Mandate host The environment URL. For example, https://bots.kore.ai…

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…

To fetch the intent recognition result and the scores from NLP and ML engines. Method POST Endpoint https://{{host}}/api/v1.1/rest/bot/{{BotID}}/findIntent?fetchConfiguredTasks=false Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Intent and Entity Detection Admin Console: Intent Identification > Intent and Entity Detection   Path…