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. Method POST Endpoint https://{{host}}/api/public/roles/import?roleType=bot&fullImport=true Content Type application/json Authorization auth: {{JWT}} See How to generate the…

To get the list of changes made to the bot definition for a given date period. Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/changelogs Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Logs History Admin Console: Logs > Bot Audit Logs Path Parameters Parameter Required/Optional…

To get the status of the FAQ training.   Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/faqs/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 FAQ Admin Console: Test and Train > Train FAQ   Path Parameters Parameter Description Mandate host The environment URL.…

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. For example,…

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…