PDF Tools

PDF Form Fill Batch

Fill one PDF form template with an array of records and output one filled PDF per record (ZIP) or a merged PDF

file· File resultOpen tool

Quick start

Call this tool from your code in three languages.

cURL

# 1) Upload each file first → returns { filePath }
curl -X POST 'https://api.elysiatools.com/upload/pdf-form-fill-batch' \
  -F 'file=@/path/to/templatePdf.ext'

# 2) Call the tool with the returned filePath values
curl -X POST 'https://api.elysiatools.com/en/api/tools/pdf-form-fill-batch' \
  -F 'templatePdf=/public/samples/pdf/certificate-template.pdf' \
  -F 'recordsJson=[{"name":"Alice Zhang","course":"Advanced TypeScript","date":"2026-06-16"},{"name":"Bob Chen","course":"Go Fundamentals","date":"2026-06-16"},{"name":"Carol Lee","course":"Rust Systems","date":"2026-06-16"}]' \
  -F 'outputMode=zip' \
  -F 'nameField=name' \
  -F 'flattenEach=true'

API reference

Send a POST request with your inputs as JSON. File parameters require a separate upload first.

Endpoint

HTTP

POST https://api.elysiatools.com/en/api/tools/pdf-form-fill-batch

Parameters

Name	Type	Required	Description
templatePdf	fileupload required	Yes	—
recordsJson	textarea	Yes	JSON array of objects. Each object fills one copy of the template.
outputMode	select	No	—
nameField	text	No	Record field used to name each output PDF in ZIP mode
flattenEach	checkbox	No	Flatten each filled form so it is non-editable

File-type parameters must be uploaded first via POST /upload/pdf-form-fill-batch, then the returned filePath is passed to the corresponding file field.

Response format

File result

JSON

{
  "filePath": "/public/processing/randomid.ext",
  "fileName": "output.ext",
  "contentType": "application/octet-stream",
  "size": 1024,
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}

MCP integration

Add this tool to your Model Context Protocol server so AI agents can list and call it.

Server configuration

Add this block to your MCP client configuration:

mcp.json

{
  "mcpServers": {
    "elysiatools-pdf-form-fill-batch": {
      "name": "pdf-form-fill-batch",
      "description": "Fill one PDF form template with an array of records and output one filled PDF per record (ZIP) or a merged PDF",
      "baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=pdf-form-fill-batch",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

List available tools

After connecting to the SSE endpoint, list the exposed tools:

tools/list

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/list"
}

Call this tool

Invoke the tool by its id, passing arguments built from its parameters:

tools/call

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "pdf-form-fill-batch",
    "arguments": {
  "templatePdf": "/public/samples/pdf/certificate-template.pdf",
  "recordsJson": "[{\"name\":\"Alice Zhang\",\"course\":\"Advanced TypeScript\",\"date\":\"2026-06-16\"},{\"name\":\"Bob Chen\",\"course\":\"Go Fundamentals\",\"date\":\"2026-06-16\"},{\"name\":\"Carol Lee\",\"course\":\"Rust Systems\",\"date\":\"2026-06-16\"}]",
  "outputMode": "zip",
  "nameField": "name",
  "flattenEach": true
}
  }
}

Chain multiple tools in one session with a comma-separated toolId list, e.g. /mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp (max 20).

File parameters accept a public file URL only (https://…). Local paths, data: URIs, and Base64 strings are not supported.

Questions or issues? Contact [email protected]