Add Page Numbers API
Stamp page numbers in any of nine positions with formats like 1, Page 1 of N or i, ii, iii — start number, font, margins and skipped pages.
Environment
| Environment | Base URL |
|---|---|
| Production | https://api.sadafiles.com/v1 |
There is one environment and no sandbox, so every request here is real and counts toward your limits.
Request
POSThttps://api.sadafiles.com/v1/tools/add-page-numbers
- Content type
- multipart/form-data
- Auth
- X-API-Key with tools:run
- Accepts
- Files per request
- 1
- Largest file
- 2 GB
- Job timeout
- 120 s
- Rate weight
- 2 units
Parameters
Send these as a JSON string in the options form field. Anything else is rejected.
| Name | Type | Default | Allowed |
|---|---|---|---|
position | string | bottomCenter | topLeft, topCenter, topRight, middleLeft, middleCenter, middleRight, bottomLeft, bottomCenter, bottomRight |
format | string | n | n, pageNofM, roman, romanUpper, n-of-M |
startAt | integer | 1 | min 0 |
skipFirst | integer | 0 | min 0 |
fontSize | integer | 11 | min 6, max 36, pt |
font | string | helvetica | helvetica, times, courier |
marginMm | integer | 10 | min 2, max 40, mm |
pages | string | all | — |
Response
| Status | Body | When |
|---|---|---|
201 | The run finished within 60 seconds | |
202 | Job summary JSON | Still running; poll the job |
4xx, 5xx | Error JSON | See error codes |
A file response carries X-Sada-Job and X-Sada-Expires-At. For long work, post to /v1/tools/add-page-numbers/jobs instead. See jobs and webhooks.
Also runs on the device
In the web tool and apps, Add Page Numbers can run locally with no upload. The API always processes on the server.
Ready settings
These settings power the matching pages on the site, and work the same in the API.
| Use | options |
|---|---|
| Add “Page X of Y” to PDF | {"format":"pageNofM"} |
Try it yourself!
Pick a file, set the options and run a real request with your key. The code follows your changes.