API Guide

To execute Batch Test Suites and get results. This API only initiates the test process. Please look at the Batch Test Execution Status API for results of the batch test.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/testsuite/{testSuiteName}/run Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope…

To install a sample bot.   Method POST Endpoint https://{{host}}/api/public/samplebots/{{botId}}/add Content Type application/json Authorization auth: {{JWT}} AccountId: {{accountId}} userId: {{userId}} bot-language : en See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console: Bot Definition > Bot Create   Path Parameters Parameter Description Mandate host…

To initiate enable a channel for a virtual assistant. Method POST Endpoint https://{{host}}/api/public/channels   Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console: Channel Management Path Parameters Parameter Description Mandate host The environment URL. For example, https://bots.kore.ai Required…

To update the NLP thresholds and configurations   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/configurations?language={{languageCode}}&groupName={{groupName}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: NLP Configurations Admin Console: Test > NLP Configurations & Train   Query Parameters Parameter Description Mandate host The environment URL. For…

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. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/userEngagementTrend?aggregation_type={{type}}&start_date={{from}}&end_date={{to}}&channels={{channel}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: User Engagement Trend Admin Console: Not Applicable Path Parameters…

The Get Analytics API allows you to retrieve metrics data related to intent detection and task performance. The API provides information about various metrics, including Intents Found, Intents not Found, Unhandled Utterances, Failed Tasks, Successful Tasks, and Performance Logs. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/getAnalytics Content Type application/json Authorization auth: {{JWT}} See…

To get a list of questions and nodes under the Knowledge task. Method GET Endpoint https://{{host}}/api/public/bot/{{botId}}/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&language=en Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Manage Knowledge Graph Admin Console: Manage Knowledge Graph Path Parameters Parameter Description Mandate host The environment URL.…

To add specific questions to the Knowledge graph.   Method POST Endpoint https://{{host}}/api/public/bot/{{botId}}/faqs/bulk?language=en Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Manage Knowledge Graph Admin Console: Manage Knowledge Graph   Path Parameters Parameter Description Mandate host The environment URL. For example,…

To get the list of knowledge Tasks along with the nodes.   Method GET Endpoint https://{{host}}/api/public/bot/{{botId}}/knowledgeTasks?language=en Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Manage Knowledge Graph Admin Console: Manage Knowledge Graph   Path Parameters Parameter Description Mandate host The environment…