{"id":18088,"date":"2018-12-04T13:59:13","date_gmt":"2018-12-04T13:59:13","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=15678"},"modified":"2023-08-30T12:03:54","modified_gmt":"2023-08-30T11:03:54","slug":"upload-file-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/upload-file-api\/","title":{"rendered":"Upload File API"},"content":{"rendered":"
<\/div><\/div><\/section>
<\/div><\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t\r\n\t\t<\/div>\r\n\t<\/div>\r\nTo upload the botdefinition<\/i>, botconfig<\/i>, and botfunction<\/i> files (if any) and the bot<\/b> icon to the local server. Additionally, the API fetches the file ID<\/i> to be used in Import Bot API<\/a>.<\/p>\n
<\/div>\n

\n

Note<\/b>: You need to upload the files separately. You can upload a file by signing with any app which is created by the account administrator.<\/div>\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\/uploadfile<\/code><\/span><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\nauth: {{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: Not Applicable<\/li>\n
  • Admin Console: Not Applicable<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

     <\/p>\n

    Query Parameters<\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\nMandate<\/th>\n<\/tr>\n<\/thead>\n
    host<\/span><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/td>\nRequired<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

     <\/p>\n

    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\r\n<\/pre>\n
    Body Parameters<\/span><\/h2>\n
    The following parameters are Required<\/b> and passed based on the file id<\/i>.<\/p>\n
    For Bot Definition File ID<\/span><\/b><\/p>\n\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    file<\/b><\/span><\/td>\nUpload the Botdefinition.json file.<\/td>\n<\/tr>\n
    fileContext<\/b><\/td>\nbulkImport<\/td>\n<\/tr>\n
    fileExtension<\/b><\/td>\n.json<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    For Bot Config File ID<\/span><\/b><\/p>\n\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    file<\/b><\/span><\/td>\nUpload the Botconfig.json file.<\/span><\/td>\n<\/tr>\n
    fileContext<\/b><\/td>\nbulkImport<\/td>\n<\/tr>\n
    fileExtension<\/b><\/td>\n.json<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    For Bot Function File ID<\/span><\/b><\/p>\n\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    file<\/b><\/span><\/td>\nUpload the Bot function file.<\/span><\/td>\n<\/tr>\n
    fileContext<\/b><\/td>\nbulkImport<\/td>\n<\/tr>\n
    fileExtension<\/b><\/td>\n.js<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    For Bot icon File ID<\/span><\/b><\/p>\n\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    file<\/b><\/span><\/td>\nUpload the Bot icon file.<\/span><\/td>\n<\/tr>\n
    fileContext<\/b><\/td>\nbulkImport<\/td>\n<\/tr>\n
    fileExtension<\/b><\/td>\n.json<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    For ML Utterances File ID<\/span><\/b><\/p>\n\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    file<\/b><\/span><\/td>\nUpload the ML Utterance file (.json or .csv)<\/span><\/td>\n<\/tr>\n
    fileContext<\/b><\/td>\nbulkImport<\/td>\n<\/tr>\n
    fileExtension<\/b><\/td>\n.json or .csv<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
     <\/p>\n
    Sample Response<\/span><\/h2>\n
    {\r\n    \"fileId\": \"5c077d28d28e06c112681656\",\r\n    \"hash\": \"c275df72765efb7de332e7d54300cb12de66b78e\",\r\n    \"fileName\": \"f-57a5c8e14erd-21nd-g432-w927cc65r372\"\r\n}<\/pre>\n","protected":false},"excerpt":{"rendered":"
    To upload the botdefinition, botconfig, and botfunction files (if any) and the bot icon to the local server. Additionally, the API fetches the file ID to be used in Import Bot API. Note: You need to upload the files separately. You can upload a file by signing with any app which is created by the…<\/p>\n","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\/v10-1\/wp-json\/wp\/v2\/posts\/18088","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\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=18088"}],"version-history":[{"count":41,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18088\/revisions"}],"predecessor-version":[{"id":58929,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18088\/revisions\/58929"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18088"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18088"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18088"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}