NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
PDFMonkey connects to a Nagent workspace with an API key. Once it is connected, agents can call 18 PDFMonkey actions, such as "Create Document", "Create Document Sync" and "Create Template". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against PDFMonkey, with input parameters and output schema.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_CREATE_DOCUMENT_SYNCTool to create a document and wait for generation to finish. Use when immediate PDF is needed.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_CREATE_TEMPLATECreates a new PDF document template in PDFMonkey. Use this to define reusable templates with HTML/Liquid content and CSS styles for generating PDF documents. Typical workflow: Create template → Preview with draft content → Publish → Generate documents. The template supports Liquid templating syntax (e.g., {{variable_name}}) for dynamic content injection. Only 'identifier' is required; all other fields have sensible defaults.
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.
Workspace (application) UUID. If omitted, the default workspace is used.
Document printing settings for PDF generation or preview.
Draft HTML + Liquid template body for previewing changes before publishing.
Human-readable name for the template (e.g., 'Invoice Template', 'Contract PDF')
Published CSS/SCSS stylesheet for document styling.
JSON string of sample data for the published template.
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.
Document printing settings for PDF generation or preview.
Draft CSS/SCSS stylesheet for previewing style changes.
JSON string of sample data for testing/previewing the draft template.
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_DELETE_DOCUMENTTool to delete a Document by its ID. Use when you need to permanently remove a document after confirming its ID. Returns 204 No Content on success.
Input parameters
UUID of the document to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_DELETE_TEMPLATETool to delete a document template by ID. Use when you need to remove obsolete templates after validation.
Input parameters
The UUID of the document template to delete. Can be obtained from LIST_TEMPLATES or CREATE_TEMPLATE actions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_GET_CURRENT_USERTool to retrieve details about the currently authenticated user. Use when you need account info (quota, plan, email, locale) after authentication.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
UUID of the document to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_GET_DOCUMENT_CARDTool 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
UUID of the DocumentCard to fetch
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_GET_TEMPLATETool to fetch a Document Template by ID. Use when you need the template's content, styles, settings, and preview URL.
Input parameters
UUID of the document template to retrieve. Get template IDs from the list_templates action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_LIST_DOCUMENT_CARDSTool 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
Filter by document status
Page number to return (default 1)
Filter by workspace UUID
Return documents updated after given Unix timestamp
Filter by one or more document template UUIDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page number to return (1-indexed). Defaults to 1 if not specified.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_LIST_WORKSPACESTool to list workspaces (applications). Use when you need all available workspaces for the authenticated user after login.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
UUID of the document to update. Must be a valid existing document ID.
Object containing the fields to update. Include only the fields you want to change.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_UPDATE_TEMPLATETool 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
UUID of the document template to update
Auto-deletion TTL for generated documents (seconds), e.g., 300, 1200, 3600, etc.
Published HTML+Liquid body used to generate documents
Settings input for updating templates - all fields optional.
Draft HTML+Liquid body used for preview
Human-readable name of the template (optional, only if you want to rename)
Published (S)CSS used to generate documents
Sample data for reverting changes
Edition mode of the template: 'code' or 'visual'
PDF engine UUID used to generate documents
Settings input for updating templates - all fields optional.
Draft (S)CSS used for preview
Draft sample data for preview
Template folder UUID to organize the template, or null to place in root
PDF engine UUID used to preview changes
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PDFMONKEY_VIEW_PUBLIC_SHARE_LINKTool to download a publicly shared PDF via its permanent share link. Use when the document's public_share_link is enabled to fetch the PDF file directly.
Input parameters
Public share token from the document's public_share_link property.
Filename of the PDF to retrieve, including .pdf extension.
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 18 PDFMonkey actions on Nagent, including "Create Document", "Create Document Sync" and "Create Template". Create Document: Create a Document. Each action is listed on this page with its input parameters and its output.
PDFMonkey connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Document takes 1 required input: document. It returns data, error and successful.