ActiveMerge

Tools (13)

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

  Inputs: data, format, template_id

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

  Inputs: data, template_id, field_mapping

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

  Inputs: data, format, workflow_id

• Get Credits

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

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

  Inputs: job_id, status, date_to, date_from, page_size, next_cursor, template_id

• Get Document Template Placeholders

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

  Inputs: template_id

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

  Inputs: file_id

• Get Image Generation

  Get an image-generation job's progress, credit usage, errors, and temporary ZIP download URL when complete.

  Inputs: job_id

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

  Inputs: template_id

• Get Workflows

  List available ActiveMerge workflows, or return the case-sensitive placeholders for one workflow when workflow_id is supplied.

  Inputs: workflow_id

• List Document Templates

  List document templates available to the connected ActiveMerge account, including the unique template IDs needed for placeholder lookup and generation.

• List Stored 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.

  Inputs: parent_folder_id

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

  Inputs: job_id, filename, folder_id