> ## 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.

# ActiveMerge

> ActiveMerge automates document and image generation, document merging, e-signatures, file storage, and template-based workflows.

![ActiveMerge logo](https://mintcdn.com/composio-preview/qzegrvAapILigeDI/images/toolkits/active_merge.svg?fit=max\&auto=format\&n=qzegrvAapILigeDI\&q=85\&s=1db859571f7233795ba97a4a549fed59)

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

## Tools

> [accordion] Generate Document
>
> **Slug:** `ACTIVE_MERGE_GENERATE_DOCUMENT`
>
> Start asynchronous document generation from a template and case-sensitive placeholder data. Each generation consumes ActiveMerge credits. Returns a job ID to monitor with Get Document Generations.
>
> #### Input Parameters
>
> **data** `object` *required*
>
> Case-sensitive template placeholder names mapped to replacement values.
>
> **format** `string ("pdf" | "docx" | "pptx")` *required*
>
> Output document format.
>
> **template\_id** `string` *required*
>
> Template unique\_id from List Document Templates.
>
> #### 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] Generate Images
>
> **Slug:** `ACTIVE_MERGE_GENERATE_IMAGES`
>
> Start an asynchronous image-generation job from inline JSON records. Each image consumes one ActiveMerge credit. Supports 1 to 2,000 images and returns a job ID to monitor with Get Image Generation.
>
> #### Input Parameters
>
> **data** `array` *required*
>
> Inline JSON records to render. Each record creates one image and consumes one ActiveMerge credit; provide 1 to 2,000 records.
>
> **template\_id** `integer` *required*
>
> Image template ID from Get Image Templates.
>
> **field\_mapping** `object` *required*
>
> Map each case-sensitive template placeholder name to the corresponding key in every data record.
>
> #### 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] Generate Workflow Documents
>
> **Slug:** `ACTIVE_MERGE_GENERATE_WORKFLOW_DOCUMENTS`
>
> Generate documents for every template in an ActiveMerge workflow using case-sensitive placeholder data. This operation consumes ActiveMerge credits and returns an output URL that expires after 24 hours.
>
> #### Input Parameters
>
> **data** `object` *required*
>
> Case-sensitive workflow placeholder names mapped to replacement values.
>
> **format** `string ("pdf" | "original")` *required*
>
> Output mode: pdf combines the workflow documents into a PDF; original keeps each template's original format.
>
> **workflow\_id** `string` *required*
>
> Workflow unique\_id from Get Workflows.
>
> #### 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 Credits
>
> **Slug:** `ACTIVE_MERGE_GET_CREDITS`
>
> Get total, used, remaining, plan, and prepaid ActiveMerge credits before running credit-consuming generation tools.
>
> #### 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 Generations
>
> **Slug:** `ACTIVE_MERGE_GET_DOCUMENT_GENERATIONS`
>
> Get one document-generation job by ID, or list and filter generation history when no job ID is supplied. Returns one history page at a time.
>
> #### Input Parameters
>
> **job\_id** `string`
>
> Exact generation job ID. When supplied, returns that job and cannot be combined with history filters, page\_size, or next\_cursor.
>
> **status** `string ("in_progress" | "completed" | "failed" | "expired")`
>
> Filter history by status; only valid when job\_id is omitted.
>
> **date\_to** `string`
>
> Include jobs created on or before this date (YYYY-MM-DD); only valid when job\_id is omitted.
>
> **date\_from** `string`
>
> Include jobs created on or after this date (YYYY-MM-DD); only valid when job\_id is omitted.
>
> **page\_size** `integer`
>
> History jobs per page (1-100); only valid when job\_id is omitted.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior history call.
>
> **template\_id** `string`
>
> Filter history by template unique ID; only valid when job\_id is omitted.
>
> #### 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 Template Placeholders
>
> **Slug:** `ACTIVE_MERGE_GET_DOCUMENT_TEMPLATE_PLACEHOLDERS`
>
> Return the case-sensitive placeholder names required by one document template.
>
> #### Input Parameters
>
> **template\_id** `string` *required*
>
> Template unique\_id from List Document Templates, not the numeric template id.
>
> #### 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 File Download URL
>
> **Slug:** `ACTIVE_MERGE_GET_FILE_DOWNLOAD_URL`
>
> Create a temporary download URL for a file in ActiveMerge cloud storage. This requires a Pro or higher plan with cloud storage enabled.
>
> #### Input Parameters
>
> **file\_id** `integer` *required*
>
> Stored file ID from List Stored Files or Save Generated Files.
>
> #### 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 Image Generation
>
> **Slug:** `ACTIVE_MERGE_GET_IMAGE_GENERATION`
>
> Get an image-generation job's progress, credit usage, errors, and temporary ZIP download URL when complete.
>
> #### Input Parameters
>
> **job\_id** `integer` *required*
>
> Image-generation job ID returned by Generate Images.
>
> #### 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 Image Templates
>
> **Slug:** `ACTIVE_MERGE_GET_IMAGE_TEMPLATES`
>
> List image templates and placeholders, or retrieve one template with its available dimensions, positions, defaults, and styles when template\_id is supplied.
>
> #### Input Parameters
>
> **template\_id** `integer`
>
> Image template ID. Omit to list templates; supply it to return full dimensions, positioning, and styling for one template.
>
> #### 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 Workflows
>
> **Slug:** `ACTIVE_MERGE_GET_WORKFLOWS`
>
> List available ActiveMerge workflows, or return the case-sensitive placeholders for one workflow when workflow\_id is supplied.
>
> #### Input Parameters
>
> **workflow\_id** `string`
>
> Workflow unique\_id. Omit to list workflows; supply it to return that workflow's case-sensitive placeholders.
>
> #### 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 Document Templates
>
> **Slug:** `ACTIVE_MERGE_LIST_DOCUMENT_TEMPLATES`
>
> List document templates available to the connected ActiveMerge account, including the unique template IDs needed for placeholder lookup and 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] List Stored Files
>
> **Slug:** `ACTIVE_MERGE_LIST_FILES`
>
> List the immediate files and folders at the ActiveMerge cloud-storage root, or directly inside parent\_folder\_id when supplied. Cloud storage is a Pro+ feature; Free accounts may return an empty list.
>
> #### Input Parameters
>
> **parent\_folder\_id** `integer`
>
> Folder ID whose immediate contents to list; omit for the storage root.
>
> #### 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] Save Generated Files
>
> **Slug:** `ACTIVE_MERGE_SAVE_GENERATED_FILES`
>
> Save non-expired output from a completed document-generation job to ActiveMerge cloud storage. This requires a Pro+ plan.
>
> #### Input Parameters
>
> **job\_id** `string` *required*
>
> Completed document-generation job ID whose non-expired output should be saved.
>
> **filename** `string`
>
> Custom filename for a single-file job. Omit for multi-file jobs or to use provider-generated names.
>
> **folder\_id** `integer`
>
> Destination folder ID; omit to save at the cloud-storage root.
>
> #### 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
