Generate Document - Template Processor API

PDF4me Generate Document (Single) is a powerful enterprise-grade solution that dynamically generates a single document from templates using advanced API integration. This comprehensive document generation service efficiently processes Word, HTML, or PDF templates with mustache syntax or merge fields, integrating data from JSON or XML sources for enhanced document automation and processing workflows. The API processes document generation by receiving template files and data sources through REST API calls, utilizing advanced template processing technology and intelligent data mapping algorithms for accurate document creation and professional output generation. With comprehensive support for multiple template formats, flexible data sources, single document processing capabilities, and professional document generation, this solution is ideal for document automation, template processing, single document creation, and enterprise document workflows that require reliable document generation with guaranteed accuracy and consistent output quality. Learn how to generate documents dynamically using PDF4me API for advanced document processing and automation.

Authenticating Your API Request

To access the PDF4me REST API, every request must include proper authentication credentials. Authentication ensures secure communication and validates your identity as an authorized user of the REST API.

Get your api Key

Key Features

• Single Document Generation: Generate individual documents from templates with data integration
• Template Flexibility: Support for Word, HTML, and PDF templates with mustache syntax and merge fields
• Data Source Integration: Process data from JSON and XML sources for template population
• Professional Results: High-quality document generation with accurate data integration and formatting
• Seamless API Integration: RESTful API designed for automated document generation workflows and enterprise system integration
• Advanced Template Processing: Intelligent template processing with dynamic content insertion
• Flexible Output Formats: Support for PDF, Word, Excel, and HTML output formats

REST API Endpoint

The PDF4me REST API uses standard HTTP methods to interact with resources. All single document generation operations are performed through a single endpoint:

• Method: POST
• Endpoint: /api/v2/GenerateDocument

Supported Document Generation Features

The API provides comprehensive support for various document generation and template processing capabilities:

Template Processing

• Multi-format Templates: Support for Word, HTML, and PDF templates with advanced processing
• Mustache Syntax: Advanced template syntax for dynamic content insertion and data binding
• Merge Fields: Intelligent merge field processing for seamless data integration
• Professional Results: High-quality template processing with accurate content generation
• Advanced Processing: Support for complex template structures and dynamic content

Data Integration

• JSON/XML Data Sources: Support for JSON and XML data format processing
• Data Mapping: Intelligent data mapping and field binding for accurate content insertion
• Single Document Processing: Efficient processing for individual document generation
• Professional Integration: High-quality data integration with template processing
• Flexible Data Formats: Support for various data structures and formats

Advanced Features

• Single Document Generation: Generate individual documents from template with data integration
• Template Management: Advanced template processing with dynamic content generation
• Professional Output: High-quality document generation with consistent formatting
• Flexible Options: Customizable processing parameters for specific requirements

REST API Parameters

Complete list of parameters for the Generate Document (Single) REST API. Parameters are organized by category for better understanding and implementation.

Important: Parameters marked with an asterisk (*) are required and must be provided for the API to function correctly.

Required Parameters

Parameter	Type	Description	Example
Template File Type*	Enum	Select the template file format for document generation operations. Choose Word for Word templates, HTML for HTML templates, or PDF for PDF templates. This parameter determines the template processing engine and ensures proper document generation with accurate formatting and content integration.	DOCX
Template File Name*	String	The template document filename with proper file extension for document generation operations. This parameter identifies the input template document for document generation, template processing, and single document creation workflows. Required for template identification and processing pipeline management in document generation operations.	template.docx
Template File Data*	Base64	The complete content of the template document encoded in Base64 format for document generation and template processing operations. This parameter contains the entire template file data required for document generation, data integration, and single document processing workflows. Essential for secure document processing and API-based document generation operations.	JVBERi...
Document Data Type*	Enum	Specify the data format type for template data integration operations. Choose JSON for JSON data format or XML for XML data format. This parameter determines the data parsing engine and ensures proper data integration with template processing for accurate document generation.	JSON
Document Data File*	Base64	The complete content of the data file encoded in Base64 format for template data integration operations. This parameter contains the structured data required for document generation, field mapping, and single document processing workflows. Essential for data-driven document generation and template content population.	JVBERi...
Output Type*	Enum	Select the output document format for generated documents. Choose from PDF, Word, Excel, or HTML formats. This parameter controls the output format of generated documents, ensuring compatibility with various document processing workflows and downstream applications.	DOCX
Meta Data Json*	String	Metadata information for document generation operations in JSON format. This parameter provides processing metadata, document properties, and contextual information for enhanced document management and tracking. Supports custom metadata for document classification, processing history, and workflow management.	{"version":"1.0","author":"PDF4me"}

Optional Parameters

Parameter	Type	Description	Example
Document Data Text	String	Manual data input for template processing when data file is not provided. This parameter allows direct data entry in JSON or XML format for document generation operations. Use this parameter when you need to provide data directly without uploading a separate data file, enabling flexible data input for template processing workflows.	{"name":"John","email":"[email protected]"}
File Meta Data	String	Additional metadata information for document generation operations in JSON format. This parameter provides supplementary processing metadata, document properties, and contextual information for enhanced document management and tracking. Supports custom metadata for document classification, processing history, and workflow management.	{"version":"1.0","author":"PDF4me"}

Output

The PDF4me Generate Document (Single) REST API returns a response that can be viewed in multiple formats. Choose the view that best fits your needs:

JSON

JSON Response Format

The raw JSON response from the API:

{
  "File Content": "The Output file from the Generate Document action"
}

Table

Table View

Response data in a structured table format:

Parameter	Value
File Content	The Output file from the Generate Document action

Schema

Schema View

The data structure and types of the response:

1 item
File Content: Binary The Output file from the Generate Document action

Type Indicators:

• Binary = Binary data

Binary

Binary Data View

The actual generated document file and metadata:

data
─────────────────────────────
File Content: The Output file from the Generate Document action

Binary Data Access:

• Generated Document: Ready for download or further processing
• Single Output: Complete generated document with data integration

Request Example

Header

Content-Type: application/json
Authorization:  YOUR_API_KEY

Note: Get your API key from the PDF4me Dashboard

Payload

{
  "templateFileType": "DOCX",
  "templateFileName": "template.docx",
  "templateFileData": "JVBERi...",
  "documentDataType": "JSON",
  "outputType": "PDF",
  "documentDataFile": "JVBERi...",
  "documentDataText": "{\"name\":\"John\",\"email\":\"[email protected]\"}",
  "metaDataJson": "{\"version\":\"1.0\",\"author\":\"PDF4me\"}"
}

Code Samples

The PDF4me Generate Document (Single) REST API provides code samples in multiple programming languages. Choose the language that best fits your development environment:

C#

C# (CSharp) Sample

Complete C# implementation for generating a single document:

View C# Sample

Java

Java Sample

Java implementation with full error handling and response processing:

View Java Sample

JavaScript

JavaScript Sample

Node.js and browser-compatible JavaScript implementation:

View JavaScript Sample

Python

Python Sample

Python implementation with requests library and JSON handling:

View Python Sample

Salesforce

Salesforce Sample

Salesforce Apex implementation for CRM integration:

View Salesforce Sample

n8n

n8n Sample

n8n workflow implementation for automation:

View n8n Sample

Google Script

Google Script Sample

Google Apps Script implementation for Google Workspace integration:

View Google Script Sample

AWS Lambda

AWS Lambda Sample

Serverless AWS Lambda function implementation:

View AWS Lambda Sample

Document Generation Features

Template Processing

• Multi-format Templates: Support for Word, HTML, and PDF templates with advanced processing
• Mustache Syntax: Advanced template syntax for dynamic content insertion and data binding
• Merge Fields: Intelligent merge field processing for seamless data integration
• Professional Results: High-quality template processing with accurate content generation
• Advanced Processing: Support for complex template structures and dynamic content

Data Integration

• JSON/XML Data Sources: Support for JSON and XML data format processing
• Data Mapping: Intelligent data mapping and field binding for accurate content insertion
• Single Document Processing: Efficient processing for individual document generation
• Professional Integration: High-quality data integration with template processing
• Flexible Data Formats: Support for various data structures and formats

Advanced Features

• Single Document Generation: Generate individual documents from template with data integration
• Template Management: Advanced template processing with dynamic content generation
• Professional Output: High-quality document generation with consistent formatting
• Flexible Options: Customizable processing parameters for specific requirements

Industry Use Cases & Applications

Use Cases

Use Cases

• Document Automation: Automatically generate individual documents from templates with data integration
• Single Document Processing: Process individual documents with template-based generation
• Report Generation: Create single reports from template with data integration
• Invoice Generation: Generate individual invoices from template with customer data
• Contract Creation: Create single contracts from template with client information
• Certificate Generation: Generate individual certificates from template with recipient data
• Label Creation: Create single labels from template with product information
• Business Process Automation: Automate single document generation workflows for enterprise operations

Get Help

Get Your API KeyAPI SamplesGetting Started