View as Markdown
Sharepoint icon

Sharepoint ACTION

Download File

Download a Microsoft Sharepoint file to the /tmp directory. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Sharepoint 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: "sharepoint-download-file",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sharepoint: { authProvisionId: "apn_xxxxxxx" },
    siteId: "Site",
    driveId: "Drive ID",
  },
})

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
siteId Site string
Identifier of a site. This is either the composite ID (e.g. contoso.sharepoint.com,<guid>,<guid> or a server-relative path in the form {hostname}:/{server-relative-path} (e.g. contoso.sharepoint.com:/sites/site-name)
Required Dynamic
driveId Drive ID string
Identifier of a drive within a site
Required Dynamic
fileId File ID string
The file to download. You can either search for the file here or provide a custom File ID.
Required Dynamic
filename Filename string
The filename to save the downloaded file as in the /tmp directory
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
sharepoint-download-file
Version
0.0.18
App
Sharepoint
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes