API Guide

To remove users from an account. This API requires JWT generated by an application created only from the Bot Admin Console. Note: This feature was introduced in ver7.1 of the platform. Method DELETE Endpoint https://{{host}}/api/public/users Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope…

To update the user details. This API requires JWT generated by an application created only from the Bot Admin Console. This feature was introduced in ver7.1 of the platform. Method PUT Endpoint https://{{host}}/api/public/users Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder:…

To add users to an account. This API requires JWT generated by an application created only from the Bot Admin Console. This feature was introduced in ver7.1 of the platform. Method POST Endpoint https://{{host}}/api/public/users Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot…

To retrieve the user details. This API requires JWT generated by an application created only from the Bot Admin Console. This feature was introduced in ver7.1 of the platform. Method POST Endpoint https://{{host}}/api/public/usersInfo Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder:…

Used to get the status of the Customer Data Delete request. This API requires JWT generated by an application created only from the Bot Admin Console. Note: This feature was introduced in ver7.1 of the platform. Method GET Endpoint https://{{host}}/api/public/bot/eraseUsersData/status/:reqId Content Type application/json Authorization auth: {{JWT}} See How to generate…

Used to delete customer data. This API requires JWT generated by an application created only from the Bot Admin Console. Note: This feature was introduced in ver7.1 of the platform. Note: Delete User will not proceed if the requested user is: An account owner or belongs to one or more…

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. The API details are available in the Bot Builder and Bot Admin Console (BAC) app scopes. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/getSessions?containmentType={{containmentType}} and https://{{host}}/api/public/getSessions?containmentType={{containmentType}}for BAC Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Bot Sessions OR…

To fetch 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 be deprecated soon. This revised…

Following is the list of APIs available from the Kore.ai XO Platform. For details on the API functioning and usage instructions refer here. Based on the functionality addressed, the APIs can be categorized as: APIs related to the Bot Definition functionality, more APIs related to NLP training, more APIs aiding…