To install a sample bot.
| Method | POST |
| Endpoint | https://{{host}}/api/public/samplebots/{{botId}}/add |
| Content Type | application/json |
| Authorization | auth: {{JWT}}
|
| API Scope |
|
Path Parameters
| Parameter | Description | Mandate |
|---|---|---|
| host | The environment URL. for example, https://bots.kore.ai | Required |
| BotID | Bot ID or Stream ID which can be accessed under General Settings on the Bot Builder. | Required |
Sample Request
curl -X POST \
'https://{{host}}/api/public/samplebots/{{bot_id}}/add' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
-H 'content-type: application/json' \
-H 'AccountId: xexxbaxxxbxbxxxxxxxxcxfb' \
-H 'userId: u-fbxxfxxx-axfd-xfcx-abxx-xcxxxxaxexxx' \
-H 'bot-language: en
Body Parameters
No Body parameters are passed.
Sample Response
{
"visibility": {
"namespace": "private",
"namespaceIds": [
"u-fbxxxxxx-a5xx-5xx8-abxx-6cxxxxxxxxxx"
]
},
"languages": [],
"screenShots": [],
"downloadCount": 0,
"alerts": [
"l-bexxxxxx-dxxe-5xx1-84xx-c0xxxxxxxxxx"
],
"actions": [],
"dialogs": [
"dg-cbxxxxxx-cxx4-5fxx-8xx6-b2xxxxxxxxxx",
"dg-35xxxxxx-bxx7-58xx-bxxa-0bxxxxxxxxxx"
],
"widgets": [],
"panels": [],
"forms": [],
"categoryIds": [
"451xxxxxxxxxxxxxxxxxxxxx"
],
"class": [],
"featured": false,
"profileRequired": true,
"sendVcf": false,
"isNLEnabled": true,
"interruptsEnabled": true,
"state": "setup",
"defaultLanguage": "en",
"_id": "st-cxxxxxxe-exxe-5xx3-8xx0-2cxxxxxxxxxx",
"modifiedOn": "2021-01-12T10:55:11.551Z",
"sBannerColor": "#E44929",
"bBannerColor": "#E44929",
"createdOn": "2021-01-12T10:55:11.115Z",
"createdBy": "u-fbxxxxxx-axxd-5xx8-axx4-6cxxxxxxxxxx",
"lastModifiedBy": "u-fbxxxxxx-axxd-5fxx-axx4-6cxxxxxxxxxx",
"accountId": "5e8xxxxxxxxxxxxxxxxxxxxx",
"sharedBy": [],
"__v": 0,
"name": "Asana Sample_botowner@koreai.in_34",
"keywords": [],
"originalName": "Asana Sample",
"icon": "58fxxxxxxxxxxxxxxxxxxxxx",
"color": "#E44929"
}