View as Markdown
DocuGenerate icon

DocuGenerate ACTION

New Template

Creates a new document template from a file. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's DocuGenerate account once, then configure and run New 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: "docugenerate-create-template",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    docugenerate: { authProvisionId: "apn_xxxxxxx" },
    filePath: "Template File",
    name: "Name",
  },
})

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.

New Template inputs
Property Type Description
filePath Template File string
Template file (.docx, .doc, .odt, .txt, or .sql). Provide a file URL or a path under /tmp.
Required
name Name string
The template's name. If not provided, it will be initialized with the name of the uploaded template file.
Optional
delimiters Delimiters object

Delimiters used to detect the tags. If not provided, they will be determined automatically.

For example, if the tags defined in the template are [Name], [Address], etc., then the left delimiter is [ and the right delimiter is ], e.g. { "left": "[", "right": "]" }

Optional
region Region string

The physical location where the template and its generated documents are stored.

This value is optional. If omitted, the account's default region will be used.

Optional
enhancedSyntax Enhanced Syntax boolean

Flag to determine if nested properties of objects and logical & mathematical operators can be used for this template. The default value is false.

Enabling this flag makes it possible to use tags like [item.name] in the template, where item is an object containing the name property.

Optional
versioningEnabled Versioning Enabled boolean

Flag to enable template file versioning, preserving previous versions when a new file is uploaded.

The default value is true if the versioning feature is available, otherwise the default value is false.

The template versioning feature is available only with the Premium and Business plans.

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
docugenerate-create-template
Version
0.0.2
App
DocuGenerate
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes