API Guide

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…

To get debug logs of a specific conversation (currently supported only for IVR Channel). To use this API, app needs the Bot Builder API scope of Debug Logs. GET https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai BotID Bot ID or Stream ID. You can access it…

To get full information of all users and their associated roles in the 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 Role Management under Role Management. GET https://{{host}}/api/public/alluserroles? Query Parameters Parameter Description…

Used to initiate a publish request for a bot. Before calling the Publish Bot API, make sure that at least one channel is enabled for the bot. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API…

Used to get the status of the bot import request initiated using Import Bot as New Bot API or Import Bot into an Existing Bot API. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope…

Used to import bot definition file into an existing bot for upgrading to a new version or restoring to an earlier version. 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 Bot Import under…

Used to Upload the botdefinition, botconfig, and botfunction file (if any) as well as the bot icon to the local server and get the file ID to be used in Import Bot API. You need to upload the files separately. POST https://{{host}}/api/public/uploadfile Query Parameters Parameter Description host Environment URL, for…

Import Bot as a New Bot API is used to create a new bot in the account owner’s Builder Tool using the File IDs generated by uploading the files to the local server. Refer to Upload File API on how to upload and obtain the File Id. This API requires…

Gets the status of Bot Export request and also provides the download link of the bot export copy after the export is completed. Refer here for initiating Bot Export API. To use this API, app needs the Admin API Scope of Bot Export under Bot Definition. GEThttps://{{host}}/api/public/bot/{{BotID}}/export/status Query Parameters Parameter…

Used to export bot definition and all associated components. This API only initiates the export process. Use Export Status API to view the progress of the export and also to get a link to download the file once the export is completed. To use this API, app needs the Admin…