Skip to content

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 the 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
  • Bot Builder: Batch Tests Execution
  • Admin Console: Not Applicable

Query Parameters

PARAMETER DESCRIPTION MANDATE
host The environment URL. For example, https://platform.kore.ai Required
BotID Bot ID or Stream ID can be accessed under General Settings on the Bot Builder. Required
testSuiteName Name of the test suite on the Bot Builder. Required

Sample Request

curl --location --request POST \
      'https://{host}/api/public/stream/{streamId}/testsuite/{testSuiteName}/run' \
      --header 'auth: {jwt-token}' \
      --header 'bot-language: {language-code}' \
      --header 'Content-Type: application/json' \
      --data-raw '{
         "version":"inDevelopment",
         "engine":"dgpt"
         }'

Note

  • If [engine = "regression" (or) empty] or engine is not provided, it will execute for ML Batch Testing.

  • If engine is set to "dgpt", it will execute for Dialog GPT Batch Testing.

Body Parameters

PARAMETER DESCRIPTION MANDATE
version The version of the bot against which the execution is required
  • published for Published version
  • inDevelopment for the Configured version
 Required

Sample Response

{
    "status": "accepted",
    "requestId": "tr-acfxxbff-xxxf-xaxx-bbbx-exxxabaxxcxx"
}