Docs

Entity Types

The Entity Type provides the NLP Interpreter with the expected type of data from a user utterance to enhance recognition and system performance. The Kore.ai NLP interpreter extracts the entity from the user utterance. If the user does not enter a required entity, you can define a virtual assistant Response…

Debug Logs API

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…

Get User Roles Details API

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…

Publish Bot API

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:…

Bot Import Status API

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}}…

Import Bot into an Existing Bot API

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…

Upload File API

To upload the botdefinition, botconfig, and botfunction files (if any) and the bot icon to the local server. Additionally, the API fetches the file ID to be used in Import Bot API. Note: You need to upload the files separately. You can upload a file by signing with any app…

Import Bot as a New Bot API

To create a new bot in the account owner’s Builder Tool using the File IDs generated when uploading the files to the local server. Please refer to the Upload File API for uploading and obtaining the File Id. Note: The API requires the JWT generated by an application created…

Bot Export – Status API

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. Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/export/status Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope…

Bot Export API

To export the bot definition and all the associated components. Note: This API only initiates the export process. Please use the Export Status API to view the export progress status and obtain a link to download the file once the export completes. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/export Content Type application/json Authorization…