get_template
Get Template
Retrieve the full details of a template including its HTML body, SCSS styles, sample data, page layout settings, and draft/published versions.
get_template
Retrieve the full details of a template including its HTML body, SCSS styles, sample data, page layout settings, and draft/published versions.
update_template
Update an existing document template's HTML body, styles, sample data, or page layout settings. Supports updating both draft and published versions independently. Only provided fields will be updated.
get_account_info
Retrieve information about the authenticated PDFMonkey account, including available document quota, current plan, and user details. Useful for checking remaining quota before generation.
delete_template
Permanently delete a document template. This removes the template and all its versions from PDFMonkey. Existing documents generated from this template are not affected.
list_documents
List generated documents with optional filters by template, status, or update time. Returns paginated results (24 per page) with lightweight document cards.
delete_document
Permanently delete a generated document. This removes the document and its generated file from PDFMonkey.
list_templates
List available document templates in a workspace. Returns paginated template cards that can be filtered by folder and sorted.
generate_document
Generate a PDF or image document from a template with dynamic data. Supports both **synchronous** (waits for completion) and **asynchronous** (returns immediately, generation happens in the background) modes. Use synchronous mode when you need the download URL immediately; use asynchronous mode for large documents or batch processing. Optionally set a custom filename via the `filename` field, password-protect the PDF via the `password` field, attach arbitrary document metadata via `meta`, or return a generated file attachment when using synchronous mode. For image generation, use `imageType`, `imageWidth`, `imageHeight`, and `imageQuality` fields.
create_template
Create a new document template with an HTML body, SCSS styles, sample data, and page layout settings. Templates define the structure and appearance of generated documents.
get_document
Retrieve details of a specific document including its status, download URL, preview URL, and generation logs. Use this to check the status of an async generation, get a fresh download URL (they expire after 1 hour), or inspect generation errors.
download_document
Download a successfully generated PDFMonkey PDF or image and return the file bytes as a Slate attachment. Structured output only contains file metadata.
list_engines
List PDFMonkey PDF engines available for template creation or updates. Use this before setting pdfEngineId or pdfEngineDraftId on templates.
update_document
Update a PDFMonkey document's template, payload, or metadata. Set status to "pending" to queue or re-queue generation after changing the payload or metadata.
Generate PDF documents and images from HTML/CSS templates populated with dynamic JSON data. Create, update, and delete templates with configurable page layouts, output types, PDF engines, folders, and automatic deletion TTL. Generate documents synchronously or asynchronously, update document payloads or metadata, retrieve fresh download and public share links, and download generated files as Slate attachments. Supports webhooks for document generation events and provides account quota information.
Common questions about connecting Pdfmonkey to AI agents with Metorial.