API Guide

ML Utterances Train API

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

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

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 Required Description host Required The environment URL. For example, https://bots.kore.ai…

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

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…

Using XO Platform APIs

The XO Platform allows you to develop Virtual Assistants using secured APIs. All key developer activities like creation, import and export, training, and publishing are available using these APIs. Key account management activities like managing XO Platform access, managing admin, and roles can also be performed via secured public APIs.…
Menu