{"id":58938,"date":"2023-09-02T09:31:22","date_gmt":"2023-09-02T08:31:22","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=58938"},"modified":"2023-10-16T07:18:04","modified_gmt":"2023-10-16T06:18:04","slug":"create-a-test-suite-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/create-a-test-suite-api\/","title":{"rendered":"Create (Import) a Test Suite API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To create a conversation test suite by importing the test cases from a given file. This API returns dsId<\/strong><\/em>, the ID to check the import status.<\/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\/import<\/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: <\/span>Conversation Tests Management<\/span><\/li>\n
  • Admin Console: <\/span>Conversation Tests Management<\/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
    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<\/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\/import' \\\r\n      --header 'auth: {jwt-code}' \\\r\n      --header 'bot-language: {language-code}' \\\r\n      --header 'Content-Type: application\/json' \\\r\n      --data-raw '{\r\n          \"fileName\": \"64dxxxxxxxxxxxxxxxxxxxxc\", field(fileId)\r\n          \"name\": \"newtestcase\", \r\n          \"tags\" : [],\r\n          \"description\" : \"\"\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\n\n\n
    Parameter<\/th>\nDescription<\/th>\nMandate<\/th>\n<\/tr>\n<\/thead>\n
    fileName<\/strong><\/td>\nFile containing the conversation test suite details.<\/span><\/td>\nRequired<\/span><\/td>\n<\/tr>\n
    name<\/strong><\/td>\nTestSuite Name<\/span><\/td>\nRequired<\/span><\/td>\n<\/tr>\n
    tags<\/strong><\/td>\nConversation test cases tags list.<\/span><\/td>\nOptional<\/span><\/td>\n<\/tr>\n
    description<\/strong><\/td>\nTest suite description<\/span><\/td>\nOptional<\/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    \"dsId\": \"ds-f8xxxxx5-5xxa-5xx4-axx4-48xxxxxxxxx9\" \r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/section>
    \r\n\t
    \r\n\t\t
    \r\n\t\t\t\r\n\t\t<\/div>\r\n\t<\/div>\r\n<\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"To create a conversation test suite by importing the test cases from a given file. This API returns dsId, the ID to check the import status. Method POST Endpoint https:\/\/{{host}}\/api\/public\/stream\/:streamId\/conversation\/testsuite\/import Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Conversation Tests Management Admin Console: Conversation Tests Management...","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-58938","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\/58938","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=58938"}],"version-history":[{"count":6,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/58938\/revisions"}],"predecessor-version":[{"id":59759,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/58938\/revisions\/59759"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=58938"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=58938"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=58938"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}