Skip to main content
Back to API List To import the bot definition file to an existing bot for a current version upgrade or previous version restoration. You can import into a bot using either individual Definition, Config, Functions and Icon files, or you can directly use the zip file that’s created while performing bot export. In this case you need to upload the zip file and use the File ID thus generated.
This API requires the JWT generated by an application created on the Admin Console.
FieldValue
MethodPOST
Endpointhttps://{{host}}/api/public/bot/{{BotID}}/import
Content Typeapplication/json
Authorizationauth: {{JWT}} See How to generate the JWT Token.
API ScopeApp Builder: Not Applicable; Admin Console: Bot Definition > Bot Import

​
Query Parameters

ParameterRequiredDescription
hostRequiredThe environment URL. For example, https://platform.kore.ai
BotIDRequiredThe Bot ID or Stream ID. You can access it under General Settings on the App Builder.

​
Sample Request for the Universal Bot

curl -X POST \
  https://{{host}}/api/public/bot/{{BotID}}/import \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -H 'content-type: application/json' \
  -d '
curl --location 'https://{{host}}/api/public/bot/{{BotID}}/import' \
--header 'auth: YOUR_JWT_ACCESS_TOKEN' \
--header 'content-type: application/json' \
--data '{
   "botDefinition": "6a14221546**************",
   "configInfo": "6a1422397***************",
   "importOptions": {
       "nlpData": [
           "nlpSettings",
           "utterances",
           "patterns",
           "synonyms",
           "concepts"
       ],
       "tasks": [
           "smallTalk",
           "knowledgeGraph",
           "forms",
           "botTask"
       ],
       "settings": [
           "botSettings",
           "botVariables",
           "ivrSettings",
           "genAIandLLMSettings"
       ],
       "AgentAssist": [
           "rules",
           "playbooks"
       ],
       "qualityAI": [],
       "storyBoardScenes": {
           "includeComments": true
       },
       "customDashboard": true,
       "options": {
           "utterances": {
               "append": true,
               "replace": false
           },
           "patterns": {
               "append": true,
               "replace": false
           },
           "botVariables":{                                                                                                              
                 "ignore": ["ab","test2"]
             }
       }
   }
}'

​
Sample Request

curl -X POST \
  https://{{host}}/api/public/bot/{{BotID}}/import \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -H 'content-type: application/json' \
  -d '{
  "botDefinition" : "5bxxxxxxxxxxxxxxxxxxxxxx",
  "configInfo" : "5bxxxxxxxxxxxxxxxxxxxxxx",
  "botFunctions":["5bxxxxxxxxxxxxxxxxxxxxxx"]
}'

​
Body Parameters

ParameterRequiredDescription
botDefinitionRequiredBot Definition File ID.
configInfoRequiredBot Configuration File ID.
botFunctionsOptionalBot functions file ID.
importOptionsRequiredThe system imports all bot components by default. If needed, you can specify which components to include in the import. Accepted fields: tasks, nlpData, settings.
optionsOptionalIncremental import options for the ML utterances, whether to replace or append.
botVariablesOptionalRepresents the environment variables.

​
Sample Response

{
    "streamRefId": "c685t327-xxxx-58xx-9xbx-33xxxxxxxxxx",
    "statusLogs": [
        {
            "taskType": "importRequest",
            "taskName": "Sample Task",
            "status": "success"
        }
    ],
    "createdBy": "u-3xxxxxxx-axxe-5bxx-bxxb-8xxxxxxxxxxx",
    "requestType": "Botimport",
    "_id": "bir-00bxxxxx-7xx2-5xxx-bxxx-79xxxxxxxxxx",
    "status": "pending",
    "createdOn": "2018-12-05T07:40:51.956Z",
    "__v": 0
}