---
title: "Add page numbers to a PDF"
method: POST
path: "/pdf-page-numbers"
tags: ["PDF"]
---

# Add page numbers to a PDF

`POST /pdf-page-numbers`

## Request

- Base URL: `https://api.cofferdock.com`
- URL: `https://api.cofferdock.com/pdf-page-numbers`
- Auth: API key in header `x-api-key`

Stamps a page number on every page (or on `pages`). The `format` text must contain {n}; it can also use {total}.

Costs 1 credit per call.

## Request body

- object
  - `file` string, byte, required: The PDF, base64-encoded.
  - `format` string: e.g. "Page {n} of {total}".
  - `position` 'bottom-center' | 'bottom-left' | 'bottom-right' | 'top-center' | 'top-left' | 'top-right': Where to print the number: "bottom-center" (default), "bottom-left", "bottom-right", "top-center", "top-left" or "top-right".
  - `start` integer: Number shown on the first page (default 1).
  - `font_size` number: Font size in points (6-72). Default 10.
  - `margin` number: Distance from the page edge to the number, in points (0-200). Default 24.
  - `color` string: Text color as a hex code, e.g. "#000000" (black, default).
  - `pages` string: Pages to act on, 1-indexed, e.g. "1-3,5,7-9". Default: all pages.
  - `output` 'json' | 'binary' | 'url' | 'pdf': How to return the PDF: "json" (base64 in the JSON response), "binary" (the PDF itself, ready for n8n/Make/Zapier) or "url" (a temporary download link, valid 15 minutes). Default: json when the request is JSON, binary when the input was sent raw.

## Response `200`

The resulting PDF (shape depends on `output`).

- union
  - object
    - `success` boolean
    - `pdf` string, byte
    - `mime_type` 'application/pdf'
    - `meta` object
      - `size_bytes` integer
      - `used` integer: Credits used this month, after this call.
      - `remaining` integer, nullable: Credits left this month (null = unlimited).
      - `unlimited` boolean
  - object: Returned when output=url: a temporary download link (valid 15 minutes).
    - `success` boolean
    - `url` string, uri: Temporary download link. Expires in 15 minutes.
    - `expires_at` string, date-time
    - `mime_type` string
    - `size_bytes` integer
    - `meta` object
      - `used` integer: Credits used this month, after this call.
      - `remaining` integer, nullable: Credits left this month (null = unlimited).
      - `unlimited` boolean

## Other responses

- `400`: Invalid input (nothing is charged).
- `401`: Missing or invalid API key.
- `403`: Email not verified.
- `429`: Monthly credit limit reached, or too many requests per minute for this key (see Retry-After).
- `503`: Server busy (queue full). Retry after the seconds in the Retry-After header.

---

[API](https://skmtc.dev/cofferdock/apis/cofferdock-api.md) · [All operations](https://skmtc.dev/cofferdock/apis/cofferdock-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cofferdock/apis/cofferdock-api/revisions/b57aa000d33a?raw)