{"id":18089,"date":"2018-12-04T13:58:10","date_gmt":"2018-12-04T13:58:10","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15683"},"modified":"2021-03-25T07:51:02","modified_gmt":"2021-03-25T07:51:02","slug":"import-bot-as-a-new-bot-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/import-bot-as-a-new-bot-api\/","title":{"rendered":"Import Bot as a New Bot API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Import Bot as a New Bot API is used to create a new bot in the account owner\u2019s Builder Tool using the File IDs generated by uploading the files to the local server. Refer to Upload File API<\/a> on how to upload and obtain the File Id.<\/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\/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\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<\/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\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
botDefinition<\/td>\n\u201cBot definition file id\u201d
\nRefer to Upload File API<\/a> on how to upload and obtain the File Id.<\/td>\n<\/tr>\n
configInfo<\/td>\n\u201cBot configuration file id\u201d
\nRefer to Upload File API<\/a> on how to upload and obtain the File Id.<\/td>\n<\/tr>\n
botFunctions (optional)<\/td>\n\u201c Bot fuctions File id\u201d
\nRefer to Upload File API<\/a> on how to upload and obtain the File Id.<\/td>\n<\/tr>\n
icon<\/td>\n\u201cBot icon File id\u201d
\nRefer to Upload File API<\/a> on how to upload and obtain the File Id.<\/td>\n<\/tr>\n
name (optional)<\/td>\n\u201cBot name\u201d
\nIf not provided they will be taken from the existing bot copy<\/td>\n<\/tr>\n
purpose (optional)<\/td>\n\u201ccustomer\u201d\/\u201demployee\u201d
\nIf not provided they will be taken from the existing bot copy<\/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\/import \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n   -H 'content-type: application\/json' \\\r\n   -d '{\r\n  \"botDefinition\" : \"5b7ed3c87cab5c48ea9794f9\",\r\n  \"configInfo\" : \"5b7ed2w77cab5c48ea9794fa\",\r\n  \"botFunctions\":[\"5b7ed13a86a5fc48f4777ea6\"],\r\n  \"icon\":\"5b7ed3837cab5c48ea9794fb\"\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\": \"f6e21f2d-cf90-52b0-bbc5-638add8dba26\",\r\n    \"statusLogs\": [\r\n        {\r\n            \"taskType\": \"importRequest\",\r\n            \"taskName\": \"SampleTaskName\",\r\n            \"status\": \"success\"\r\n        }\r\n    ],\r\n    \"createdBy\": \"u-3ae8bd39-a65b-5b2c-b66b-85864a8202c3\",\r\n    \"requestType\": \"Botimport\",\r\n    \"_id\": \"bir-32a5ed0d-6181-5a0a-9f21-1bf872290029\",\r\n    \"status\": \"pending\",\r\n    \"createdOn\": \"2018-12-05T07:28:46.113Z\",\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":"Import Bot as a New Bot API is used to create a new bot in the account owner\u2019s Builder Tool using the File IDs generated by uploading the files to the local server. Refer to Upload File API on how to upload and obtain the File Id. This API requires JWT generated by an application...","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-18089","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\/18089","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=18089"}],"version-history":[{"count":11,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18089\/revisions"}],"predecessor-version":[{"id":23080,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18089\/revisions\/23080"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18089"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18089"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18089"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}