File Upload

the ability to upload files within a conversation can be very useful for certain chatbot workflows engati provides an upload file node that makes it easy to allow users to send files to the bot for example, customers could attach order receipts, employees might submit expense reports, or patients can send medical records the possibilities are endless! how to use? how to use? to enable users to upload files in the chatbot, follow these steps step 1 in the builder, click "add node" step 2 select the upload file node from data input and fill in the fields prompt message this field specifies the message that is displayed to the user when they are prompted to upload a file prompt description this field specifies the description that is displayed to the user when they are prompted to upload a file response customers using direct upload in the file upload node you can access tag responses and available keys to build the rest of the journey this new response section helps with troubleshooting and debugging , making it easier to understand and fix issues file upload this field gives you options for where to store the uploaded file there are three choices available for you public upload the default storage option saves the uploaded file to engati's cloud storage the file url will be available in the automatically generated attribute {{user fileupload url}} the url generated would be in this format use secure url this option enables you to keep the file private, as indicated by its name, secure url if this option is selected, the file will still be uploaded to engati's cloud but the url generated will be private it requires an authorization token to access the file unlike the default public url, this secure url is not temporary and will continue to grant access if the authorization token is provided this enhances privacy and security for sensitive file uploads once more, this secure url is stored in the system generated attribute {{user fileupload url}} the url generated would be in this format you can generate the authentication token by navigating to the integrations tab > engati apis to retrieve the file, the bot builder needs to make an api call using the authentication token as a header example authorization basic \<api key> here is a sample curl command { "tab" "examples", "url" "", "name" "get cakes", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id of the cake to get" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "vd1yw b5zly5gf 0 ovkc", "code" "", "language" "none", "customlabel" "" } ], "selectedlanguageid" "vd1yw b5zly5gf 0 ovkc" }, "examples" { "languages" \[ { "id" "vgetelsaay72iwc6ulbia", "code" "curl x get \\\\\n‘https //api engati com/bot api/v1 0/customer/10294/file/download?token=02715059001 33f0 4fde aa70 b524ee878bed35843’ \\\\\n h ‘authorization basic 3693431a 7bbf 4f04 bb83 7e0d4afd2a4c en6tmpr’", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "vgetelsaay72iwc6ulbia" }, "description" "get a cake by its id", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } direct upload if the bot builder prefers to store the file directly, they can select the second option, which is direct upload by choosing this option and having the user upload a file, it will be uploaded to the api endpoint configured in the node additionally, the file will be uploaded to our cloud, generating a public url when the checkbox for direct upload is selected, the use secure url option should be automatically enabled, ensuring that it remains checked and cannot be unchecked the format of the generated url will be as follows as you use the direct upload option to upload files, simply complete the fields provided we've provided descriptions for each field to help you understand which value belongs in each one, making the process easier for you in the ‘ upload file type ’ section, select the type of file that the user is uploading, either post or put in the ‘ upload url ’ field, enter the url of the location where the file will be uploaded in the ‘ params ’ section, enter the parameters that will be used to upload the file in the ‘ headers ’ section, enter the headers that will be used to upload the file in the ‘ body ’ section, enter the body of the request that will be used to upload the file in the ‘ authorized domains ’ field, enter the domains that are allowed to upload files response customers using direct upload in the file upload node you can access tag responses and available keys to build the rest of the journey this new response section helps with troubleshooting and debugging , making it easier to understand and fix issues default error message this field specifies the error message that is displayed to the user if the file upload fails enable skip this field specifies whether or not to enable the skip button here's how you can utilize the upload file feature, allowing your users to upload documents tailored to your specific needs if you face any issues or queries please reach out to us at mailto\ support\@engati com