# ActiveMerge — how to use (mcp.ai)

Connect your ActiveMerge account and use 13 tools for documents straight from your AI agent. Connect with your own API key. ActiveMerge automates document and image generation, document merging, e-signatures, file storage, and template-based workflows.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_active_merge?ms=1787295960000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `active_merge_generate_document`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/active_merge`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/active_merge/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/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.
  - body: { data: object, format: string, template_id: string }
- `POST https://api.mcp.ai/api/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.
  - body: { data: object[], template_id: integer, field_mapping: object }
- `POST https://api.mcp.ai/api/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 hour
  - body: { data: object, format: string, workflow_id: string }
- `POST https://api.mcp.ai/api/active_merge/get/credits` — Get total, used, remaining, plan, and prepaid ActiveMerge credits before running credit-consuming generation tools.
- `POST https://api.mcp.ai/api/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.
  - body: { job_id?: string, status?: string, date_to?: string, date_from?: string, page_size?: integer, next_cursor?: string, template_id?: string }
- `POST https://api.mcp.ai/api/active_merge/get/document/template/placeholders` — Return the case-sensitive placeholder names required by one document template.
  - body: { template_id: string }
- `POST https://api.mcp.ai/api/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.
  - body: { file_id: integer }
- `POST https://api.mcp.ai/api/active_merge/get/image/generation` — Get an image-generation job's progress, credit usage, errors, and temporary ZIP download URL when complete.
  - body: { job_id: integer }
- `POST https://api.mcp.ai/api/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.
  - body: { template_id?: integer }
- `POST https://api.mcp.ai/api/active_merge/get/workflows` — List available ActiveMerge workflows, or return the case-sensitive placeholders for one workflow when workflow_id is supplied.
  - body: { workflow_id?: string }
- `POST https://api.mcp.ai/api/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.
- `POST https://api.mcp.ai/api/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.
  - body: { parent_folder_id?: integer }
- `POST https://api.mcp.ai/api/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.
  - body: { job_id: string, filename?: string, folder_id?: integer }

## Example prompts
- "What can I do in ActiveMerge?"
- "Show me a summary of my ActiveMerge account"

## More
- Page: https://mcp.ai/active_merge
- Agent spec (llms.txt): https://mcp.ai/active_merge/llms.txt
- Postman collection: https://mcp.ai/active_merge/postman.json