{"id":18090,"date":"2018-12-04T13:59:33","date_gmt":"2018-12-04T13:59:33","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15687"},"modified":"2021-03-25T07:51:35","modified_gmt":"2021-03-25T07:51:35","slug":"import-bot-into-an-existing-bot-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/import-bot-into-an-existing-bot-api\/","title":{"rendered":"Import Bot into an Existing Bot API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Used to import bot definition file into an existing bot for upgrading to a new version or restoring to an earlier version.<\/p>\n

This API requires JWT generated by an application created only from Bot Admin Console.
\nTo use this API, app needs the Admin API Scope of Bot Import<\/em> under Bot Definition<\/em>.<\/p>\n

POST<\/strong> https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/import<\/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

Query Parameters<\/span><\/h3>\n

 <\/p>\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<\/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
botDefinition<\/td>\n\u201cBot Definition File id\u201d (refer here to obtain it)<\/a><\/td>\n<\/tr>\n
configInfo<\/td>\n\u201cBot Configuration File id\u201d (refer here to obtain it)<\/a><\/td>\n<\/tr>\n
botFunctions (Optional Field)<\/td>\n\u201cFileid\u201d<\/td>\n<\/tr>\n
importOptions<\/td>\nAll bot components are imported by default. If needed, you may specify the components to be included in the import.<\/p>\n
\"importOptions\": {\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
options<\/p>\n

(optional)<\/td>\n

This will indicate incremental import options for the ML utterances, whether to replace or append, see here for more<\/a>.<\/p>\n
\"options\": {\r\n     \"utterances\": {\r\n        \"replace\": true\r\n\t\"append\":false\r\n        }\r\n<\/pre>\n<\/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
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}}\/import \\\r\n  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \\\r\n  -H 'content-type: application\/json' \\\r\n  -d '{\r\n  \"botDefinition\" : \"5b7ed2b87cab5c48ea9794f9\",\r\n  \"configInfo\" : \"5b7ed2d77cab5c48ea9794fa\",\r\n  \"botFunctions\":[\"5b7ed33a86a5fc48f4777ea6\"]\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    \"streamRefId\": \"c685t327-8f93-588b-97bb-3399fa998bca\",\r\n    \"statusLogs\": [\r\n        {\r\n            \"taskType\": \"importRequest\",\r\n            \"taskName\": \"Sample Task\",\r\n            \"status\": \"success\"\r\n        }\r\n    ],\r\n    \"createdBy\": \"u-3ae8bd39-a63e-5b2c-b55b-85864a8202c3\",\r\n    \"requestType\": \"Botimport\",\r\n    \"_id\": \"bir-00b2baf0-7e02-523b-b317-79a372b91fc6\",\r\n    \"status\": \"pending\",\r\n    \"createdOn\": \"2018-12-05T07:40:51.956Z\",\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 import bot definition file into an existing bot for upgrading to a new version or restoring to an earlier version. This API requires JWT generated by an application created only from Bot Admin Console. To use this API, app needs the Admin API Scope of Bot Import under Bot Definition. POST https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/import Query...","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-18090","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\/18090","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=18090"}],"version-history":[{"count":10,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18090\/revisions"}],"predecessor-version":[{"id":23081,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18090\/revisions\/23081"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18090"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18090"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18090"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}