Actions28
- Conversion Actions
- Document Actions
- PDF Service Actions
- Template Actions
- Workspace Actions
Overview
The node integrates with a PDF Generator API to manage PDF templates, generate PDF documents from templates, convert HTML or URLs to PDFs, and perform various PDF operations such as watermarking, encryption, decryption, form field extraction/filling, optimization, and workspace management.
Specifically for the Template - Create operation, this node allows users to create new PDF templates by providing a complete template configuration JSON object. This is useful when you want to programmatically define reusable PDF templates that can later be used to generate customized PDF documents with dynamic data.
Common scenarios:
- Automating the creation of standardized PDF templates for invoices, reports, labels, or certificates.
- Managing templates centrally in an organization’s PDF generation workflow.
- Creating draft templates programmatically before manual editing or publishing.
Example:
You provide a JSON object describing the layout, pages, data settings, and editor options of a new template. The node sends this configuration to the API, which creates the template and returns its details.
Properties
| Name | Meaning |
|---|---|
| Template Configuration JSON | The full JSON object defining the template configuration. Must include keys like name, layout, pages (array), dataSettings, and editor. This JSON describes the entire structure and settings of the PDF template to create. |
The property expects a JSON object directly representing the template configuration, not wrapped inside another object. It should contain all necessary fields to define the template fully.
Output
The output JSON contains the response from the PDF Generator API after creating the template. Typically, it includes details about the newly created template such as its ID, name, status, and other metadata returned by the API.
The node does not produce binary data for this operation; the output is purely JSON describing the created template.
Dependencies
- Requires an API key credential for the PDF Generator API.
- The node uses the base URL from the configured credentials or defaults to
https://us1.pdfgeneratorapi.com/api/v4. - Network access to the PDF Generator API endpoint is required.
Troubleshooting
- Invalid JSON error: If the provided template configuration JSON is malformed or invalid, the node throws an error indicating the JSON must be valid. Ensure the JSON syntax is correct.
- Missing required fields: The template configuration must include mandatory fields (
name,layout,pages,dataSettings,editor). Omitting these will likely cause API errors. - API authentication errors: Ensure the API key credential is correctly set up and has permissions to create templates.
- Network issues: Connectivity problems to the API endpoint will cause request failures.
- Unsupported operation error: If the resource or operation parameters are incorrect or unsupported, the node will throw an error specifying the unsupported operation.
Links and References
- PDF Generator API Documentation (general reference for API endpoints and template configuration)
- n8n Documentation on Custom Nodes (for understanding node development and usage)
This summary focuses on the Template resource's Create operation as requested, based on static analysis of the provided source code and input properties.