- Category: documents
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 18
- Triggers: 0
- Slug:
PDFMONKEY - Version: 20261101_00
Tools
Create Document
Create Document
Slug:
PDFMONKEY_CREATE_DOCUMENTTool to create a Document. Use when you need to instantiate a PDF from a template; set status=‘pending’ to queue immediate generation. Ensure valid document_template_id is provided.Input Parameters
Document creation parameters wrapper. Must include
document_template_id (non-deleted template UUID) and payload: a flat JSON object whose keys exactly match the template’s field names — nested objects or mismatched keys silently produce blank or misfilled fields. Also accepts status='pending' to queue immediate generation.Output
Create Document Sync
Create Document Sync
Slug:
PDFMONKEY_CREATE_DOCUMENT_SYNCCreates a document using the synchronous generation endpoint and returns a DocumentCard. Set status to ‘pending’ to start generation; the endpoint waits for completion.Input Parameters
Container for document attributes Required sub-fields:
document_template_id (must reference a valid, non-deleted template) and payload (flat JSON object whose keys exactly match template field names — nested objects or key typos silently produce blank or misfilled fields). Some nominally optional sub-fields like pdf_engine_draft_id may be required at runtime; check API error messages to identify missing inputs.Output
Create Template
Create Template
Slug:
PDFMONKEY_CREATE_TEMPLATECreate a reusable PDFMonkey document template with HTML/Liquid content and CSS styles for generating documents. Draft content and settings can be used to preview changes before publishing.Input Parameters
Document auto-deletion time-to-live in seconds. Options: 300 (5min), 1200 (20min), 3600 (1hr), 86400 (1 day), 604800 (1 week), 2592000 (30 days), 31536000 (1 year), 0 (never). Defaults based on plan.
Published HTML + Liquid template body used when generating documents. Leave empty and use body_draft for testing first.
Template editing mode: ‘code’ for HTML/Liquid editing, ‘visual’ for drag-and-drop editor. Defaults to ‘code’.
UUID of the PDF engine to use for document generation. Get available engines via List PDF Engines action.
UUID of the PDF engine to use for previewing. If omitted, uses pdf_engine_id or default engine. Omitting may cause a 422 validation error (‘Pdf engine draft must exist’); provide a valid UUID if creation fails.
Output
Delete Document
Delete Document
Delete PDFMonkey Document Template
Delete PDFMonkey Document Template
Download Document File
Download Document File
Slug:
PDFMONKEY_DOWNLOAD_DOCUMENT_FILETool to download a generated PDF file via a presigned URL. Use after obtaining a valid download_url from the Document details endpoint. Verify document status is ‘success’ (not ‘draft’ or ‘pending’) via PDFMONKEY_GET_DOCUMENT before downloading to avoid incomplete files. The URL expires after 1 hour; fetch a new URL upon expiry (403 Forbidden).Input Parameters
Time-limited presigned URL returned by the Documents API. Valid for 1 hour; if expired, retrieve a new URL via the Document details endpoint.
Output
Get Current User
Get Current User
Get Document
Get Document
Slug:
PDFMONKEY_GET_DOCUMENTTool to fetch a Document by its ID. Returns the full document record including payload, meta, logs, and download URL. Note: download_url is time-limited; if a download attempt fails, call GetDocument again to obtain a fresh URL. Check the status field for a finalized (non-draft) state before passing the record to downstream processing tools.Input Parameters
Output
Get DocumentCard
Get DocumentCard
Get Template by ID
Get Template by ID
List DocumentCards
List DocumentCards
List PDF Engines
List PDF Engines
Slug:
PDFMONKEY_LIST_PDF_ENGINESLists all available PDF rendering engines in PDFMonkey. Returns engine IDs, version names, numeric versions, and deprecation status. Use this to select a PDF engine when creating templates or generating documents. Recommended: Use the latest non-deprecated engine (e.g., v5 or highest version).Output
List Template Cards
List Template Cards
Slug:
PDFMONKEY_LIST_TEMPLATESList all document template cards for a workspace. Use this action to: - Retrieve all templates available in a workspace - Filter templates by folder (or get only root folder templates with folders=‘none’) - Paginate through large template lists - Sort templates by identifier, creation date, or last update date Returns template cards with metadata including IDs, names, auth tokens, and timestamps.Input Parameters
Attribute by which to sort results. Options: ‘identifier’, ‘created_at’, ‘updated_at’. If not specified, defaults to API default sorting.
Comma-separated folder IDs to filter templates; use ‘none’ to list only those in the root folder. If not provided, returns templates from all folders.
The workspace ID (UUID) to list templates from. Required to scope the query to a specific workspace. An incorrect UUID returns an empty list rather than an error, so verify the workspace_id before concluding no templates exist.
Output
List Workspaces
List Workspaces
Preview Template
Preview Template
Slug:
PDFMONKEY_PREVIEW_TEMPLATEFetches the template preview viewer page from PDFMonkey’s preview_url. Returns an HTML viewer page that displays the rendered template draft. Use this after obtaining a template’s preview_url via Get Template or List Templates.Input Parameters
The preview_url from a Template object (obtained via Get Template or List Templates). This URL points to PDFMonkey’s PDF viewer page that displays the rendered template draft. Example format: https://preview.pdfmonkey.io/pdf/web/viewer.html?file=…
Output
Update Document
Update Document
Slug:
PDFMONKEY_UPDATE_DOCUMENTUpdates an existing PDFMonkey document’s payload, metadata, template, or status. Common use cases: - Modify document data (payload) before generation - Change the template used for the document - Add or update custom metadata - Trigger PDF regeneration by setting status to ‘pending’ Note: To regenerate a document with updated data, update the payload and set status=‘pending’.Input Parameters
Output
Update Document Template
Update Document Template