API Guide

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…

Used to export the ML utterances of a bot. It creates a request ID from which we can generate the Download link of the bot using ML Utterance Export Status API. To use this API, app needs the Bot Builder API scope of Utterances Export. OR the Admin API Scope…

To add or remove the ability to access bot builder, create new bots. 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/useraccess Query Parameters Parameter Description host…

To add or remove users or groups from admin roles. 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. POST https://{{host}}/api/public/adminroles/assignments/ Query Parameters Parameter Required/Optional Description host Required Environment…

To assign a bot role to a set of users in a specific bot. 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. POST https://{{host}}/api/public/btroles/assignments/ Query Parameters Parameter Required/Optional…

To get the list of groups and group members available 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/groups?offset=0&limit=2 Path Parameters Parameter Required/Optional Description…

To retrieve the list of bots available in 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 Role Management under Role Management. GET https://{{host}}/api/public/bots?offset=0&limit=50s Query Parameters Parameter Required/Optional Description host Required Environment…