Docs

Assign BT Roles API

To assign a bot role to a set of users in a specific bot. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Role Management under Role Management. POST https://{{host}}/api/public/btroles/assignments/ Query Parameters Parameter Required/Optional…

Get Groups API

To get the list of groups and group members available in the account. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Role Management under Role Management. GET https://{{host}}/api/public/groups?offset=0&limit=2 Path Parameters Parameter Required/Optional Description…

Get Bots API

To retrieve the list of bots available in an account. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Role Management under Role Management. GET https://{{host}}/api/public/bots?offset=0&limit=50s Query Parameters Parameter Required/Optional Description host Required Environment…

Get Roles API

To retrieve the list of bot or admin roles available in an account. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Role Management under Role Management. GET https://{{host}}/api/public/roles?roleType=bot&limit=2 Query Parameters Parameter Required/Optional Description…

Export Roles API

To export bot or admin roles from an account. This is typically used to export roles from one environment to another. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Role Management under Role…

Import Roles API

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. To use this API, app needs the Admin API Scope of Role Management under Role…

Get ChangeLogs API

To get the list of changes made to the bot definition for a given date period. To use this API, app needs the Admin API Scope of Logs History under Logs. GET https://{{host}}/api/public/bot/{{BotID}}/changelogs Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or…

FAQ Training Status API

To get the status of the FAQ training. To use this API, app needs the Admin API Scope of Train FAQ under Test and Train. GET https://{{host}}/api/public/bot/{{BotID}}/faqs/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…

FAQ Training API

To initiate the training of the knowledge graph. To use this API, app needs the Admin API Scope of Train FAQ under Test and Train. POST https://{{host}}/api/public/bot/{{BotID}}/faqs/train 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 Export Status API

Gets the download link of the ML Utterances export copy. To use this API, app needs the Bot Builder API scope of Utterances Export. OR the Admin API Scope of Utterances Export under Test and Train. GET https://{{host}}/api/public/bot/{{BotID}}/mlexport/status Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai…
Menu
Kore.ai Named a Leader in 2022 Gartner® Magic Quadrant™ for Enterprise Conversational AI PlatformsGet the Report