View as Markdown
ConvertAPI icon

ConvertAPI ACTION

Convert File

Use this action to convert files to the chosen format. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ConvertAPI account once, then configure and run Convert 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: "convertapi-convert-file",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    convertapi: { authProvisionId: "apn_xxxxxxx" },
    file: "File Path Or Url",
    formatFrom: "Input Format",
  },
})

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.

Convert File inputs
Property Type Description
file File Path Or Url string
Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/file.docx).
Required
formatFrom Input Format string
The format of the input file.
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
convertapi-convert-file
Version
1.0.3
App
ConvertAPI
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes