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. This API supports exporting test cases created through file upload. It doesn’t support exporting test data added manually to the batch test suite.

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 Console: Batch Tests Management

Query Parameters¶

PARAMETER	DESCRIPTION	MANDATE
host	The environment URL. For example, `https://platform.kore.ai`	Required
BotID	The Bot ID or Stream ID can be accessed under General Settings on the Bot Builder.	Required
testSuiteName	The name of the test suite created on the Bot Builder for the export. Note: Only Custom Batch Test Suites can be exported.	Required

Sample Request¶

curl -X POST \
  https://{host}/api/public/bot/{botId}/testsuite/{testSuiteName}/export \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'bot-language: {language-code}' \

Body Parameters¶

No body parameters are passed.

Sample Response¶

{
    "downloadUrl": {{downloadURL}},
    "name": "Batch Test Name",
    "description": "Batch Test Description"
}