Box Block
Upload, download, and manage files in Box cloud storage
The Box block integrates Box file storage into your workflows. Use it to upload and download files, list folder contents, create folders, delete files, fetch metadata, and generate shared links — all authenticated through a connected Box account.
Overview
| Property | Value |
|---|---|
| Type | box |
| Category | tools |
| Color | #0061FF |
When to Use
- Upload generated reports or attachments to a Box folder
- Download files from Box for processing by downstream blocks
- List the contents of a Box folder to drive iteration or selection
- Create folders to organize workflow output
- Delete obsolete files as part of cleanup steps
- Fetch file metadata (size, timestamps, parent, SHA1) without downloading the content
- Generate a publicly-accessible shared link for a file to send to collaborators
Configuration
Operation
Dropdown (operation) — required. Selects the action the block will perform. All other fields are shown or hidden based on this value.
| Label | ID |
|---|---|
| Upload File | box_upload_file |
| Download File | box_download_file |
| List Folder | box_list_folder |
| Create Folder | box_create_folder |
| Delete File | box_delete_file |
| Get File Info | box_get_file_info |
| Create Shared Link | box_create_shared_link |
Box Account
OAuth connection (credential, provider box) — required for all operations. Connect your Box account to authorize the block.
File ID (fileId)
Short text input. The numeric ID of the target Box file (e.g. 123456789). Shown when the operation is one of: Download File, Delete File, Get File Info, Create Shared Link.
Folder ID (folderId)
Short text input. The numeric ID of the target Box folder. Enter 0 to target the root folder. Shown when the operation is one of: List Folder, Create Folder, Upload File.
File/Folder Name (fileName)
Short text input. The name for the new file or folder (e.g. report.pdf). Shown when the operation is one of: Upload File, Create Folder.
File (uploadFile)
File-upload input. The file content to upload. Shown only for the Upload File operation.
Inputs & Outputs
Inputs:
operation(string) — Operation to perform (one of the operation IDs listed above)oauthCredential(string) — OAuth credential for Box authenticationfileId(string) — File ID (required for Download File, Delete File, Get File Info, Create Shared Link)folderId(string) — Folder ID (required for List Folder, Create Folder, Upload File)fileName(string) — File or folder name (required for Upload File, Create Folder)uploadFile(file) — File to upload (required for Upload File)
Outputs:
file(json) — File metadata returned by the operationfiles(json) — File list (used for list operations)folder(json) — Folder data returned by folder operations
Tools
Box Upload File (box_upload_file) — Uploads a file to a specified Box folder. Params: folderId (target folder, "0" for root), fileName (optional name override), uploadFile (the file). Returns: id, name, size (bytes), parentId.
Box Download File (box_download_file) — Downloads a file from Box by its ID. Params: fileId. Returns: file (object with name, mimeType, data as base64, size) and content (base64 string of the file).
Box List Folder (box_list_folder) — Lists the items (files and sub-folders) inside a Box folder, up to 100 entries. Params: folderId. Returns: entries (array of objects with type, id, name, size, createdAt, modifiedAt) and totalCount.
Box Create Folder (box_create_folder) — Creates a new sub-folder inside a given Box folder. Params: fileName (the new folder name), folderId (parent folder ID). Returns: id, name, createdAt, parentId.
Box Delete File (box_delete_file) — Permanently deletes a file from Box. Params: fileId. Returns: deleted (boolean) and message (confirmation string).
Box Get File Info (box_get_file_info) — Fetches detailed metadata for a file without downloading its content. Params: fileId. Returns: id, name, size, sha1, createdAt, modifiedAt, parentId, sharedLink.
Box Create Shared Link (box_create_shared_link) — Creates an open-access shared link for a file, making it publicly accessible via URL. Params: fileId. Returns: url, downloadUrl, access.
YAML Example
box_1:
type: box
name: "Box"
inputs:
operation: "box_upload_file"
oauthCredential: "{{BOX_OAUTH_CREDENTIAL}}"
folderId: "0"
fileName: "report.pdf"
uploadFile: "{{generate_report.file}}"
connections:
outgoing:
- target: next-block-id