Skip to main content
DocuGenerate logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: DOCUGENERATE
  • Version: 20261101_00

Tools

Slug: 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

string
required
The unique identifier of the document to delete. Obtain this from the document generation response or by listing documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the template to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Merge data as an object (single document) or list of objects for multiple documents
object
Binary file (CSV/Excel/TSV) for bulk merge when data is not provided
string
Logical document name; supports merge tags when generating a single document
string
PDF URL(s) or Base64 data URIs to embed as attachments in the PDF
string
PDF URL(s) or Base64 data URIs to append after generated content. Ignored if invalid or unreachable. Only for PDF/PDF-A formats.
boolean
Insert a page break between combined documents when single_file is true
string
Output file name without extension; extension added automatically
boolean
Combine multiple documents into one file (true) or return a ZIP (false)
string
required
ID of the template to use
string (".docx" | ".pdf" | ".doc" | ".odt" | ".txt" | ".pdf/a-1b" | ".pdf/a-2b" | ".pdf/a-3b")
Output format; defaults to .docx. PDF/A variants supported

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the document to update. Obtain this from the document generation response or by listing documents.
string
required
The new name/title for the document. This updates the document’s display name (not the filename).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the document to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUGENERATE_GET_TEMPLATETool to retrieve a specific template by ID. Returns template metadata including name, format, region, and configuration settings.

Input Parameters

string
required
ID of the template to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUGENERATE_LIST_DOCUMENTSList documents generated from a specific template, ordered by creation time descending. A 404 response is returned as an empty document list.

Input Parameters

string
required
ID of the template that was used to generate the documents

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to retrieve (starting at 1)
integer
Number of templates per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUGENERATE_TEMPLATE_UPDATEUpdate a template’s file, name, region, or versioning setting by ID. Include a file for the multipart request required by DocuGenerate’s template update API.

Input Parameters

string
required
Template identifier to update
object
The template file to upload (form field ‘file’)
string
Optional new name for the template
string
Processing region for the template (e.g., ‘us’, ‘eu’, ‘uk’, ‘au’)
boolean
Enable version history for the template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not