> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# PDFMonkey

> PDFMonkey is a service that automates the generation of PDF documents from templates, allowing users to create professional PDFs programmatically.

![PDFMonkey logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/pdfmonkey.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=cf79749d46595f670c683ecf6e2fd325)

* **Category:** documents
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 18
* **Triggers:** 0
* **Slug:** `PDFMONKEY`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Document
>
> **Slug:** `PDFMONKEY_CREATE_DOCUMENT`
>
> Tool 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** `object` *required*
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Document Sync
>
> **Slug:** `PDFMONKEY_CREATE_DOCUMENT_SYNC`
>
> Creates 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
>
> **document** `object` *required*
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Template
>
> **Slug:** `PDFMONKEY_CREATE_TEMPLATE`
>
> Create 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
>
> **ttl** `integer ("300" | "1200" | "3600" | "86400" | "604800" | "2592000" | "31536000" | "0")`
>
> 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.
>
> **body** `string`
>
> Published HTML + Liquid template body used when generating documents. Leave empty and use body\_draft for testing first.
>
> **app\_id** `string`
>
> Workspace (application) UUID. If omitted, the default workspace is used.
>
> **settings** `object`
>
> Document printing settings for PDF generation or preview.
>
> **body\_draft** `string`
>
> Draft HTML + Liquid template body for previewing changes before publishing.
>
> **identifier** `string` *required*
>
> Human-readable name for the template (e.g., 'Invoice Template', 'Contract PDF')
>
> **scss\_style** `string`
>
> Published CSS/SCSS stylesheet for document styling.
>
> **sample\_data** `string`
>
> JSON string of sample data for the published template.
>
> **edition\_mode** `string ("code" | "visual")`
>
> Template editing mode: 'code' for HTML/Liquid editing, 'visual' for drag-and-drop editor. Defaults to 'code'.
>
> **pdf\_engine\_id** `string`
>
> UUID of the PDF engine to use for document generation. Get available engines via List PDF Engines action.
>
> **settings\_draft** `object`
>
> Document printing settings for PDF generation or preview.
>
> **scss\_style\_draft** `string`
>
> Draft CSS/SCSS stylesheet for previewing style changes.
>
> **sample\_data\_draft** `string`
>
> JSON string of sample data for testing/previewing the draft template.
>
> **pdf\_engine\_draft\_id** `string`
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Document
>
> **Slug:** `PDFMONKEY_DELETE_DOCUMENT`
>
> Permanently deletes a document and its generated file by ID. On success, returns the document ID, a deleted flag, and the HTTP status code.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> UUID of the document to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete PDFMonkey Document Template
>
> **Slug:** `PDFMONKEY_DELETE_TEMPLATE`
>
> Permanently deletes a document template by ID. Documents linked to the template lose their template reference.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The UUID of the document template to delete. Can be obtained from LIST\_TEMPLATES or CREATE\_TEMPLATE actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Document File
>
> **Slug:** `PDFMONKEY_DOWNLOAD_DOCUMENT_FILE`
>
> Tool 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
>
> **download\_url** `string` *required*
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current User
>
> **Slug:** `PDFMONKEY_GET_CURRENT_USER`
>
> Tool to retrieve details about the currently authenticated user. Use when you need account info (quota, plan, email, locale) after authentication.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Document
>
> **Slug:** `PDFMONKEY_GET_DOCUMENT`
>
> Tool 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
>
> **id** `string` *required*
>
> UUID of the document to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get DocumentCard
>
> **Slug:** `PDFMONKEY_GET_DOCUMENT_CARD`
>
> Tool to fetch a DocumentCard by ID. Use when you have a DocumentCard ID and need its download URLs, status, and metadata. Use after generating or updating a DocumentCard.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> UUID of the DocumentCard to fetch
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Template by ID
>
> **Slug:** `PDFMONKEY_GET_TEMPLATE`
>
> Tool to fetch a Document Template by ID. Use when you need the template's content, styles, settings, and preview URL.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> UUID of the document template to retrieve. Get template IDs from the list\_templates action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List DocumentCards
>
> **Slug:** `PDFMONKEY_LIST_DOCUMENT_CARDS`
>
> Tool to list DocumentCards. Use when you need to retrieve multiple DocumentCards with optional pagination and filtering by template, status, workspace, or update time.
>
> #### Input Parameters
>
> **status** `string ("success" | "failure" | "draft")`
>
> Filter by document status
>
> **page\_number** `integer`
>
> Page number to return (default 1)
>
> **workspace\_id** `string`
>
> Filter by workspace UUID
>
> **updated\_since** `integer`
>
> Return documents updated after given Unix timestamp
>
> **document\_template\_ids** `array`
>
> Filter by one or more document template UUIDs
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List PDF Engines
>
> **Slug:** `PDFMONKEY_LIST_PDF_ENGINES`
>
> Lists 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Template Cards
>
> **Slug:** `PDFMONKEY_LIST_TEMPLATES`
>
> List 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
>
> **page** `integer`
>
> Page number to return (1-indexed). Defaults to 1 if not specified.
>
> **sort** `string ("identifier" | "created_at" | "updated_at")`
>
> Attribute by which to sort results. Options: 'identifier', 'created\_at', 'updated\_at'. If not specified, defaults to API default sorting.
>
> **folders** `string`
>
> 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.
>
> **workspace\_id** `string` *required*
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workspaces
>
> **Slug:** `PDFMONKEY_LIST_WORKSPACES`
>
> Discover PDFMonkey workspaces (applications) available to the authenticated user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Preview Template
>
> **Slug:** `PDFMONKEY_PREVIEW_TEMPLATE`
>
> Fetches 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
>
> **preview\_url** `string` *required*
>
> 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=](https://preview.pdfmonkey.io/pdf/web/viewer.html?file=)...
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Document
>
> **Slug:** `PDFMONKEY_UPDATE_DOCUMENT`
>
> Updates 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
>
> **id** `string` *required*
>
> UUID of the document to update. Must be a valid existing document ID.
>
> **document** `object` *required*
>
> Object containing the fields to update. Include only the fields you want to change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Document Template
>
> **Slug:** `PDFMONKEY_UPDATE_TEMPLATE`
>
> Tool to update a document template’s properties. Use when you need to modify an existing template’s content, styles, settings, engine, folder, or TTL.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> UUID of the document template to update
>
> **ttl** `integer`
>
> Auto-deletion TTL for generated documents (seconds), e.g., 300, 1200, 3600, etc.
>
> **body** `string`
>
> Published HTML+Liquid body used to generate documents
>
> **settings** `object`
>
> Settings input for updating templates - all fields optional.
>
> **body\_draft** `string`
>
> Draft HTML+Liquid body used for preview
>
> **identifier** `string`
>
> Human-readable name of the template (optional, only if you want to rename)
>
> **scss\_style** `string`
>
> Published (S)CSS used to generate documents
>
> **sample\_data** `string`
>
> Sample data for reverting changes
>
> **edition\_mode** `string ("code" | "visual")`
>
> Edition mode of the template: 'code' or 'visual'
>
> **pdf\_engine\_id** `string`
>
> PDF engine UUID used to generate documents
>
> **settings\_draft** `object`
>
> Settings input for updating templates - all fields optional.
>
> **scss\_style\_draft** `string`
>
> Draft (S)CSS used for preview
>
> **sample\_data\_draft** `string`
>
> Draft sample data for preview
>
> **template\_folder\_id** `string`
>
> Template folder UUID to organize the template, or null to place in root
>
> **pdf\_engine\_draft\_id** `string`
>
> PDF engine UUID used to preview changes
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] View Public Share Link
>
> **Slug:** `PDFMONKEY_VIEW_PUBLIC_SHARE_LINK`
>
> Check access to a PDFMonkey public share link or supplied direct download URL and return the resolved URL for client-side downloading.
>
> #### Input Parameters
>
> **token** `string` *required*
>
> Public share token from the document's public\_share\_link property.
>
> **filename** `string` *required*
>
> Filename of the PDF to retrieve, including .pdf extension.
>
> **public\_share\_url** `string`
>
> Optional full URL to download the PDF (e.g., a time-limited download\_url from a DocumentCard). When provided, this URL is used directly instead of constructing the /share/:token/:filename path.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
