This API requires the JWT generated by an application created on the Admin Console.
| Field | Value |
|---|---|
| Method | POST |
| Endpoint | https://{{host}}/api/public/bot/{{BotID}}/import |
| Content Type | application/json |
| Authorization | auth: {{JWT}} See How to generate the JWT Token. |
| API Scope | App Builder: Not Applicable; Admin Console: Bot Definition > Bot Import |
Query Parameters
| Parameter | Required | Description |
|---|---|---|
host | Required | The environment URL. For example, https://platform.kore.ai |
BotID | Required | The 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": [
"taxonomy",
"connectors",
"autoQA"
],
"storyBoardScenes": {
"includeComments": true
},
"customDashboard": true,
"options": {
"utterances": {
"append": true,
"replace": false
},
"patterns": {
"append": true,
"replace": false
},
"botVariables":{
"ignore": ["ab","test2"],
"ignoreEnvironmentVariables": false,
"ignoreContentVariables": true
}
}
}
}'
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
| Parameter | Required | Description |
|---|---|---|
botDefinition | Required | Bot Definition File ID. |
configInfo | Required | Bot Configuration File ID. |
botFunctions | Optional | Bot functions file ID. |
importOptions | Required | The system imports all bot components by default. If needed, you can specify which components to include in the import. Accepted fields: tasks, nlpData, settings, AgentAssist, qualityAI. |
options | Optional | Incremental import options for the ML utterances, whether to replace or append. |
botVariables | Optional | Represents the environment variables. |
ignoreEnvironmentVariables | Set to true to exclude environment variables during import. | Optional |
ignoreContentVariables | Set to true to exclude content variables during import. | Optional |
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
}