PDF Page Numbers

Overview

Numbers are drawn in Helvetica as real PDF text, so the rest of the document is untouched. Rotated pages are handled, so the number sits in the chosen corner the right way up as the page is displayed. Each call accepts one PDF of up to 10 MB and 300 pages.

Live Test PDF Page Numbers API →

Endpoint

One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.

1
2
3
4
5
6
7

curl -X POST https://api.apiverve.com/v1/pdfpagenumbers \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "format": "Page {page} of {total}",
  "pdf": "https://raw.githubusercontent.com/mozilla/pdf.js/master/test/pdfs/rotation.pdf"
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

const res = await fetch('https://api.apiverve.com/v1/pdfpagenumbers', {
  method: 'POST',
  headers: {
    'x-api-key': 'your_api_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "format": "Page {page} of {total}",
  "pdf": "https://raw.githubusercontent.com/mozilla/pdf.js/master/test/pdfs/rotation.pdf"
}),
});

if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);

const { data } = await res.json();
console.log(data);

1
2
3
4
5
6
7
8
9
10
11
12
13
14

import requests

res = requests.post(
    "https://api.apiverve.com/v1/pdfpagenumbers",
    headers={"x-api-key": "your_api_key_here"},
    json={
    "format": "Page {page} of {total}",
    "pdf": "https://raw.githubusercontent.com/mozilla/pdf.js/master/test/pdfs/rotation.pdf"
},
    timeout=15,
)
res.raise_for_status()

print(res.json()["data"])

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "format": "Page {page} of {total}",
  "pdf": "https://raw.githubusercontent.com/mozilla/pdf.js/master/test/pdfs/rotation.pdf"
}`)
	req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/pdfpagenumbers", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("x-api-key", "your_api_key_here")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.

Authentication

Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.

Parameters

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.

Response

Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "status": "ok",
  "error": null,
  "data": {
    "pdfName": "5c9f95f9-9719-47c3-a923-be3bc1f1dc91.pdf",
    "pageCount": 2,
    "numberedPages": 2,
    "position": "bottom-center",
    "format": "Page {page} of {total}",
    "startAt": 1,
    "lastLabel": "Page 2 of 2",
    "size": 6218,
    "expires": 1792230037933,
    "downloadURL": "https://storage.googleapis.com/apiverve/APIData/pdfpagenumbers/5c9f95f9-9719-47c3-a923-be3bc1f1dc91.pdf?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1792230037&Signature…"
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.

Use cases

Generated Reports

Number the pages of reports and exports produced by other tools that leave them unnumbered.

Legal and Compliance

Add Page X of Y labels to contracts and filings before they are signed or submitted.

Merged Documents

Number a document after merging several PDFs so the combined file reads as one.

Print and Publishing

Paginate manuscripts, handouts and booklets, skipping the cover page.

Other ways to use PDF Page Numbers

Set up PDF Page Numbers on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.

Related

More in Documents: