View as Markdown
Box icon

Box ACTION

Download File

Downloads a file from Box to your workflow's /tmp directory and returns the saved file path. Use Get File Metadata to check the file's name and size first, or Get File Text to extract text content without downloading. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Box account once, then configure and run Download File from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "box-download-file",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    box: { authProvisionId: "apn_xxxxxxx" },
    folderId: "Folder",
    fileId: "File",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Download File inputs
Property Type Description
folderId Folder string
The folder containing the file to download. Use 0 for the root folder. Use the List Folders action to retrieve folder IDs.
Required Dynamic
fileId File string
The file to download
Required Dynamic
fileName File Name string
The name to save the downloaded file as in /tmp (e.g. report.pdf)
Required
syncDir SyncDir dir
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
box-download-file
Version
0.0.12
App
Box
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes