Header & Footer API
Add header and footer text with date, filename and page variables in left, centre and right slots.
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/pdf-header-footer
- 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
- Web tool
- Use Header & Footer without code
Parameters
Send these as a JSON string in the options form field. Anything else is rejected.
| Name | Type | Default | Allowed |
|---|---|---|---|
headerLeft | string | — | — |
headerCenter | string | — | — |
headerRight | string | — | — |
footerLeft | string | — | — |
footerCenter | string | {page} / {pages} | — |
footerRight | string | — | — |
fontSize | integer | 9 | min 6, max 24, pt |
marginMm | integer | 10 | min 2, max 40, mm |
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/pdf-header-footer/jobs instead. See jobs and webhooks.
Also runs on the device
In the web tool and apps, Header & Footer can run locally with no upload. The API always processes on the server.
Try it yourself!
Pick a file, set the options and run a real request with your key. The code follows your changes.