API Guide

Billing Sessions API

This API retrieves the list of individual billing sessions created for a bot so that you can review them for correctness and reconciliation. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/getBillingSessionsDetails For Bot Admin Console: https://{{host}}/api/public/getBillingSessionsDetails Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Billing Sessions…

Delete Batch Test Suite Execution API

To delete a specific execution of a Batch Test Suite.   Method DELETE Endpoint https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/{testRunId} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Batch Tests Management Admin Console: Batch Tests Management   Query Parameters Parameter Description Mandate host The environment URL.…

Delete Batch Test Suite API

To delete a Batch Test Suite.   Method DELETE Endpoint https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Batch Tests Management Admin Console: Batch Tests Management   Query Parameters Parameter Description Mandate host The environment URL. For example, https://bots.kore.ai Required…

Import Batch Test Suite API

To import the test cases from a given Test Suite file.   Method POST Endpoint https://{host}/api/public/bot/{botId}/testsuite/import

Export Batch Test Suite API

To export the test cases of a given Batch Test Suite and get a link to download the file once the export is completed.   Method POST Endpoint https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/export Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Batch Tests Management Admin…

Get Batch Test Suites API

To get the list of Batch Test Suites available for a bot.   Method GET Endpoint https://{host}/api/public/bot/{botId}/testsuite?skip={skip}&limit={limit} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Batch Tests Management Admin Console: Batch Tests Management   Path Parameters Parameter Description Mandate host The…

Batch Test Execution Status API

To get the status of the Batch Test Execution request against a unique ‘Request Id’ and provide the download link for the results file after the test execution is complete. Please refer to the Batch Test Execution API to learn more. Method GET Endpoint https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/{testRunId}/status Content Type application/json Authorization auth:…

Batch Test Execution API

To execute Batch Test Suites and get results. This API only initiates the test process. Please look at the Batch Test Execution Status API for results of the batch test.   Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/testsuite/{testSuiteName}/run Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope…

Install a Sample Bot API

To install a sample bot.   Method POST Endpoint https://{{host}}/api/public/samplebots/{{botId}}/add Content Type application/json Authorization auth: {{JWT}} AccountId: {{accountId}} userId: {{userId}} bot-language : en See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console: Bot Definition > Bot Create   Path Parameters Parameter Description Mandate host…

Channel Enablement API

To initiate enable a channel for a virtual assistant. Method POST Endpoint https://{{host}}/api/public/channels   Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console: Channel Management   Query Parameters Parameter Description Mandate host The environment URL. For example, https://bots.kore.ai…
Menu