BeDrive icon

BeDrive

Consume BeDrive API

Actions9

Download File

AI-generated

Summary

Download a specified file from a selected BeDrive workspace and folder, returning the file's binary data and detailed metadata.

Inputs

  • Workspace (required) — Select the workspace containing the file to download, either from a list of available workspaces or by entering the workspace ID.
  • Folder Path — Optionally select or enter the folder path or ID within the workspace where the file is located; choose "/ (Root)" or leave empty for the root directory.
  • File (required) — Select or enter the ID of the file to download from the specified workspace and folder.
  • Binary Property — Specify the name of the binary property where the downloaded file's binary data will be stored; defaults to 'data'.

Output shape

a single record with JSON metadata and binary data properties

The operation returns a single item per input, merging the original input JSON with metadata about the downloaded file, including extracted file-type-specific metadata. The binary data of the file is saved to the specified binary property name. Errors during download are thrown unless 'Continue on Fail' is enabled.

Examples

Example 1: Download a file by selecting the workspace and folder from lists, then picking a file from that folder. The file's binary content and rich metadata (including file type, size, and extracted info for formats like PDF, image, audio, video, etc.) are returned in binary and JSON properties respectively.

Set 'Workspace' to the target workspace, optionally set 'Folder Path' to browse subfolders or root, choose 'File' from available files, and set 'Binary Property' if a custom property name is desired.

Links

Discussion