View as Markdown
pdforge icon

pdforge ACTION

Generate PDF from Template

Generate a document from a selected template. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's pdforge account once, then configure and run Generate PDF from Template 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: "pdforge-generate-pdf-from-template",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pdforge: { authProvisionId: "apn_xxxxxxx" },
    convertToImage: true,
    asyncMode: true,
  },
})

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.

Generate PDF from Template inputs
Property Type Description
convertToImage Convert to Image boolean
If true, will return a .PNG file instead of a .PDF file
Required
asyncMode Async Mode boolean
If true, the request will be executed in the background and the response will be sent to the webhook URL.
Required
saveS3 Save to S3 boolean
If true, the generated file will be saved to the provided s3 bucket; if false, the generated file will be saved to the Pipedream /tmp directory.
Required
s3bucket S3 Bucket string
The ID of the active S3 connection to store the generated file on
Required
s3key S3 Key string
The path and filename without extension for saving the file in the S3 bucket
Required
fileName File Name string
The filename without extension for saving the file in the /tmp direcrtory
Required
webhook Webhook URL string
The URL of your webhook endpoint
Required
templateId Template ID string
The ID of the template from which to generate the document
Required
data Data object
The object containing the variables for your PDF template
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
pdforge-generate-pdf-from-template
Version
0.0.2
App
pdforge
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes