{"id":48940,"date":"2022-11-20T06:06:56","date_gmt":"2022-11-20T06:06:56","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-3\/?p=48940"},"modified":"2022-12-01T07:03:33","modified_gmt":"2022-12-01T07:03:33","slug":"add-and-enable-a-new-language-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-3\/docs\/bots\/api-guide\/add-and-enable-a-new-language-api\/","title":{"rendered":"Add and Enable a New Language API"},"content":{"rendered":"
<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

To initiate the addition and enablement of a new language for a virtual assistant.<\/p>\n

 <\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\n\n

https:\/\/{{host}}\/api\/version-Id\/public\/bot\/botId\/language<\/code><\/p>\n

<\/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: Language Configuration<\/li>\n
  • Admin Console: Language Settings > Language Management<\/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
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
    host<\/span><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code>.<\/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
    \r\ncurl -X POST \\\r\nhttps:\/\/{{host}}\/api\/public\/users \\\r\n-H 'Content-Type: application\/json' \\\r\n-H 'auth: YOUR_JWT_ACCESS_TOKEN' \\\r\n-d '[\r\n{\r\n\"enableLanguage\" : \"\",\r\n\"langDefinitionMode\": {\r\n\"baseLanguage\": \"language_code\u201d,\r\n\"Type\": \"advancedConfig\/fileUpload\",\r\n\"fileId\":\"\",\r\n\"preferredData\":{\r\n\"Training\": true\/false,\r\n\"Faqs\": true\/false,\r\n\"ontology\": true\/false,\r\n\"smalltalk\": true\/false,\r\n\"traits\": true\/false\r\n}\r\n},\r\n\"multiLingualConfigurations\":{\r\n\"nluLanguage\": \"language_code\",\r\n\"inputTranslation\": true\/false,\r\n\"responseTranslation\": true\/false\r\n}\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\n\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nSub-parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/b><\/th>\n<\/tr>\n
    enableLanguage<\/span><\/td>\n<\/td>\nThe language to be enabled based on the language code.<\/td>\nRequired<\/td>\n<\/tr>\n
    langDefinitionMode<\/span><\/td>\n<\/td>\n<\/td>\nRequired<\/td>\n<\/tr>\n
    <\/td>\nlangDefinitionMode.baseLanguage<\/span><\/td>\nBase language of the Virtual Assistant.<\/td>\nOptional<\/td>\n<\/tr>\n
    <\/td>\nlangDefinitionMode.type<\/span><\/td>\nType of language enablement Basic<\/b>, advancedConfig<\/b>, or fileUpload<\/b>.<\/td>\nOptional<\/td>\n<\/tr>\n
    <\/td>\nlangDefinitionMode.fileId<\/span><\/td>\nThe file ID<\/b> for handling the file upload if the fileUpload<\/b> language enablement is selected.<\/td>\nOptional<\/td>\n<\/tr>\n
    <\/td>\nlangDefinitionMode.preferredData<\/span><\/td>\nIf the advancedConfig<\/b> language enablement is selected, the True\/False configuration setting for “training”,                                                               “faqs”,                                                                          “ontology”,                                                                              “Smalltalk” and                                                                    “traits” keys should be included.<\/td>\nOptional<\/td>\n<\/tr>\n
    multiLingualConfigurations<\/td>\n<\/td>\n<\/td>\nRequired<\/td>\n<\/tr>\n
    <\/td>\nmultiLingualConfigurations.nluLanguage<\/td>\nRefers to the language code of the bot language.<\/td>\nRequired<\/td>\n<\/tr>\n
    <\/td>\nmultiLingualConfigurations.inputTranslation<\/td>\nRefers to True\/False setting for the input language translation to English.<\/td>\nRequired<\/td>\n<\/tr>\n
    <\/td>\nmultiLingualConfigurations.responseTranslation<\/td>\nRefers to the True\/False setting for the response language translation to English.<\/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 Response<\/span><\/h2>\n
    For success case:<\/p>\n
    [{
    \n\u201cmessage\u201d: \u201cEnabled  language successfully\u201d,
    \n\u201cconfigurationDetails\u201d: {
    \n\"dialogs\":3,
    \n\"alerts\":0,
    \n\"actions\":0,
    \n\"knowledgetTasks\":0,
    \n\"smallTalk\":1,
    \n\"panels\":0,
    \n\"widgets\":0
    \n}
    \n}]<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"To initiate the addition and enablement of a new language for a virtual assistant.   Method POST Endpoint https:\/\/{{host}}\/api\/version-Id\/public\/bot\/botId\/language Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Language Configuration Admin Console: Language Settings > Language Management   Path Parameters Parameter Description host The environment URL. For...","protected":false},"author":21,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-48940","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/48940","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/users\/21"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/comments?post=48940"}],"version-history":[{"count":23,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/48940\/revisions"}],"predecessor-version":[{"id":49206,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/48940\/revisions\/49206"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/media?parent=48940"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/categories?post=48940"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/tags?post=48940"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}