Overview
This node integrates with the PDFMonkey API to manage PDF documents. It supports generating new PDFs from templates, retrieving document details and status, downloading generated files, and deleting documents.
Common scenarios include:
- Automating PDF report generation based on dynamic data.
- Checking the status of a PDF generation job.
- Downloading completed PDFs for further processing or storage.
- Cleaning up old or unwanted PDF documents.
For example, you can use this node to generate an invoice PDF from a template by providing customer data, then wait for the PDF to be ready, download it automatically, or retrieve its status later.
Properties
| Name | Meaning |
|---|---|
| Document ID | The ID of the generated document. Used to get details, download, or delete a specific PDF. |
(Note: For the "Get Document" operation, only the "Document ID" property is relevant as per the provided input properties.)
Output
The node outputs JSON data containing information about the requested document or operation result:
- For Get Document operation, the output JSON includes the full document details and its current status as returned by the PDFMonkey API.
Example structure (simplified):
{
"document": {
"id": "string",
"status": "string",
"other_metadata": "..."
}
}
- No binary data is output for the "Get Document" operation.
Dependencies
- Requires an API key credential for authenticating with the PDFMonkey API.
- Makes HTTP requests to
https://api.pdfmonkey.io/api/v1/documents/{documentId}to fetch document details. - Requires proper configuration of the API authentication credential in n8n.
Troubleshooting
Common issues:
- Invalid or missing Document ID will cause the API request to fail.
- Network or authentication errors may prevent fetching document details.
Error messages:
- If the document does not exist or the ID is incorrect, the API will return an error which the node surfaces.
- Authentication failures will result in connection errors; ensure the API key credential is valid and configured correctly.
Resolution tips:
- Verify the Document ID is correct and corresponds to an existing document.
- Check that the API key credential is set up and has necessary permissions.
- Ensure network connectivity to the PDFMonkey API endpoint.