API Guide

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

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…

To get the list of KG Extraction Questions.   Method GET Endpoint https://{{host}}/api/public/stream/{{streamId}}/qna/{{ExtractionId}}/questions?limit=&offset= 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 KG extractions’ history as a list.   Method GET Endpoint https://{{host}}/api/public/stream/{{streamId}}/qna/history?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…

To extract the Knowledge Graph from the imported file or URL.   Method POST Endpoint https://{{host}}/api/public/bot/{{botId}}/qna/import?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…

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…

This API In-activates current active session based on session Id and bot Id. This API is available in the BT app scopes. To use this API, the app needs the Bot Builder API scope of Bot sessions. PUT https://{{host}}/api/public/bot/{{BotID}}/session Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotId Bot…