API Guide

To retrieve the data associated with custom widgets and the reports of a bot. Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/dashboard/ {{dashboardName}}/widget/{{widgetName}}?startDate={{startDate}}&endDate={{endDate}}&limit={{limit}}Note: A POST API call is now supported to include the additional filters for querying the data. See Custom Dashboard Filters to know more about additional filters. Content Type application/json Authorization auth:…

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…

This API is used to delete customer data. Note: Delete User will not proceed if the requested user is: An account owner or belongs to one or more accounts. The bot owner or co-developer for one or more bots. Method DELETE Endpoint https://{{host}}/api/public/bot/eraseUsersData Content Type application/json Authorization auth: {{JWT}} See…

This API retrieves the conversation sessions created. It returns information such as session metadata, user and bot identifiers, session duration, language, status, and other relevant metrics. 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:…

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. Method GET and POST Endpoint This API has two versions for GET and POST methods. The…

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…