ConvertApi Logo

Merge PDF API

Combine and merge multiple PDF files.

API Request:
Copy parameter's URL Secret Secret
Optional

String Authentication secret must be provided as a query parameter. If omitted, token must be provided.

Show all
Copy parameter's URL Token Token
Optional

String Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Show all
Copy parameter's URL Files Files
Required

File Files to be converted. Value can be URL or file content. If used in query or multipart content parameter must be suffixed with index e.g. Files[0], Files[1], Files[2]...

Show all
Copy parameter's URL StoreFile Store file
Optional

Bool Store converted file on our secure server and provides download URL.

Default: False

Show all
Copy parameter's URL FileName File name
Optional

String Converted output file name without extension. The extension will be added automatically.

Show all
Copy parameter's URL Timeout Timeout
Optional

Integer Conversion timeout in seconds.

Default: 900

Range: 10 .. 1200

Show all
Copy parameter's URL Async Asynchronous
Optional

Bool Run conversion job asynchronously.

Default: False

Show all
Copy parameter's URL JobId Job ID
Optional

String Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously.

Show all
Copy parameter's URL WebHook WebHook
Optional

String Set WebHook URL to call after asynchronous conversion is finished. Async parameter must be enabled.

Show all
Copy parameter's URL PdfUserPassword PDF User Password
Optional

String User password, required to decrypt encrypted PDF.

Show all
Copy parameter's URL PdfOwnerPassword PDF Owner Password
Optional

String Owner password, required to decrypt encrypted PDF.

Show all
Copy parameter's URL RetainNumbering Retain PDF numbering
Optional

Bool Keeps the original PDF documents numbering rather than re-numbering merged PDF from the 1 page.

Default: False

Show all
Copy parameter's URL RemoveDuplicateFonts Remove duplicate fonts
Optional

Bool Do not include the same fonts from source PDFs while merging.

Default: False

Show all
Copy parameter's URL BookmarksToc Add bookmarks TOC
Optional

Collection Adds a top-level bookmark for each file, using the filename or PDF title from metadata.

Default: Disabled

Values: disabled, filename, title

Show all
Copy parameter's URL ForceMerge Force merging
Optional

Bool Force to merge signed PDF files and forms. All others properties are ignored when this property is enabled.

Default: False

Show all
Copy parameter's URL PageSize Page size
Optional

Collection The property scales each page to fit a given page size.

Default: default

Values: default, a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, usletter, uslegalportrait

Show all
Copy parameter's URL PageOrientation Page orientation
Optional

Collection Set page orientation, works only along with PageSize property.

Default: default

Values: default, portrait, landscape

Show all
Copy parameter's URL OpenPage Open to page
Optional

Integer Set the page number at which the PDF document should open.

Default: 1

Range: 1 .. 3000

Show all

Developer mode

Snippets are autogenerated according to converter parameter choices above. Please select file in "File" or "Files" parameter before using code snippets.

Code snippet is using ConvertAPI JavaScript Client

Code snippet is using ConvertAPI Node.js Client

Code snippet is using ConvertAPI PHP Client

Code snippet is using ConvertAPI Java Client

Code snippet is using ConvertAPI C# Client

Code snippet is using ConvertAPI Ruby Client

Code snippet is using ConvertAPI Python Client

Code snippet is using ConvertAPI Go Client

Code snippet is using command line utility program

For conversions with the multiple file result please refer to the example