{"id":26470,"date":"2021-01-15T08:24:11","date_gmt":"2021-01-15T08:24:11","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=26470"},"modified":"2022-12-05T09:09:15","modified_gmt":"2022-12-05T09:09:15","slug":"install-sample-bot-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/install-sample-bot-api\/","title":{"rendered":"Install a Sample Bot API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To install a sample bot.<\/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\/samplebots\/{{botId}}\/add<\/code><\/span><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\nauth: {{JWT}}
\nAccountId: {{accountId}}
\nuserId: {{userId}}
\nbot-language : en <\/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 Create<\/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

    Path Parameters<\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/b><\/th>\n<\/tr>\n
    host<\/b><\/td>\nThe environment URL. for example, https:\/\/bots.kore.ai<\/td>\nRequired<\/td>\n<\/tr>\n
    BotID<\/b><\/td>\nBot ID<\/i> or Stream ID<\/i> which can be accessed under General Settings<\/b> on the Bot Builder.<\/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\/samplebots\/{{bot_id}}\/add' \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -H 'content-type: application\/json' \\\r\n  -H 'AccountId: xexxbaxxxbxbxxxxxxxxcxfb' \\\r\n  -H 'userId: u-fbxxfxxx-axfd-xfcx-abxx-xcxxxxaxexxx' \\\r\n  -H 'bot-language: en \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
    No Body parameters are 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    \"visibility\": {\r\n        \"namespace\": \"private\",\r\n        \"namespaceIds\": [\r\n            \"u-fbxxxxxx-a5xx-5xx8-abxx-6cxxxxxxxxxx\"\r\n        ]\r\n    },\r\n    \"languages\": [],\r\n    \"screenShots\": [],\r\n    \"downloadCount\": 0,\r\n    \"alerts\": [\r\n        \"l-bexxxxxx-dxxe-5xx1-84xx-c0xxxxxxxxxx\"\r\n    ],\r\n    \"actions\": [],\r\n    \"dialogs\": [\r\n        \"dg-cbxxxxxx-cxx4-5fxx-8xx6-b2xxxxxxxxxx\",\r\n        \"dg-35xxxxxx-bxx7-58xx-bxxa-0bxxxxxxxxxx\"\r\n    ],\r\n    \"widgets\": [],\r\n    \"panels\": [],\r\n    \"forms\": [],\r\n    \"categoryIds\": [\r\n        \"451xxxxxxxxxxxxxxxxxxxxx\"\r\n    ],\r\n    \"class\": [],\r\n    \"featured\": false,\r\n    \"profileRequired\": true,\r\n    \"sendVcf\": false,\r\n    \"isNLEnabled\": true,\r\n    \"interruptsEnabled\": true,\r\n    \"state\": \"setup\",\r\n    \"defaultLanguage\": \"en\",\r\n    \"_id\": \"st-cxxxxxxe-exxe-5xx3-8xx0-2cxxxxxxxxxx\",\r\n    \"modifiedOn\": \"2021-01-12T10:55:11.551Z\",\r\n    \"sBannerColor\": \"#E44929\",\r\n    \"bBannerColor\": \"#E44929\",\r\n    \"createdOn\": \"2021-01-12T10:55:11.115Z\",\r\n    \"createdBy\": \"u-fbxxxxxx-axxd-5xx8-axx4-6cxxxxxxxxxx\",\r\n    \"lastModifiedBy\": \"u-fbxxxxxx-axxd-5fxx-axx4-6cxxxxxxxxxx\",\r\n    \"accountId\": \"5e8xxxxxxxxxxxxxxxxxxxxx\",\r\n    \"sharedBy\": [],\r\n    \"__v\": 0,\r\n    \"name\": \"Asana Sample_botowner@koreai.in_34\",\r\n    \"keywords\": [],\r\n    \"originalName\": \"Asana Sample\",\r\n    \"icon\": \"58fxxxxxxxxxxxxxxxxxxxxx\",\r\n    \"color\": \"#E44929\"\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 install a sample bot.   Method POST Endpoint https:\/\/{{host}}\/api\/public\/samplebots\/{{botId}}\/add Content Type application\/json Authorization auth: {{JWT}} AccountId: {{accountId}} userId: {{userId}} bot-language : en See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console: Bot Definition > Bot Create   Path Parameters Parameter Description Mandate host The environment URL. for example,...","protected":false},"author":17,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-26470","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\/26470","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\/17"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=26470"}],"version-history":[{"count":17,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/26470\/revisions"}],"predecessor-version":[{"id":49454,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/26470\/revisions\/49454"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=26470"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=26470"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=26470"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}