API Guide

Get Admin Console Audit Logs API

To get admin console audit logs. To use this API, app needs the Admin API Scope. GET https://{{host}}/api/public/auditlogs?size=50&offset=0&fromDate={{timestamp}}&toDate={{timestamp}}&fetchAfter={{AuditLogId}} NOTE: This feature was introduced in ver7.2 of the platform. Query Parameters   Parameter Description host Environment URL, for example, https://bots.kore.ai size Number of records to be fetched upto a maximum of…

Get Dashboard Widget Data

To get the data result of a widget from a specific Custom Dashboard added to a bot. To use this API, app needs the Bot Builder API scope of Custom Reports. GET https://{{host}}/api/public/bot/{{BotID}}/dashboard/{{dashboardName}}/widget/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}}&limit=-1 Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or…

Update User API

To update user details. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of User Management under Security & Control. PUT https://{{host}}/api/public/users NOTE: This feature was introduced in ver7.1 of the platform. Query Parameters Parameter…

Create User API

To add users to an account. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of User Management under Security & Control. POST https://{{host}}/api/public/users NOTE: This feature was introduced in ver7.1 of the platform. Query…

Get User Information

To retrieve the user details. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of User Management under Security & Control. POST https://{{host}}/api/public/usersInfo NOTE: This feature was introduced in ver7.1 of the platform. Query Parameters…

Delete Customer Data Status API

Used to get the status of the Customer Data Delete request. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Delete Users Data under Bot Analytics. GET https://{{host}}/api/public/bot/eraseUsersData/status/:reqId NOTE: This feature was introduced in ver7.1…

Delete Customer Data API

Used to delete customer data. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Delete Users Data under Bot Analytics. DELETE https://{{host}}/api/public/bot/eraseUsersData NOTE: This feature was introduced in ver7.1 of the platform. Delete User will…

API Collection

Postman is a popular tool to help test and develop APIs. To make it more convenient for integration with the Kore.ai APIs, we’ve developed a Postman collection. The entire collection is divided into two categories: APIs which are related to the Bot Builder functionality; APIs related to the Admin Console…

Sessions History API

This API retrieves the conversation sessions created. This API is available in BT and BAC app scopes. To use this API, app needs the Bot Builder API scope of Bot sessions. OR the Admin API Scope of Bot sessions under Bot Analytics. POST https://{{host}}/api/public/bot/{{BotID}}/getSessions and https://{{host}}/api/public/getSessions for Bot Admin Console Parameters…

Conversation History API

Fetches the conversational messages between the bot and user in reverse chronological order. This API supports pagination. You can provide offset/skip and limit to get a certain number of messages at a time. This is a newer version of the old API which will soon be deprecated. This revised API…
Menu