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.
| Method | POST |
| Endpoint | https://{{host}}/api/public/stream/:streamId/conversation/testsuite/:testSuiteName/run |
| Content Type | application/json |
| Authorization | auth: {{JWT}}
|
| API Scope |
|
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:
|
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"
}