{"id":18086,"date":"2018-12-04T13:55:30","date_gmt":"2018-12-04T13:55:30","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15663"},"modified":"2021-03-25T07:52:14","modified_gmt":"2021-03-25T07:52:14","slug":"bot-export-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/bot-export-api\/","title":{"rendered":"Bot Export API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Used to export bot definition and all associated components. This API only initiates the export process. Use Export Status API<\/a> to view the progress of the export and also to get a link to download the file once the export is completed.<\/p>\n

To use this API, app needs the Admin API Scope of Bot Export<\/em> under Bot Definition<\/em>.<\/p>\n

POST<\/b> https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/export<\/code><\/span><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
host<\/span><\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/code><\/span><\/td>\n<\/tr>\n
BotID<\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Body Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
exportType<\/td>\nBot type –<\/p>\n
    \n
  • ‘latest<\/em>‘ or<\/li>\n
  • ‘published<\/em>‘<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
exportOptions (optional)<\/td>\nAll bot components are exported by default. If needed, you may specify the components to be included in the export.<\/p>\n
\"exportOptions\": {\r\n      \"tasks\": [\r\n             \"botTask\",\r\n             \"knowledgeGraph\"\r\n           ],\r\n      \"nlpData\": [\r\n             \"nlpSettings\",\r\n             \"utterances\",\r\n             \"standardResponses\"\r\n           ],\r\n      \"settings\": [\r\n             \"botSettings\",\r\n             \"botVariables\",\r\n             \"ivrSettings\"\r\n           ]\r\n   },<\/pre>\n<\/td>\n<\/tr>\n
subTasks
\n(optional)<\/td>\n		For partial export mention the tasks to be exported.<\/p>\n
    \"subTasks\": {\r\n        \"dialogs\": [\"<dialog Name 1>\",\"<dialog Name 2>\"],\r\n        \"alerts\": [\"<alert name 1>\",\"<alert name 2>\"],\r\n        \"actions\": [\"<action name 1>\",\"<action name 2>\"]\r\n    }\r\n<\/pre>\n<\/td>\n<\/tr>\n
IncludeDependentTasks
\n(optional)<\/td>\n		To include dependent tasks for export<\/p>\n
\"IncludeDependentTasks\":<\/pre>\n<\/td>\n<\/tr>\n
allTasks
\n(optional)<\/td>\n		To include all tasks for export, will be ignored if subTasks<\/em> is present<\/p>\n
\"allTasks\":<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
For more on the optional parameters for partial import and dependent tasks, see here<\/a>.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Authorization<\/span><\/h3>\n
Invoke the API with JWT in the header with the following syntax:<\/p>\n
auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Response content type<\/span><\/h3>\n
application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Request<\/span><\/h3>\n
curl -X POST \\\r\n  https:\/\/{{host}}\/api\/public\/bot\/{{BotID}\/export \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}<\/em>' \\\r\n  -H 'content-type: application\/json' \\\r\n  -d '{\r\n     \"exportType\": \"published\"\r\n     }'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\n
{\r\n    \"status\": \"pending\",\r\n    \"streamId\": \"st-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"createdBy\": \"u-xxx-xxx-xxx-xxx-xxxxx\",\r\n    \"exportType\": \"published\",\r\n    \"requestType\": \"Botexport\",\r\n    \"_id\": \"ber-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"status\": \"pending\",\r\n    \"createdOn\": \"2018-12-05T07:18:40.028Z\",\r\n    \"__v\": 0\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":"Used to export bot definition and all associated components. This API only initiates the export process. Use Export Status API to view the progress of the export and also to get a link to download the file once the export is completed. To use this API, app needs the Admin API Scope of Bot Export...","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-18086","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18086","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=18086"}],"version-history":[{"count":11,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18086\/revisions"}],"predecessor-version":[{"id":23084,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18086\/revisions\/23084"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18086"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18086"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18086"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}