---
canonical_url: "https://docs.composio.dev/toolkits/active_merge"
markdown_url: "https://docs.composio.dev/toolkits/active_merge.md"
product: "platform"
version: null
last_updated: null
---

# ActiveMerge

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

- **Category:** documents
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 13
- **Triggers:** 0
- **Slug:** `ACTIVE_MERGE`
- **Version:** 00000000_00

## Tools

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Case-sensitive template placeholder names mapped to replacement values. |
| `format` | string ("pdf" | "docx" | "pptx") | Yes | Output document format. |
| `template_id` | string | Yes | Template unique_id from List Document Templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Inline JSON records to render. Each record creates one image and consumes one ActiveMerge credit; provide 1 to 2,000 records. |
| `template_id` | integer | Yes | Image template ID from Get Image Templates. |
| `field_mapping` | object | Yes | Map each case-sensitive template placeholder name to the corresponding key in every data record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Case-sensitive workflow placeholder names mapped to replacement values. |
| `format` | string ("pdf" | "original") | Yes | Output mode: pdf combines the workflow documents into a PDF; original keeps each template's original format. |
| `workflow_id` | string | Yes | Workflow unique_id from Get Workflows. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credits

**Slug:** `ACTIVE_MERGE_GET_CREDITS`

Get total, used, remaining, plan, and prepaid ActiveMerge credits before running credit-consuming generation tools.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | No | 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") | No | Filter history by status; only valid when job_id is omitted. |
| `date_to` | string | No | Include jobs created on or before this date (YYYY-MM-DD); only valid when job_id is omitted. |
| `date_from` | string | No | Include jobs created on or after this date (YYYY-MM-DD); only valid when job_id is omitted. |
| `page_size` | integer | No | History jobs per page (1-100); only valid when job_id is omitted. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior history call. |
| `template_id` | string | No | Filter history by template unique ID; only valid when job_id is omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document Template Placeholders

**Slug:** `ACTIVE_MERGE_GET_DOCUMENT_TEMPLATE_PLACEHOLDERS`

Return the case-sensitive placeholder names required by one document template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Template unique_id from List Document Templates, not the numeric template id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | Stored file ID from List Stored Files or Save Generated Files. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | integer | Yes | Image-generation job ID returned by Generate Images. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Image Templates

**Slug:** `ACTIVE_MERGE_GET_IMAGE_TEMPLATES`

List image templates and basic placeholders, or get complete dimensions, positions, defaults, and styles for one template when template_id is supplied.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | integer | No | Image template ID. Omit to list templates; supply it to return full dimensions, positioning, and styling for one template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_id` | string | No | Workflow unique_id. Omit to list workflows; supply it to return that workflow's case-sensitive placeholders. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `parent_folder_id` | integer | No | Folder ID whose immediate contents to list; omit for the storage root. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save Generated Files

**Slug:** `ACTIVE_MERGE_SAVE_GENERATED_FILES`

Save non-expired output from a completed document-generation job to permanent ActiveMerge cloud storage. This requires a Pro+ plan and consumes one ActiveMerge credit per saved file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Completed document-generation job ID whose non-expired output should be saved. |
| `filename` | string | No | Custom filename for a single-file job. Omit for multi-file jobs or to use provider-generated names. |
| `folder_id` | integer | No | Destination folder ID; omit to save at the cloud-storage root. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |