API Guide

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}} 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 Knowledge task. To use this API, app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/stream/{{streamId}}/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 streamId Required Bot ID or Stream ID. You can access it from the…

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

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

To get a Get KG Extraction Questions. To use this API, app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/stream/{{streamId}}/qna/{{ExtractionId}}/questions?limit=&offset= Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai streamId Required Bot ID or Stream ID. You can access it from the General Settings page of…

To get a list of KG Extractions history. To use this API, app needs the Admin API Scope of KnowlegdeGraph. GET https://{{host}}/api/public/stream/{{streamId}}/qna/history?language=en Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai streamId Required Bot ID or Stream ID. You can access it from the General Settings page…

To import the extract using file or URL. To use this API, app needs the Admin API Scope of KnowlegdeGraph. POST https://{{host}}/api/public/stream/{{streamId}}/qna/import?language=en Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai streamId Required Bot ID or Stream ID. You can access it from the General Settings page…

Used to insert bulk data into Data Table. To use this API, the app needs to be given Write access to the Data Table from the Data Definition in DaaS (see here for details) POST https://{{host}}/api/public/tables/{{tableName}}/bulk Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai tableName Name of the…