API Guide

Get FAQs – KG

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…

Add Questions from Extract – KG

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…

Get KnowledgeTasks – KG

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…

Get Extraction Questions – KG

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…

Get Extractions History – KG

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…

Extraction from file or URL – KG

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…

Data Insert (Bulk) API

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…

Enabling Agent Transfer API

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…

Configuring BotKit API

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…

Query Data (View) API

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}} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai viewName The table view form…
Menu