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

Overview

This node integrates with a PDF generation and management API, enabling users to perform various PDF-related operations such as creating workspaces, managing templates, converting HTML or URLs to PDFs, generating documents from templates, and processing existing PDFs (e.g., watermarking, encryption).

Specifically for the Workspace - Create operation, the node allows you to create a new workspace by providing a unique identifier. Workspaces help organize templates and users within the PDF generation platform.

Common scenarios:

  • Organizing multiple PDF templates and users under distinct workspaces for better management.
  • Automating workspace creation as part of onboarding workflows.
  • Structuring PDF generation projects by segregating resources into different workspaces.

Practical example:

  • You want to programmatically create a new workspace named "marketing.team@company.com" to separate marketing-related PDF templates and users from other departments.

Properties

Name Meaning
Identifier A unique identifier for the new workspace. This is required to create the workspace.

Output

The output JSON object for the workspace creation operation typically contains the response from the API confirming the creation status. It may include fields such as:

  • success: Boolean indicating if the workspace was created successfully.
  • Other metadata returned by the API about the newly created workspace (not explicitly detailed in the code).

No binary data output is involved in this operation.

Example output JSON snippet:

{
  "success": true,
  "identifier": "marketing.team@company.com",
  "message": "Workspace created successfully"
}

(Note: The exact structure depends on the API response.)

Dependencies

  • Requires an API key credential for authenticating requests to the PDF Generator API service.
  • The node uses the base URL from the configured credentials or defaults to https://us1.pdfgeneratorapi.com/api/v4.
  • No additional environment variables are needed beyond the API authentication setup.

Troubleshooting

  • Error: "The operation 'create' is not supported for resource 'workspace'"
    This indicates a misconfiguration or unsupported operation/resource combination. Ensure that the resource is set to "Workspace" and the operation to "Create".

  • Error related to missing or invalid Identifier
    The "Identifier" property is mandatory. Make sure it is provided and unique.

  • API Authentication Errors
    If the API key credential is missing or invalid, requests will fail. Verify the API key configuration in n8n credentials.

  • Network or API Endpoint Issues
    If the API base URL is unreachable or incorrect, the node will throw request errors. Confirm network connectivity and credential settings.

Links and References


This summary focuses exclusively on the Workspace resource's Create operation as requested, based on static analysis of the provided source code and input properties.

Discussion