Execute a Test Suite API¶

To execute Conversation Test Suites and get results. This API only initiates the test process and returns the execution status and testRunId to track the execution status. Please look at the Conversation Test Suite Execution Status API for the results of the test.

Important

Testers can't run conversation test suites through the interface or API.

Method	POST
Endpoint	`https://{{host}}/api/public/stream/:streamId/conversation/testsuite/:testSuiteName/run`
Content Type	`application/json`
Authorization	`auth: {{JWT}}` See How to generate the JWT Token.
API Scope	Bot Builder: Conversation Tests Execution Admin Console: Conversation Tests Execution

Query Parameters¶

PARAMETER	DESCRIPTION	MANDATE
host	Environment URL. For example,`https://bots.kore.ai`	Required
StreamID	The 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 
      'https://{{host}}/api/public/stream/:streamId/conversation/testsuite/:testSuiteName/run' \
      --header 'auth: {jwt-token}' \
      --header 'bot-language: {language-code}' \
      --header 'Content-Type: application/json' \
      --data-raw '{
         "version": "published", "userEmailId": "email-id-of-the-bot-owner-or-developer" 
         }'

Body Parameters¶

PARAMETER	DESCRIPTION	MANDATE
version	The version of the bot against which the execution is required. The following options are available: *published* for the published version. *inDevelopment* for the configured version.	Required
userEmailId	The email ID of the bot owner or a developer with whom the bot is shared. For example, “userEmailId”: “john.stevens@kore.com“	Required

Sample Response¶

{
    "status": "IN_PROGRESS",
    "testRunId": "ctr-80xxxx9a-bxx1-58xx-axx7-d5xxxxxxxxxx"
}