PDF tools

Merge PDFs

Merge 2-200 PDFs into one document. Answers a Render object with input_type: "pdf_tool"; delivery, mode, webhook, reference, metadata and test behave as on POST /v1/renders.

post/v1/pdf-tools/merge

Request

  • Base URL: https://api-eu.dynamicdocumentapi.com
  • URL: https://api-eu.dynamicdocumentapi.com/v1/pdf-tools/merge
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

Idempotency-Keystring

Replays the stored response for 24 h; a different body with the same key → 422.

Request body

bookmarks'filenames' | 'none'
filenamestring nullable
metadataobject nullable
mode'sync' | 'async'
priority'normal' | 'low'
referencestring nullable
testboolean nullable
timeout_behavior'continue' | 'cancel'

Response

Sync render finished (status=succeeded). With delivery.type=binary the body is the file.

batch_idstring nullable
billed_rendersinteger

Renders billed for this request (0 for test renders, previews, failed and canceled renders).

completed_atstring date-time nullable
created_atstring date-time required
enginestring
engine_versionstring nullable
expires_atstring date-time nullable
idstring required
input_type'template' | 'html' | 'url' | 'markdown' | 'pdf_tool' | 'einvoice'
kindstring
metadataobject
mode'sync' | 'async' required
object'render' required
output_format'pdf' | 'png' | 'jpeg' | 'webp' | 'html' | 'zip' | 'xml'
pagesinteger nullable
referencestring nullable
regionstring required
sourcestring
status'queued' | 'processing' | 'succeeded' | 'failed' | 'canceled' | 'expired' required
testboolean required
timingsobject

Example response

{
  "billed_renders": 1,
  "email": [
    {
      "error": {
        "code": "email_daily_cap_reached"
      },
      "id": "ems_01J9ZM1X3F7R8K2C4V6B8N0P2T",
      "rule_id": "emr_01J9ZK3M7Q8V5W2X4Y6Z8A0B1E"
    }
  ],
  "engine": "2026.4",
  "error": {
    "code": "template_runtime_error"
  },
  "files": [
    {
      "bytes": 48213,
      "content_type": "application/pdf",
      "filename": "invoice-42.pdf",
      "id": "file_01J9ZM1X3F7R8K2C4V6B8N0P2Q"
    }
  ],
  "id": "rnd_01J9ZM1X3F7R8K2C4V6B8N0P2Q",
  "kind": "pdf_template",
  "region": "eu",
  "result": {
    "conformance": {
      "einvoice": {
        "errors": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ],
        "scenario": "EN16931 XRechnung (CII)",
        "validator": "KoSIT Validator 1.6.3",
        "warnings": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ]
      },
      "pdfa": {
        "errors": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ],
        "profile": "PDF/A-3B validation profile",
        "validator": "veraPDF 1.30.2",
        "warnings": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ]
      },
      "pdfua": {
        "errors": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ],
        "profile": "PDF/UA-1 validation profile",
        "validator": "veraPDF 1.30.2",
        "warnings": [
          {
            "location": "invoice.seller.contact.email",
            "rule": "BR-DE-15"
          }
        ]
      }
    }
  },
  "source": "api",
  "storage": [
    {
      "destination_id": "dst_01J9ZM1X3F7R8K2C4V6B8N0P2Q"
    }
  ],
  "timings": {
    "queued_ms": 3,
    "render_ms": 612,
    "total_ms": 681,
    "upload_ms": 38
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.