Combine 2 to 10 PDFs into a single document, in the order you send them.
PDF Merge combines 2 to 10 PDFs into one file, keeping their order, and returns a download link valid for 2 days. Upload the files or send their URLs. Paid plans add a breakdown of where each source document starts and ends in the merged file.
Try it — live request, no key required
No key required to try it. Get a key to use it in your app.
{
"status": "ok",
"error": null,
"data": {
"pdfName": "a356acc9-c44f-4363-9cda-14ed160d5f5d.pdf",
"fileCount": 2,
"pageCount": 5,
"size": 13539,
"expires": 1792230036453,
"downloadURL": "https://storage.googleapis.com/apiverve/APIData/pdfmerge/a356acc9-c44f-4363-9cda-14ed160d5f5d.pdf?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1792230036&Signature=R5%2B9%2FIKgsCiWQ7ibAS4Z%2B%2FLpYbNYc7hbAQGI%2FUtvmietXWHJxZK9x4%2FYYdLR6OXAVfvasiSNV2S8iie1Hz7xBGlTJMN8db%2BJ2tkE7GTnOXItMqMU8nuB0z6eddkoQmBESG8EOBr3AEG4x7XaEmP47FqUFsWoikKL2yhwZ9VHL%2F5ANZbvYnfbY1WBjVVOY4wQE1T6CDHM6En2Ov%2FzbTUENH7dasoIaJKWCXa7b1hBhc5MLOMB0MUQWRjb3cVoTHkZ1IRKh3InOdUduyORXOJpwLBTfLu6Q7%2FMEASTXd2j1N9F3OSJ7LYpOfiVhSvA%2FIW6CT2srzKniP5KgeX%2BYKTnNQ%3D%3D",
"sources": [
{
"index": 1,
"name": "rotation.pdf",
"pageCount": 2,
"startPage": 1,
"endPage": 2
},
{
"index": 2,
"name": "sizes.pdf",
"pageCount": 3,
"startPage": 3,
"endPage": 5
}
]
}
}
About the PDF Merge API
Pages are copied whole, so text, images, fonts and page sizes are kept as they were. Each call accepts up to 10 PDFs, 10 MB each and 25 MB in total, with at most 500 pages in the merged file. Encrypted PDFs are rejected; remove the password first.
What people use it for
- Document Packets
- Bundle a contract, its schedules and supporting documents into one PDF for signing or archiving.
- Report Assembly
- Join generated report sections, cover pages and appendices into a single deliverable.
- Invoice Batches
- Combine a customer's invoices or statements for the month into one file to send.
- Application Uploads
- Merge the separate scans a user uploads into one document before storing it.
Ways to call it
One endpoint, many ways in — REST with JSON, XML, YAML and CSV, plus GraphQL and an MCP interface for AI agents.
- JSON
- Default REST response
- XML
- Markup format
- YAML
- Human-readable
- CSV
- Tabular export
- GraphQL
- Query language
- MCP
- For AI agents
Other ways to use PDF Merge
Same data, same APIVerve account, same credit balance — one key works on all of them.
How many merges does the Starter plan cover?
What does the Free plan return?
What are the limits per call?
What happens with password-protected PDFs?
How long is the merged file kept?
Request parameters — POST /v1/pdfmerge
Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them. Anything not listed here is dropped rather than passed through.
Optional
| Parameter | Type | Example | Description |
|---|---|---|---|
urlsOptional | array | A JSON array of 2 to 10 public PDF URLs, merged in order. Or upload the PDFs as multipart files instead |
curl -X POST "https://api.apiverve.com/v1/pdfmerge" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"urls":["https://raw.githubusercontent.com/mozilla/pdf.js/master/test/pdfs/rotation.pdf","https://raw.githubusercontent.com/mozilla/pdf.js/master/test/pdfs/sizes.pdf"]}'Authentication
Send your key in the x-api-key header. That is the only auth step — no token exchange, and no per-endpoint scope to configure.
| Header | When | Value |
|---|---|---|
x-api-keyRequired | Every request | Your API key. Header names are case-insensitive, so X-API-Key is the same header. |
AuthorizationAlternate | Instead of the above | Bearer <key> — for clients that only expose bearer auth. Resolves to the same account and the same billing. |
content-typeRequired | POST body | application/json |
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Response — POST /v1/pdfmerge
Every APIVerve endpoint returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape.
{
"status": "ok",
"error": null,
"data": {
"pdfName": "a356acc9-c44f-4363-9cda-14ed160d5f5d.pdf",
"fileCount": 2,
"pageCount": 5,
"size": 13539,
"expires": 1792230036453,
"downloadURL": "https://storage.googleapis.com/apiverve/APIData/pdfmerge/a356acc9-c44f-4363-9cda-14ed160d5f5d.pdf?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1792230036&Signature=R5%2B9%2FIKgsCiWQ7ibAS4Z%2B%2FLpYbNYc7hbAQGI%2FUtvmietXWHJxZK9x4%2FYYdLR6OXAVfvasiSNV2S8iie1Hz7xBGlTJMN8db%2BJ2tkE7GTnOXItMqMU8nuB0z6eddkoQmBESG8EOBr3AEG4x7XaEmP47FqUFsWoikKL2yhwZ9VHL%2F5ANZbvYnfbY1WBjVVOY4wQE1T6CDHM6En2Ov%2FzbTUENH7dasoIaJKWCXa7b1hBhc5MLOMB0MUQWRjb3cVoTHkZ1IRKh3InOdUduyORXOJpwLBTfLu6Q7%2FMEASTXd2j1N9F3OSJ7LYpOfiVhSvA%2FIW6CT2srzKniP5KgeX%2BYKTnNQ%3D%3D",
"sources": [
{
"index": 1,
"name": "rotation.pdf",
"pageCount": 2,
"startPage": 1,
"endPage": 2
},
{
"index": 2,
"name": "sizes.pdf",
"pageCount": 3,
"startPage": 3,
"endPage": 5
}
]
}
}
Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
pdfName | string | "a356acc9-c44f-4363-9cda-14ed160d5f5d.pdf" | File name of the merged PDF |
fileCount | number | 2 | Number of PDFs merged |
pageCount | number | 5 | Pages in the merged PDF |
size | number | 13539 | Size of the merged PDF in bytes |
expires | number | 1792230036453 | When the download link expires (Unix time in milliseconds) |
downloadURL | string | "https://storage.googleapis.com/apiverve/APIData/pdfmerge/a356acc9-c44f-4363-9cda-14ed160d5f5d.pdf?GoogleAccessId=635500398038-compute%40dev… | Signed link to download the merged PDF, valid for 2 days |
sourcesPremium | array[2] | Each input file and the pages it occupies in the merged PDF | |
indexPremium | number | 1 | Position of the file in the request, from 1 |
namePremium | string | "rotation.pdf" | File name of the input |
pageCountPremium | number | 2 | Pages in this input |
startPagePremium | number | 1 | First page of this input in the merged PDF |
endPagePremium | number | 2 | Last page of this input in the merged PDF |
Response headers
Every response carries your balance, so your own code always knows where it stands without polling anything. All four are exposed to browsers through CORS.
| Header | What it carries |
|---|---|
x-api-remaining-credits | Credits left in the current cycle |
x-api-credits-used | Credits spent in the current cycle |
x-api-max-credits | The allowance for the cycle |
x-api-version | Version of the endpoint that answered |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter that has to change. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted here | A key restriction or an IP allow-list — never a bad key. |
429 | Rate limited, or out of credits | Read error to tell them apart, then back off or top up. |
What a call costs — 10 credits per call
Credits are shared across every APIVerve API — one balance, one key, one bill. Failed requests never count against it, so a rejected input costs nothing.
| Plan | Per month | Credits | PDF Merge calls | Per 1,000 calls |
|---|---|---|---|---|
| Free | Free | 200 | 20 | Free |
| Starter | $29.99 | 200,000 | 20,000 | $1.50 |
| Pro | $99.99 | 1,000,000 | 100,000 | $1.00 |
| Mega | $299.99 | 4,000,000 | 400,000 | $0.75 |
Calls are what the credits buy at this API's rate — spend them here, on any of the other APIs, or across both. Nothing is reserved per endpoint.
Call it from cURL — POST /v1/pdfmerge
No SDK to install — this is a plain HTTPS call to /v1/pdfmerge with your key in the x-api-key header. Swap in a real key and it runs as-is.
curl "https://api.apiverve.com/v1/pdfmerge" \
-H "x-api-key: YOUR_API_KEY"Resources
Call it from Node.js — POST /v1/pdfmerge
No SDK to install — this is a plain HTTPS call to /v1/pdfmerge with your key in the x-api-key header. Swap in a real key and it runs as-is.
const res = await fetch("https://api.apiverve.com/v1/pdfmerge", {
headers: { "x-api-key": "YOUR_API_KEY" },
});
const { data } = await res.json();
console.log(data);Resources
Call it from Python — POST /v1/pdfmerge
No SDK to install — this is a plain HTTPS call to /v1/pdfmerge with your key in the x-api-key header. Swap in a real key and it runs as-is.
import requests
res = requests.get(
"https://api.apiverve.com/v1/pdfmerge",
headers={"x-api-key": "YOUR_API_KEY"},
)
print(res.json()["data"])Resources
Call it from C# / .NET — POST /v1/pdfmerge
No SDK to install — this is a plain HTTPS call to /v1/pdfmerge with your key in the x-api-key header. Swap in a real key and it runs as-is.
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
var json = await client.GetStringAsync("https://api.apiverve.com/v1/pdfmerge");
Console.WriteLine(json);Resources
Call it from Go — POST /v1/pdfmerge
No SDK to install — this is a plain HTTPS call to /v1/pdfmerge with your key in the x-api-key header. Swap in a real key and it runs as-is.
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/pdfmerge", nil)
req.Header.Set("x-api-key", "YOUR_API_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))Resources
Call it from PHP — POST /v1/pdfmerge
No SDK to install — this is a plain HTTPS call to /v1/pdfmerge with your key in the x-api-key header. Swap in a real key and it runs as-is.
$ch = curl_init("https://api.apiverve.com/v1/pdfmerge");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-api-key: YOUR_API_KEY"]);
$response = curl_exec($ch);
echo $response;Resources
Call it from Ruby — POST /v1/pdfmerge
No SDK to install — this is a plain HTTPS call to /v1/pdfmerge with your key in the x-api-key header. Swap in a real key and it runs as-is.
require "net/http"
uri = URI("https://api.apiverve.com/v1/pdfmerge")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "YOUR_API_KEY"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.bodyResources
Zero-code embed — one snippet, no backend
Drop an interactive PDF Merge form onto any page. The widget calls the API for you, so no key ever appears in your markup and there is nothing to deploy.
Changelog — PDF Merge API
Every change to this endpoint, newest first. Breaking changes ship as a new version and the previous one keeps serving — response fields are added, never removed or retyped in place, so an integration written against v1 keeps working.
Entries are picked up from dated catalog snapshots, so the first one appears after the next snapshot that moves something. A period where nothing changed produces no entry — silence is a valid changelog for the PDF Merge API.