About this endpoint
What it does
Adds page numbers to a PDF and returns the modified PDF as a binary file. You upload the PDF and can optionally control the numbering format, prefix, starting number, font size, position, page range, and whether to skip the first page.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| file | String | Yes | The PDF. Up to 20 MB. |
| format | ENUM | No | Numbering format. Allowed values: plain (1, 2, 3, default), page-of-total (Page 1 of 10), prefixed (your prefix then the number, for example No. 1). |
| prefix | String | No | Text before the number. Only used when format is prefixed. Latin letters, digits and common punctuation. |
| startAt | Number | No | Number shown on the first numbered page. A whole number from 1 up. Default 1. |
| fontSize | Number | No | Font size in points, 4 to 72. Default 10. |
| position | ENUM | No | Where to place the number. Allowed values: bottom-center, bottom-right, bottom-left, top-center, top-right, top-left. Default bottom-center. |
| pageRange | String | No | Pages to number, from 1. For example 2-10 or 1,3,5-8. Default: every page. |
| skipFirstPage | String | No | true (also yes, 1, on) to leave page 1 unnumbered, also inside pageRange. Default false. |
Response
Returns a binary file containing the PDF with page numbers added. The success response is a single binary string value.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| string | String | Yes | Binary PDF output with page numbers applied. |



