{"id":58948,"date":"2023-09-02T10:41:19","date_gmt":"2023-09-02T09:41:19","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=58948"},"modified":"2023-10-16T07:13:17","modified_gmt":"2023-10-16T06:13:17","slug":"execute-a-test-suite-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/execute-a-test-suite-api\/","title":{"rendered":"Execute a Test Suite API"},"content":{"rendered":"
<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

To execute Conversation Test Suites and get results. This API only initiates the test process and returns the execution status and testRunId<\/i><\/b> to track the execution status. Please look at the Conversation Test Suite Execution Status API<\/a> for the results of the test.<\/span><\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nPOST<\/span><\/td>\n<\/tr>\n
Endpoint<\/strong><\/td>\nhttps:\/\/{{host}}\/api\/public\/stream\/:streamId\/conversation\/testsuite\/:testSuiteName\/run<\/code><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See <\/span>How to generate the JWT Token<\/span><\/a>.<\/span><\/td>\n<\/tr>\n

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Conversation Tests Execution<\/span><\/li>\n
  • Admin Console: Conversation Tests Execution<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Query Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\nMandate<\/th>\n<\/tr>\n<\/thead>\n
    host<\/b><\/span><\/td>\nEnvironment URL. For example,https:\/\/bots.kore.ai<\/code><\/span><\/td>\nRequired<\/td>\n<\/tr>\n
    StreamID<\/b><\/td>\nThe \u00a0Stream ID<\/i> can be accessed under General Settings<\/b> on the Bot Builder.<\/span><\/td>\nRequired<\/td>\n<\/tr>\n
    testSuiteName<\/b><\/td>\nName of the test suite on the Bot Builder.<\/span><\/td>\nRequired<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request<\/span><\/h2>\n
    curl --location --request POST \\\r\n      'https:\/\/{{host}}\/api\/public\/stream\/:streamId\/conversation\/testsuite\/:testSuiteName\/run' \\\r\n      --header 'auth: {jwt-token}' \\\r\n      --header 'bot-language: {language-code}' \\\r\n      --header 'Content-Type: application\/json' \\\r\n      --data-raw '{\r\n         \"version\":\"inDevelopment\" \r\n         }'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Body Parameters<\/span><\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\nMandate<\/th>\n<\/tr>\n<\/thead>\n
    version<\/strong><\/td>\nThe version of the bot against which the execution is required. The following options are available:
    \n<\/span><\/p>\n
      \n
    • published<\/i><\/b> for the published version.<\/span><\/li>\n
    • inDevelopment<\/i><\/b> for the configured version.<\/span><\/li>\n<\/ul>\n<\/td>\n
    		Required<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Response<\/span><\/h2>\n
    {\r\n    \"status\": \"IN_PROGRESS\",\r\n    \"testRunId\": \"ctr-80xxxx9a-bxx1-58xx-axx7-d5xxxxxxxxxx\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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}} See How...","protected":false},"author":21,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-58948","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/58948","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/21"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=58948"}],"version-history":[{"count":4,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/58948\/revisions"}],"predecessor-version":[{"id":59762,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/58948\/revisions\/59762"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=58948"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=58948"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=58948"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}