{"id":18087,"date":"2018-12-04T13:57:07","date_gmt":"2018-12-04T13:57:07","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=15671"},"modified":"2022-12-01T06:09:06","modified_gmt":"2022-12-01T06:09:06","slug":"bot-export-status-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/bot-export-status-api\/","title":{"rendered":"Bot Export – Status API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Gets the status of Bot Export request and also provides the download link of the bot export copy after the export is completed. Refer here for initiating Bot Export API<\/a>.<\/span><\/p>\n

 <\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nGET<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\n\n

https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/export\/status<\/code><\/p>\n

<\/span><\/td>\n<\/tr>\n

Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\n\n

auth: {{JWT}}<\/code><\/p>\n

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

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Bot Export<\/li>\n
  • Admin Console: Bot Definition > Bot Export<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    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>\nThe environment URL. For example,https:\/\/bots.kore.ai<\/code><\/span><\/td>\nRequired<\/td>\n<\/tr>\n
    BotID<\/b><\/td>\nBot ID<\/i> or Stream 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\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Sample Request<\/span><\/h2>\n
    curl -X GET \\ \r\n  https:\/\/{{host}}<\/span>\/api\/public\/bot\/{{BotID}}\/export\/status \\\r\n  -H 'auth:  {{YOUR_JWT_ACCESS_TOKEN}}' \\<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Body Parameters<\/span><\/h2>\n
    No body parameters are passed.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Sample Response<\/span><\/h2>\n
    {\r\n    \"_id\": \"ber-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"botId\": \"st-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"createdBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"exportType\": \"published\",\r\n    \"requestType\": \"Botexport\",\r\n    \"status\": \"success\",\r\n    \"createdOn\": \"2018-12-05T07:18:40.028Z\",\r\n    \"__v\": 0,\r\n    \"downloadURL\": \"{{url}}\",\r\n    \"fileId\": \"{{file-id}\",\r\n\u00a0   \"store\": {\r\n        \"urlParams\": \"url-params\"\r\n    },\r\n    \"fileSize\": \"947\"\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Gets the status of Bot Export request and also provides the download link of the bot export copy after the export is completed. Refer here for initiating Bot Export API.   Method GET Endpoint https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/export\/status Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Bot Export Admin...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-18087","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\/18087","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\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=18087"}],"version-history":[{"count":15,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18087\/revisions"}],"predecessor-version":[{"id":49378,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18087\/revisions\/49378"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18087"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18087"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18087"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}