{"id":18088,"date":"2018-12-04T13:59:13","date_gmt":"2018-12-04T13:59:13","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15678"},"modified":"2021-03-25T08:27:08","modified_gmt":"2021-03-25T08:27:08","slug":"upload-file-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/upload-file-api\/","title":{"rendered":"Upload File API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Used to Upload the botdefinition, botconfig, and botfunction file (if any) as well as the bot icon to the local server and get the file ID to be used in Import Bot API<\/a>. You need to upload the files separately.<\/p>\n

POST<\/b> https:\/\/{{host}}\/api\/public\/uploadfile<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h2>\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
host<\/span><\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Body Parameters<\/span><\/h2>\n

The Parameters to be passed would vary depending upon the file id that is required.<\/p>\n

For Bot Definition File ID<\/span><\/span><\/h3>\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
file<\/span><\/td>\nUpload the Botdefinition.json<\/td>\n<\/tr>\n
fileContext<\/td>\nbulkImport<\/td>\n<\/tr>\n
fileExtension<\/td>\njson<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

For Bot Config File ID<\/span><\/span><\/h3>\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
file<\/span><\/td>\nUpload the Botconfig.json<\/span><\/td>\n<\/tr>\n
fileContext<\/td>\nbulkImport<\/td>\n<\/tr>\n
fileExtension<\/td>\njson<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

For Bot Function File ID<\/span><\/span><\/h3>\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
file<\/span><\/td>\nUpload the Bot function file<\/span><\/td>\n<\/tr>\n
fileContext<\/td>\nbulkImport<\/td>\n<\/tr>\n
fileExtension<\/td>\njs<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

For Bot icon File ID<\/span><\/span><\/h3>\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
file<\/span><\/td>\nUpload the Bot icon<\/span><\/td>\n<\/tr>\n
fileContext<\/td>\nbulkImport<\/td>\n<\/tr>\n
fileExtension<\/td>\njson<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

For ML Utterances File ID<\/span><\/span><\/h3>\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
file<\/span><\/td>\nUpload the ML Utterance file (.json or CSV)<\/span><\/td>\n<\/tr>\n
fileContext<\/td>\nbulkImport<\/td>\n<\/tr>\n
fileExtension<\/td>\njson or csv<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h2>\n

Invoke the API with JWT in the header with the following syntax:<\/p>\n

auth: {JWT}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response content type<\/span><\/h2>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h2>\n
curl -X POST \\\r\n  https:\/\/{{host}}\/api\/public\/uploadfile \\\r\n  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \\\r\n  -H 'content-type: multipart\/form-data' \\\r\n  -F file=@botDefinition.json \\\r\n  -F fileContext=bulkImport \\\r\n  -F fileExtension=json<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h2>\n
{\r\n    \"fileId\": \"5c077d28d28e06c112681656\",\r\n    \"hash\": \"c275df72765efb7de332e7d54300cb12de66b78e\"\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":"Used to Upload the botdefinition, botconfig, and botfunction file (if any) as well as the bot icon to the local server and get the file ID to be used in Import Bot API. You need to upload the files separately. POST https:\/\/{{host}}\/api\/public\/uploadfile Query Parameters Parameter Description host Environment URL, for example, https:\/\/bots.kore.ai Body Parameters The...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-18088","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18088","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=18088"}],"version-history":[{"count":9,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18088\/revisions"}],"predecessor-version":[{"id":26894,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18088\/revisions\/26894"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18088"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18088"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18088"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}