API Guide

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. Note: The Conversation History API provides the time in UTC format. Method GET and POST Endpoint…

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…

To fetch debug logs of a specific conversation. Method GET Endpoint https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Debug Logs Admin Console: Not Applicable Path Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotID Bot ID. You can…

To get complete information on all the users and their associated roles in the account. This API requires JWT generated by an application created only from the Bot Admin Console. Method GET Endpoint https://{{host}}/api/public/alluserroles?limit=2 Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot…

To initiate a publish request for a bot. Note: Before calling the API, please ensure that atleast one channel is enabled for the bot. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/publish   Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console:…

To get the status of the bot import request initiated using the Import Bot API for a new bot or an existing bot. Note: This API requires the JWT generated by an application created on the Bot Admin Console.   Method GET Endpoint https://{{host}}/api/public/bot/import/status/{{BotImportBIR}} Content Type application/json Authorization auth: {{JWT}}…

To import the bot definition file to an existing bot for a current version upgrade or previous version restoration. Note: This API requires the JWT generated by an application created on the Bot Admin Console.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/import Content Type application/json Authorization auth: {{JWT}} See How to generate…