Merge PDFs, Join Part or All of Documents, API Tool

Try Now with API Lab

Start right from your browser - upload files, choose parameters, generate code, and send API Calls directly from API Lab!

Request

POST

Headers

Api-Key

Don't have a key? Create an account to get one.

Response-Type

Poll for the status of a request by ID. Request IDs can be found in the JSON response of POST requests sent to any pdfRest endpoint.

Required Parameters

Optional Parameters

output

Name of the generated output file, without extension

Code

curl -X POST "https://api.pdfrest.com/merged-pdf" \ 
  -H "Accept: application/json" \ 
  -H "Content-Type: multipart/form-data" \
  -H "Api-Key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \

Response

The response for your API Call will display here.

Once you've sent your POST request and received a valid response, you can download your output file using the output URL.

Build Your Solution

You have document processing problems, we have Solutions. Explore the many ways pdfRest can align your documents with your business objectives.

Browse all solutions

Many different file type icons (XLS, PNG, HTML, etc) are all marging with arrows into a large PDF file icon

Convert and Merge Multiple Types of Files Together

Access PDF Processing Power with AI Magic

Integrate pdfRest with Microsoft Power Automate

Integrate PDF API Tools with Salesforce Apex Code

Control your Backend with pdfRest API Toolkit Self-Hosted

Three different PDF documents are added together to equal a new document where they are combined

Merge PDF Documents for Streamlined Report Compilation

Why is pdfRest the best API to merge PDF files?

pdfRest offers the best solution for merging multiple PDF documents together, because it produces optimized output, supports flexible page ranges, and can be combined with conversion to merge files of other formats.

Merge without the Bloat

Many tools claim to merge PDF documents together, but most leave the resulting file with unnecessary, redundant content we like to refer to as “bloat.” This can make the file size much bigger than it needs to be and create a much slower user experience for file transfers and viewing.

pdfRest optimizes the content of every merged PDF it creates to ensure the output file contains only what it needs.

Assemble your Perfect Document

pdfRest’s Merge PDFs allows for much more than full document merging. Let’s say you only need page 1 from Document A, pages 3-5 from Document B, and pages 15, 18, and 72 from Document C… no problem! Choose exactly which pages to include from each input file and specify the exact order you need them in the output file.

Level Up with Chainable API Calls

Sometimes you need to merge PDFs together, but other times you may need to merge various file types together into one PDF, such as Word documents with PNG images and HTML files.

pdfRest is purpose-built to support multi-step workflow processes. Simply upload your files of various type to the Convert to PDF tool and pass the resource IDs of each output file from those calls to the Merge PDFs tool. No need to download and upload files between API Calls - simply chain calls together.

Start from Code Examples

See more code examples in our GitHub repository

Need more help?

Start with a Tutorial for step-by-step guidance

How to Merge PDF Files in .NET with C#

How to Merge PDF Files with cURL

How to Merge PDF Files with Java

How to Merge PDF Files with JavaScript in NodeJS

How to Merge PDF Files with PHP

How to Merge PDF Files with Python

6 items

Customize Your Solution

Learn about the parameters for this tool to create your custom solution.

File

The file parameter allows you to select two or more local PDF files to be uploaded to pdfRest’s processing server. (You can include this parameter multiple times.) Files will be merged in the order that they are listed.

The Merge PDFs tool requires the type[] parameter for each instance of file.

See Documentation

The id[] parameter allows you to submit one or more resource IDs generated by one of our API Tools. Each of our API Tools assigns a unique resource ID to your output file(s), allowing you to chain requests together without having to download intermediate files between requests.

For example, you can merge multiple PDFs that you received from one or more of our API Tools, such as our Convert to PDF and Compress PDF API Tools, into a single document by submitting their resource IDs here.

The Merge PDFs tool requires the type[] parameter for each instance of id[].

See Documentation

Pages

The pages[] parameter is used to identify pages and/or page ranges that you would like to take from each input document and merge into a single PDF. This is a versatile parameter that allows you to reorder and duplicate pages based on the page numbers and ranges that you specify. Use this parameter once for each file that you would like to merge.

If a page number is included more than once (e.g., “1,2,3,3,4,5”), then the page will be duplicated in the output file. Pages may also be reordered (e.g., “1,5,3,2,4”), and page ranges may be reversed by listing the higher page number first (e.g., “2,4,9-5,12”).

To include all pages from a document, use the range “1-last”. The “last” keyword can also be applied generally to page ranges (e.g., “1-4,6,7-last”).

The pages[] parameter also accepts the keywords “even” and “odd” to select only those pages to merge into your new PDF.

See Documentation

Type

Use the type[] parameter once for each instance of file and/or id to merge your freshly uploaded documents with your already processed documents. The value of this parameter helps identify each file in order as either a newly uploaded file or the resource ID of a file already on the server.

See Documentation

Output

The output parameter lets you set a filename (without extension) for your new PDF.

See Documentation