PDF Generator API icon

PDF Generator API

Generate PDFs, manage templates, convert HTML/URLs to PDF, and perform PDF operations like watermarking, encryption, and optimization

Actions21

Template → Validate

AI-generated

Overview

This node validates a PDF template configuration JSON object by sending it to the PDF Generator API's template validation endpoint. It is useful for ensuring that the template configuration is correctly structured and meets the API's requirements before using it to generate PDF documents. For example, users can validate a newly created or updated template configuration to catch errors early and avoid generation failures.

Use Case Examples

  1. Validate a template configuration JSON to ensure it includes required fields like name, layout, pages array, dataSettings, and editor objects before generating PDFs.
  2. Check the validity of a template configuration JSON after editing it in an external editor or programmatically modifying it.

Properties

Name Meaning
Template Configuration JSON The JSON object representing the template configuration to validate. It must include the template's name, layout, pages array, dataSettings, and editor objects.

Output

JSON

  • success - Indicates if the validation was successful
  • message - Validation message or error details returned from the API

Dependencies

  • An API key credential for the PDF Generator API is required to authenticate requests.

Troubleshooting

  • Ensure the template configuration JSON is valid JSON and includes all required fields: name, layout, pages array, dataSettings, and editor objects.
  • If the API returns an error, check the error message for details on what part of the template configuration is invalid.
  • Make sure the API credentials are correctly configured and have the necessary permissions to perform template validation.

Links

Discussion