API Guide

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, the app needs the Admin API Scope of KnowlegdeGraph. POST https://{{host}}/api/public/bot/{{botId}}/qna/import?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 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…

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…

Used to configure the Botkit Url, App, and events. To use this API, app needs the Bot Builder API scope of BotKit. PUT https://{{host}}/api/public/bot/{{BotID}}/sdkSubscription Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotID Bot ID or Stream ID. You can access it from the General Settings page of…

To configuring the Botkit Url, App, and events. To use this API, app needs the Bot Builder API scope of BotKit. PUT https://{{host}}/api/public/bot/{{BotID}}/sdkSubscription Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotID Bot ID or Stream ID. You can access it from the General Settings page of the…

Used to get data from Table View. To use this API, the app needs to be given Read access to the Table View from the Data Definition in DaaS (see here for details) POST https://{{host}}/api/public/views/{{viewName}}/query?sys_limit={{limit_value}}&sys_offset={{offset_value}} Kore.ai Bots Platform provides access to bot development using secured APIs. Refer here to learn…