Skip to main content

PDF Tools API

Header Footer API

Stamp consistent headers and footers onto generated or uploaded PDFs before they are shared.

Create API KeyRead full API docs

Credits

1 Credit / call

1 Credit per successful API request. Failed processing attempts are refunded automatically.

Pricing

1,000 Credits = $1

Every signed-in user receives 100 free API Credits each month.

Endpoint

/api/external/pdf-tools/header-footer

Use your API Key in the x-api-key header.

Use case

Use it for report names, account IDs, generated dates, confidentiality labels, or footer context in recurring document jobs.

cURL example

curl -X POST https://itextmaster.com/api/external/pdf-tools/header-footer \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'file=@input.pdf;type=application/pdf' \
  -F 'options={"headerText":"Quarterly Report","footerText":"Page {page} of {total}"}' \
  --output header-footer.pdf

Multipart example

curl -X POST https://itextmaster.com/api/external/pdf-tools/header-footer \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'file=@input.pdf;type=application/pdf' \
  -F 'options={"headerText":"Quarterly Report","footerText":"Page {page} of {total}"}' \
  --output header-footer.pdf

JSON base64 example

curl -X POST https://itextmaster.com/api/external/pdf-tools/header-footer \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
    "file": { "name": "input.pdf", "dataBase64": "JVBERi0xLjcK..." },
    "options": {"headerText":"Quarterly Report","footerText":"Page {page} of {total}"}
  }' \
  --output header-footer.pdf

Node.js example

import { writeFile } from 'node:fs/promises';

const response = await fetch('https://itextmaster.com/api/external/pdf-tools/header-footer', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': process.env.ITEXTMASTER_API_KEY
  },
  body: JSON.stringify({
  file: { name: 'input.pdf', dataBase64: 'JVBERi0xLjcK...' },
  options: {"headerText":"Quarterly Report","footerText":"Page {page} of {total}"}
})
});

if (!response.ok) {
  throw new Error(await response.text());
}

await writeFile('header-footer.pdf', Buffer.from(await response.arrayBuffer()));

Python example

import os
import requests

response = requests.post(
    'https://itextmaster.com/api/external/pdf-tools/header-footer',
    headers={
        'Content-Type': 'application/json',
        'x-api-key': os.environ['ITEXTMASTER_API_KEY'],
    },
    json={
        'file': {'name': 'input.pdf', 'dataBase64': 'JVBERi0xLjcK...'},
        'options': {'headerText': 'Quarterly Report', 'footerText': 'Page {page} of {total}'}
    },
)
response.raise_for_status()

with open('header-footer.pdf', 'wb') as f:
    f.write(response.content)

Error codes

401invalid_api_key

The x-api-key header is missing, invalid, or has been rotated.

402insufficient_credits

The account does not have enough API Credits for the request.

422pdf_tool_processing_failed

The file, options, or PDF structure could not be processed. Failed processing attempts are refunded automatically.

Limits

  • Requires one valid PDF file.
  • Header and footer text should be concise.
  • Very small margins can reduce available placement area.

Response headers

header-footer.pdf with X-Credits-Charged: 1 and X-Credit-Balance response headers.

Content-Type
The MIME type of the generated file, usually application/pdf or application/zip.
Content-Disposition
Attachment filename for the generated output.
X-Credits-Charged
Credits charged for the successful request.
X-Credit-Balance
Remaining API Credit balance after the request.

FAQ

How much does the Header Footer API cost?

Each successful Header Footer API request uses 1 Credit. 1,000 Credits cost $1, and every signed-in user receives 100 free API Credits each month.

What happens if processing fails?

Failed processing attempts are refunded automatically, and the API returns an error response you can log or retry.

Should I call this API from the browser?

No. Keep API Keys server-side and call the endpoint from your backend, queue, or automation job when you need to header footer.

Start with 100 free API Credits

Create an API Key, test Header Footer API, and buy more Credits only when automation volume grows.

Get API KeyView full API docs