{"id":18091,"date":"2018-12-04T14:00:55","date_gmt":"2018-12-04T14:00:55","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=15693"},"modified":"2022-11-30T15:52:53","modified_gmt":"2022-11-30T15:52:53","slug":"bot-import-status-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/bot-import-status-api\/","title":{"rendered":"Bot Import Status API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To get the status of the bot import request initiated using the Import Bot<\/b> API for a new bot or an existing bot.<\/p>\n

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

 <\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nGET<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/import\/status\/{{BotImportBIR}}<\/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\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<\/td>\nRequired<\/td>\n<\/tr>\n
    BotImportBIR<\/b><\/td>\nbir-xxxxxxx-xxx-xxxx-xxxxx-xxxxxxxxxx<\/span>. The BIR ID is found in the response of the Import Bot as a New Bot API<\/a> endpoint.<\/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}}\/api\/public\/bot\/import\/status\/bir-xxxxxxx-xxx-xxxx-xxxxx-xxxxxxxxxx \\\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 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{\r\n    \"_id\": \"bir-5fxxxxxx-a0xx-52xx-axxf-f3xxxxxxxxxx\",\r\n    \"status\": \"success\",\r\n    \"streamRefId\": \"d1xxxxxx-bxx7-5cxx-axx7-a8xxxxxxxxxx\",\r\n    \"statusLogs\": [\r\n        {\r\n            \"taskType\": \"importRequest\",\r\n            \"taskName\": \"SampleBot\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"Bot Definition\",\r\n            \"taskName\": \"SampleBot\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"IdpConfigurations\",\r\n            \"taskName\": \"IdpConfigurations\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"CustomTemplates\",\r\n            \"taskName\": \"CustomTemplates\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"BotFunctions\",\r\n            \"taskName\": \"Bot Functions\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"Widget\",\r\n            \"taskName\": \"UnderwritingExplanation\",\r\n            \"status\": \"success\"\r\n        },\r\n       \r\n       \r\n        {\r\n            \"taskType\": \"Dialog\",\r\n            \"taskName\": \"Test Firebase Service\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"Form\",\r\n            \"taskName\": \"BloodPressure\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"Widget\",\r\n            \"taskName\": \"WidgetPhysique\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"Dialog\",\r\n            \"taskName\": \"ShowDiseaseList\",\r\n            \"status\": \"success\"\r\n        },\r\n        \r\n        {\r\n            \"taskType\": \"Event\",\r\n            \"taskName\": \"TASK_FAILURE_EVENT\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"Event\",\r\n            \"taskName\": \"WELCOME_MESSAGE_EVENT\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"Event\",\r\n            \"taskName\": \"INTENT_UNIDENTIFIED\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"Event\",\r\n            \"taskName\": \"CONVERSATION_END\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"KnowledgeTasks\",\r\n            \"taskName\": \"KnowledgeTasks\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"Utterences\",\r\n            \"taskName\": \"Utterences\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"Patterns\",\r\n            \"taskName\": \"Patterns\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"BotVariables\",\r\n            \"taskName\": \"BotVariables\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"SmallTalk\",\r\n            \"taskName\": \"SmallTalk\",\r\n            \"status\": \"success\"\r\n        },\r\n        {\r\n            \"taskType\": \"importBot\",\r\n            \"taskName\": \"SampleBot\",\r\n            \"status\": \"success\"\r\n        }\r\n    ],\r\n    \"createdBy\": \"u-adxxxxxx-e9xx-5xxd-axxc-21xxxxxxxxxx\",\r\n    \"requestType\": \"Botimport\",\r\n    \"createdOn\": \"2022-07-29T07:24:17.496Z\",\r\n    \"__v\": 0,\r\n    \"streamId\": \"st-8axxxxxx-0xxb-5axx-9xx2-97xxxxxxxxxx\"\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>\n","protected":false},"excerpt":{"rendered":"To get the status of the bot import request initiated using the Import Bot API for a new bot or an existing bot. Note: This API requires the JWT generated by an application created on the Bot Admin Console.   Method GET Endpoint https:\/\/{{host}}\/api\/public\/bot\/import\/status\/{{BotImportBIR}} Content Type application\/json Authorization auth: {{JWT}} See How to generate the...","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-18091","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\/18091","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=18091"}],"version-history":[{"count":26,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18091\/revisions"}],"predecessor-version":[{"id":49367,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18091\/revisions\/49367"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18091"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18091"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18091"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}