View as Markdown
Microsoft OneDrive icon

Microsoft OneDrive ACTION

Download File

Download a file stored in OneDrive. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Microsoft OneDrive 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: "microsoft_onedrive-download-file",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    microsoft_onedrive: { authProvisionId: "apn_xxxxxxx" },
    fileId: "File ID",
    filePath: "File Path",
  },
})

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
fileId File ID string
The file to download. You can either search for the file here, provide a custom File ID, or use the File Path prop to specify the path directly.
Optional Dynamic
filePath File Path string
The path to the file from the root folder, e.g., Documents/My Subfolder/File 1.docx. You can either provide this, or search for an existing file with the File ID prop.
Optional
newFileName New File Name string
The file name to save the downloaded content as, under the /tmp folder. Make sure to include the file extension.
Required
convertToFormat Convert To Format string
The format to convert the file to. See the Format Options for supported source formats
Optional
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
microsoft_onedrive-download-file
Version
0.0.10
App
Microsoft OneDrive
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes