API Guide

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…

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…

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…

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…

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…

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…

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…

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/stream/{{BotID}}/getSessions and https://{{host}}/api/public/getSessions for Bot Admin Console Parameters…

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…

Following is the list of APIs available from the Kore.ai Bots Platform. For details on the API functioning and usage instructions refer here. These APIs are available for testing in your Postman setup, for configuration details see here. Based on the app scope, the APIs can be categorized as: Public…