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

Tools

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

object
required
Case-sensitive template placeholder names mapped to replacement values.
string ("pdf" | "docx" | "pptx")
required
Output document format.
string
required
Template unique_id from List Document Templates.

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

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

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

object
required
Case-sensitive workflow placeholder names mapped to replacement values.
string ("pdf" | "original")
required
Output mode: pdf combines the workflow documents into a PDF; original keeps each template’s original format.
string
required
Workflow unique_id from Get Workflows.

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: ACTIVE_MERGE_GET_CREDITSGet total, used, remaining, plan, and prepaid ActiveMerge credits before running credit-consuming generation tools.

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

string
Exact generation job ID. When supplied, returns that job and cannot be combined with history filters, page_size, or next_cursor.
string ("in_progress" | "completed" | "failed" | "expired")
Filter history by status; only valid when job_id is omitted.
string
Include jobs created on or before this date (YYYY-MM-DD); only valid when job_id is omitted.
string
Include jobs created on or after this date (YYYY-MM-DD); only valid when job_id is omitted.
integer
History jobs per page (1-100); only valid when job_id is omitted.
string
Opaque continuation cursor returned by a prior history call.
string
Filter history by template unique ID; only valid when job_id is omitted.

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: ACTIVE_MERGE_GET_DOCUMENT_TEMPLATE_PLACEHOLDERSReturn the case-sensitive placeholder names required by one document template.

Input Parameters

string
required
Template unique_id from List Document Templates, not the numeric template id.

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: ACTIVE_MERGE_GET_FILE_DOWNLOAD_URLCreate a temporary download URL for a file in ActiveMerge cloud storage. This requires a Pro or higher plan with cloud storage enabled.

Input Parameters

integer
required
Stored file ID from List Stored Files or Save Generated Files.

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: ACTIVE_MERGE_GET_IMAGE_GENERATIONGet an image-generation job’s progress, credit usage, errors, and temporary ZIP download URL when complete.

Input Parameters

integer
required
Image-generation job ID returned by Generate Images.

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: ACTIVE_MERGE_GET_IMAGE_TEMPLATESList image templates and placeholders, or retrieve one template with its available dimensions, positions, defaults, and styles when template_id is supplied.

Input Parameters

integer
Image template ID. Omit to list templates; supply it to return full dimensions, positioning, and styling for one 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
Slug: ACTIVE_MERGE_GET_WORKFLOWSList available ActiveMerge workflows, or return the case-sensitive placeholders for one workflow when workflow_id is supplied.

Input Parameters

string
Workflow unique_id. Omit to list workflows; supply it to return that workflow’s case-sensitive placeholders.

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: ACTIVE_MERGE_LIST_DOCUMENT_TEMPLATESList document templates available to the connected ActiveMerge account, including the unique template IDs needed for placeholder lookup and generation.

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

integer
Folder ID whose immediate contents to list; omit for the storage root.

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: ACTIVE_MERGE_SAVE_GENERATED_FILESSave non-expired output from a completed document-generation job to ActiveMerge cloud storage. This requires a Pro+ plan.

Input Parameters

string
required
Completed document-generation job ID whose non-expired output should be saved.
string
Custom filename for a single-file job. Omit for multi-file jobs or to use provider-generated names.
integer
Destination folder ID; omit to save at the cloud-storage root.

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