Insert Blank Pages API
Insert blank pages into a 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-blank |
| Content type | multipart/form-data |
| Success response | Result file stream |
Request Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
file | File | Source PDF file. | 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. |
count | Number | Number of blank pages to insert. |
width | Number | Blank page width in points. |
height | Number | Blank page height in points. |
targetPassword | String | Password for the main target PDF. |
outputFileName | String | Optional output filename. When present, it is used as the preferred download filename. |
Request Example
bash
curl -X POST "http://localhost:8080/api/v1/process/pdf/insert-blank" \
-H "x-api-key: your_api_key_here" \
-F "[email protected]" \
-F 'request={"index":1,"count":1,"width":595,"height":842,"targetPassword":""}'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.