API Guide

Used to delete a specific execution of a Batch Test Suite. To use this API, the app needs the Bot Builder Scope of Batch Tests Management OR the Admin API Scope of Batch Tests Management. DELETE https://{host}/api/public/stream/{streamId}/testsuite/{testSuiteName}/{testRunId} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai botID Bot ID…

Used to delete a Batch Test Suite. To use this API, the app needs the Bot Builder Scope of Batch Tests Management OR the Admin API Scope of Batch Tests Management. DELETE https://{host}/api/public/stream/{botId}/testsuite/{testSuiteName} Query Parameters Parameter Description host Environment URL, for example, https://bots.kore.ai botID Bot ID or Stream ID. You…

To export the test cases of a given Batch Test Suite and get a link to download the file once the export is completed. To use this API, the app needs the Bot Builder Scope of Batch Tests Management OR the Admin API Scope of Batch Tests Management. POST https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/export…

To get the list of Batch Test Suites available for a bot. To use this API, app needs the Bot Builder Scope of Batch Tests Management OR the Admin API Scope of Batch Tests Management. GET https://{host}/api/public/bot/{botId}/testsuite?skip={skip}&limit={limit} Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID…

Gets the status of Batch Test Execution request against a unique ‘Request Id’ and provides the download link for the results file after the test execution is complete. Refer here for initiating Batch Test Execution API. To use this API, the app needs the Bot Builder Scope of Batch Tests Execution.…

Used to execute Batch Test Suites and get results. This API only initiates the test process. Use Batch Test Execution Status API to view the results of the batch test. To use this API, the app needs the Bot Builder Scope of Batch Tests Execution. POST https://{{host}}/api/public/stream/{{BotID}}/testsuite/{testSuiteName}/run Query Parameters Parameter…

To install a sample bot. To use this API, needs the Admin app scope of Bot Create under Bot Definition. POST https://{{host}}/api/public/samplebots/{{botId}}/add Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or Stream ID. You can access it from the General Settings page…

Used to initiate enable a channel for a bot. To use this API, app needs the Admin API Scope of Channel Management under ChannelManagement. POST https://{{host}}/api/public/bot/channels Query Parameters Parameter Required/ Optional Description host Required Environment URL, for example, https://bots.kore.ai Body Parameters Parameter Required/Optional Description streamId Required Stream or Bot ID…

To update the NLP thresholds and configurations To use this API, app needs the Bot Builder API scope of NLP Configurations. OR the Admin API Scope of NLP Configurations under Test and Train. POST https://{{host}}/api/public/bot/{{BotID}}/configurations?language={{languageCode}}&groupName={{groupName}} Query Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or…

To provide the number of users who have interacted with the bot in a given period across different time intervals. To use this API, the app needs the Bot Scope. POST https://{{host}}/api/public/bot/{{BotID}}/userEngagementTrend?aggregation_type={{type}}&start_date={{from}}&end_date={{to}}&channels={{channel}} Path Parameters Parameter Required/Optional Description host Required Environment URL, for example, https://bots.kore.ai BotID Required Bot ID or Stream…