API Guide

Used to execute Batch Test Suites and get results. This API only initiates the test process. Use Batch Test Execution Status API to view the results of the batch test. To use this API, the app needs the Bot Builder Scope of Batch Tests Execution. POST https://{{host}}/api/public/bot/{{BotID}}/testsuite/{testSuiteName}/run Query Parameters Parameter…

To install a sample bot. To use this API, needs the Admin app scope of Bot Create under Bot Definition. POST https://{{host}}/api/public/samplebots/{{botId}}/add 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 from the General Settings page…

Used to initiate enable a channel for a virtual assistant. To use this API, app needs the Admin API Scope of Channel Management under ChannelManagement. POST https://{{host}}/api/public/bot/channels Query Parameters Parameter Required/ Optional Description host Required Environment URL, for example, https://bots.kore.ai Body Parameters Parameter Required/Optional Description streamId Required Stream or Bot…

To update the NLP thresholds and configurations To use this API, app needs the Bot Builder API scope of NLP Configurations. OR the Admin API Scope of NLP Configurations under Test and Train. POST https://{{host}}/api/public/bot/{{BotID}}/configurations?language={{languageCode}}&groupName={{groupName}} Query Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or…

To update the NLP thresholds and configurations To use this API, app needs the Bot Builder API scope of NLP Configurations. OR the Admin API Scope of NLP Configurations under Test and Train. POST https://{{host}}/api/public/bot/{{BotID}}/configurations?language={{languageCode}}&groupName={{groupName}} Query Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or…

To provide the number of users who have interacted with the bot in a given period across different time intervals. To use this API, the app needs the Bot Scope. POST https://{{host}}/api/public/bot/{{BotID}}/userEngagementTrend?aggregation_type={{type}}&start_date={{from}}&end_date={{to}}&channels={{channel}} Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or Stream…

To extract the metrics data related to the intent detection and task performance using API. It can be used to retrieve metrics information related to Intents Found, Intents not Found, Failed Tasks, Successful Tasks, and Performance Logs To use this API, the app needs the Bot Scope of Metrics. POST…

To get a list of questions and nodes under the Knowledge task. To use this API, the app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/bot/{{botId}}/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&language=en Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai botId Required Bot ID. You can access it from the General…

To add specific questions to the Knowledge graph. To use this API, the app needs the Admin API Scope of KnowlegdeGraph. POST https://{{host}}/api/public/bot/{{botId}}/faqs/bulk?language=en Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai botId Required Bot ID. You can access it from the General Settings page of the…

To get a listing knowledge Tasks with the nodes. To use this API, the app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/bot/{{botId}}/knowledgeTasks?language=en Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai botId Required Bot ID. You can access it from the General Settings page of…