Insert PDF Pages API

Insert pages from another PDF into the main PDF.

Feature

The ComPDF Self-hosted accepts files and a request JSON string through multipart/form-data, forwards the parameters to the private PDF SDK, and streams the result file back on success.

Synchronous Request

Item	Value
Authentication	x-api-key: your_api_key_here
Request URL	POST http://localhost:8080/api/v1/process/pdf/insert-from-pdf
Content type	multipart/form-data
Success response	Result file stream

Request Parameters

Parameter	Type	Description	Required
file	File	Target PDF file.	Yes
insertFile	File	PDF file to insert into the target PDF.	Yes
request	String	JSON string containing the PDF SDK parameters below. If omitted, remaining non-file form-data fields are forwarded as the request object.	No

Request Object Parameters

Put the following fields in the request JSON string.

Parameter	Type	Purpose
index	Number	One-based insertion position.
sourcePageRanges	String[]	Page ranges selected from the PDF being inserted. Empty means all pages.
targetPassword	String	Password for the main target PDF.
insertPassword	String	Password for the inserted PDF.
outputFileName	String	Optional output filename. When present, it is used as the preferred download filename.

Request Example

curl -X POST "http://localhost:8080/api/v1/process/pdf/insert-from-pdf" \
  -H "x-api-key: your_api_key_here" \
  -F "[email protected]" \
  -F "[email protected]" \
  -F 'request={"index":1,"sourcePageRanges":["1-2"],"targetPassword":"","insertPassword":""}'

Response

On success, the API returns the processed file stream with Content-Type and Content-Disposition headers. On failure, the ComPDF Self-hosted returns a normalized error JSON response.