{"id":18089,"date":"2018-12-04T13:58:10","date_gmt":"2018-12-04T13:58:10","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=15683"},"modified":"2022-11-30T15:42:39","modified_gmt":"2022-11-30T15:42:39","slug":"import-bot-as-a-new-bot-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/import-bot-as-a-new-bot-api\/","title":{"rendered":"Import Bot as a New Bot API"},"content":{"rendered":"
<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

To create a new bot in the account owner\u2019s Builder Tool using the File IDs<\/i> generated when uploading the files to the local server.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

Please refer to the Upload File API<\/a> for uploading and obtaining the File Id<\/i><\/b>.<\/p>\n<\/p><\/div><\/div>\r\n\t

\r\n\t\t
\r\n\t\t\t

 <\/p>\n

Note<\/b>: The API requires the JWT generated by an application created only from the Bot Admin Console<\/b>.<\/p>\n

 <\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/import<\/code><\/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: Not Applicable<\/li>\n
  • Admin Console: Bot Definition > Bot Import<\/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
    Parameter<\/th>\nDescription<\/th>\nMandate<\/th>\n<\/tr>\n<\/thead>\n
    host<\/span><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/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 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\" : \"5bxxxxxxxxxxx4f9\",\r\n  \"configInfo\" : \"5bxxxxxxxxxxxxx4fa\",\r\n  \"botFunctions\":[\"5bxxxxxxxxxxxxxea6\"],\r\n  \"icon\":\"5bxxxxxxxxxxxxxxxx4fb\"\r\n}'<\/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\n\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\nMandate<\/th>\n<\/tr>\n<\/thead>\n
    botDefinition<\/b><\/td>\n\u201cBot definition file id\u201d<\/td>\nRequired<\/td>\n<\/tr>\n
    configInfo<\/b><\/td>\n\u201cBot configuration file id\u201d<\/td>\nRequired<\/td>\n<\/tr>\n
    botFunctions<\/b><\/td>\n\u201cBot functions File id\u201d<\/td>\nOptional<\/td>\n<\/tr>\n
    icon<\/b><\/td>\n\u201cBot icon File id\u201d<\/td>\nRequired<\/td>\n<\/tr>\n
    name<\/b><\/td>\n\u201cBot name\u201d
    – If not provided, it is fetched from the existing bot’s copy.<\/td>\n    		Optional<\/td>\n<\/tr>\n
    purpose<\/b><\/td>\n\u201ccustomer\u201d\/\u201demployee\u201d
    – If not provided, it is fetched from the existing bot’s copy.<\/td>\n    		Optional<\/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 Response<\/span><\/h2>\n
    {\r\n    \"status\": \"pending\",\r\n    \"\"streamId\": \"st-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n    \"statusLogs\": [\r\n        {\r\n            \"taskType\": \"importRequest\",\r\n            \"taskName\": \"Welcome\",\r\n            \"status\": \"success\"\r\n        }\r\n    ],\r\n    \"createdBy\": \"u-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\",\r\n    \"requestType\": \"Botimport\",\r\n    \"bir\": \"bir-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\r\n    \"createdOn\": \"2022-07-29T07:24:17.496Z\",\r\n    \"__v\": 0\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>
    <\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"To create a new bot in the account owner\u2019s Builder Tool using the File IDs generated when uploading the files to the local server. Please refer to the Upload File API for uploading and obtaining the File Id.   Note: The API requires the JWT generated by an application created only from the Bot 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-18089","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\/18089","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=18089"}],"version-history":[{"count":34,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18089\/revisions"}],"predecessor-version":[{"id":49364,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18089\/revisions\/49364"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18089"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18089"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18089"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}