NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Docugenerate connects to a Nagent workspace with an API key. Once it is connected, agents can call 9 Docugenerate actions, such as "Update Document", "Get document by ID" and "Get template by ID". 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 Docugenerate, with input parameters and output schema.
DOCUGENERATE_DELETE_DOCUMENTTool to delete a document by ID. Permanently removes the document from storage. Use when you need to clean up generated documents or remove outdated files from DocuGenerate.
Input parameters
The unique identifier of the document to delete. Obtain this from the document generation response or by listing documents.
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
DOCUGENERATE_DELETE_TEMPLATETool to permanently delete a template by ID. Removes the template and all associated versions from storage. Use when a template is no longer needed.
Input parameters
ID of the template 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
DOCUGENERATE_DOCUMENT_GENERATETool to generate document(s) from a template by merging JSON data or uploading a data file. Use when you need to programmatically produce one or more documents and receive metadata including a download URL.
Input parameters
Merge data as an object (single document) or list of objects for multiple documents
Binary file (CSV/Excel/TSV) for bulk merge when `data` is not provided
Logical document name; supports merge tags when generating a single document
PDF URL(s) or Base64 data URIs to embed as attachments in the PDF
PDF URL(s) or Base64 data URIs to append after generated content. Ignored if invalid or unreachable. Only for PDF/PDF-A formats.
Insert a page break between combined documents when `single_file` is true
Output file name without extension; extension added automatically
Combine multiple documents into one file (true) or return a ZIP (false)
ID of the template to use
Output format; defaults to .docx. PDF/A variants supported
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
DOCUGENERATE_DOCUMENT_UPDATEUpdate a document's name/title in DocuGenerate. Use this to rename an existing document after it has been generated. Requires a valid document ID (obtained from document generation or listing) and the new name. Returns the updated document metadata including the document_uri for downloading.
Input parameters
The unique identifier of the document to update. Obtain this from the document generation response or by listing documents.
The new name/title for the document. This updates the document's display name (not the filename).
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
DOCUGENERATE_GET_DOCUMENTTool to retrieve a specific document by ID. Returns document metadata including name, format, template_id, and download URL. Use when you need to fetch details about an existing generated document.
Input parameters
ID 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
DOCUGENERATE_GET_TEMPLATETool to retrieve a specific template by ID. Returns template metadata including name, format, region, and configuration settings.
Input parameters
ID of the template 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
DOCUGENERATE_LIST_DOCUMENTSTool to list all documents generated from a template. Results are ordered by created time in descending order. Use when you need to retrieve a list of previously generated documents for a specific template.
Input parameters
ID of the template that was used to generate the documents
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
DOCUGENERATE_TEMPLATE_GET_OR_LISTTool to retrieve or list existing templates. Use when needing template IDs and metadata before making updates or generating documents.
Input parameters
Page number to retrieve (starting at 1)
Number of templates per page
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
DOCUGENERATE_TEMPLATE_UPDATETool to update a template’s file and settings. Use after confirming the template ID and desired inputs.
Input parameters
Template identifier to update
The template file to upload (form field 'file')
Optional new name for the template
Processing region for the template (e.g., 'us', 'eu', 'uk', 'au')
Enable version history for the template
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 9 Docugenerate actions on Nagent, including "Update Document", "Get document by ID" and "Get template by ID". Update Document: Update a document's name/title in DocuGenerate. Each action is listed on this page with its input parameters and its output.
Docugenerate 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.
Update Document takes 2 required inputs: id and name. It returns data, error and successful.