▣ FILE MANIPULATION

Apply Footers on PDF API

Hosted on ApyHub

What it does

PDF Header Footer adds text or PNG images to the top and bottom of a PDF, then returns the updated file or a downloadable URL.

Send a PDF and choose one of four input styles: upload a file or pass a public PDF URL, then receive either a binary download or a JSON response with a url. You can set header_text or footer_text, use {page} in footer text to print the page number, or provide header_image and footer_image / header_image_url and footer_image_url for image-based branding. Alignment is configurable for both header and footer with left, center, or right.

Use PDF Header Footer when you need to stamp invoices, add page numbers, mark internal documents with labels like CONFIDENTIAL, or place a logo on exported reports. The service is built for simple document post-processing: you provide the source PDF and the header/footer content, and it returns a modified PDF ready to store, send, or download.

The /file/download and /url/download endpoints return the modified PDF directly. The /file/url and /url/url endpoints return an S3 URL in a url field, which is useful when your workflow needs a persisted output location instead of a file stream.

▣ ENDPOINT 01 / 04

POST

Add header/footer to PDF

http://localhost:8080/apyhub/add-header-footer-to-pdf/file/download

QUICKSTARTGUIDE

Quickstart

Upload a PDF and add a simple header or footer, then download the modified file.

curl -X POST "http://localhost:8080/apyhub/add-header-footer-to-pdf/file/download" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/input.pdf" \
  -F "footer_text=Page"

What you'll get back

Returns a binary file containing the modified PDF.

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

About this endpoint

What it does

Uploads a PDF file and returns a modified PDF with a header and/or footer added. You can supply header/footer text or PNG images, and optionally control alignment and output filename stem.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	PDF file to modify.
output	String	No	Output filename stem without extension. Defaults to `output`.
footer_text	String	No	Footer text. Use `{page}` as a placeholder for the page number.
header_text	String	No	Header text. At least one of `header_text`, `footer_text`, `header_image`, or `footer_image` is required.
footer_image	String	No	Footer image (PNG).
header_image	String	No	Header image (PNG).
footer_alignment	ENUM	No	Alignment for the footer. Allowed values: `left`, `center`, `right`. Default: `center`.
header_alignment	ENUM	No	Alignment for the header. Allowed values: `left`, `center`, `right`. Default: `center`.

Response

Returns a binary file response containing the modified PDF as a downloadable document.

Parameter	Type	Mandatory	Description
file	String	Yes	Binary PDF content returned by the endpoint.

Notes

At least one of header_text, footer_text, header_image, or footer_image must be provided; otherwise the request body does not satisfy the schema.

Body

Name

Type

Description

bodyREQUIRED

object

—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 02 / 04

POST

Add header/footer to PDF (file upload → S3 URL)

http://localhost:8080/apyhub/add-header-footer-to-pdf/file/url

QUICKSTARTGUIDE

Quickstart

Upload a PDF and add simple header/footer text, then get back a link to the processed file.

curl -X POST "http://localhost:8080/apyhub/add-header-footer-to-pdf/file/url" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/file.pdf" \
  -F "footer_text=Page"

What you'll get back

Returns a JSON object with a url string field containing the downloadable URL of the generated PDF.

{
  "url": "https://s3.amazonaws.com/bucket/output.pdf"
}

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

About this endpoint

What it does

Uploads a PDF file and returns a URL to the processed PDF with a header and/or footer applied. You can provide header/footer text, header/footer images, and optional alignment settings.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	PDF file to process.
footer_text	String	No	Footer text to add. Example: `Page {page}`.
header_text	String	No	Header text to add. Example: `CONFIDENTIAL`.
footer_image	String	No	Footer image file.
header_image	String	No	Header image file.
footer_alignment	ENUM	No	Alignment for the footer content. Allowed values: `left`, `center`, `right`. Default: `center`.
header_alignment	ENUM	No	Alignment for the header content. Allowed values: `left`, `center`, `right`. Default: `center`.

Response

Returns a JSON object with a url string field containing the URI of the generated PDF.

Parameter	Type	Mandatory	Description
url	String	No	URI of the processed PDF file.

Body

Name

Type

Description

bodyREQUIRED

object

—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 03 / 04

POST

Add header/footer to PDF (URL → download)

http://localhost:8080/apyhub/add-header-footer-to-pdf/url/download

QUICKSTARTGUIDE

Quickstart

Add text or images to a PDF from a public file URL, and download the modified PDF.

curl -X POST "http://localhost:8080/apyhub/add-header-footer-to-pdf/url/download" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "file_url": "https://assets.apyhub.com/samples/sample.pdf",
    "header_text": "CONFIDENTIAL"
  }'

What you'll get back

Returns the generated PDF as a binary file.

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Adds a header and/or footer to a PDF fetched from a public URL, then returns the modified PDF as a binary download.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	Publicly accessible PDF URL.
footer_text	String	No	Footer text. Use `{page}` for the page number.
header_text	String	No	Header text. At least one of `header_text`, `footer_text`, `header_image_url`, or `footer_image_url` is required.
footer_alignment	ENUM	No	Alignment for the footer text/image. Allowed values: `left`, `center`, `right`. Default: `center`.
footer_image_url	String	No	Publicly accessible PNG image URL for the footer.
header_alignment	ENUM	No	Alignment for the header text/image. Allowed values: `left`, `center`, `right`. Default: `center`.
header_image_url	String	No	Publicly accessible PNG image URL for the header.

Response

Returns a binary PDF file as the response body after the header/footer has been applied.

Attribute	Type	Mandatory	Description
binary	String	Yes	The generated PDF file content returned as binary data.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 04 / 04

POST

Add header/footer to PDF (URL → S3 URL)

http://localhost:8080/apyhub/add-header-footer-to-pdf/url/url

QUICKSTARTGUIDE

Quickstart

Generate a PDF with header/footer text from a PDF URL.

curl -X POST "http://localhost:8080/apyhub/add-header-footer-to-pdf/url/url" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"file_url":"https://assets.apyhub.com/samples/sample.pdf","footer_text":"Page {page}","header_text":"CONFIDENTIAL"}'

What you'll get back

Returns a JSON object with a url string field containing the output PDF URL.

{
  "url": "https://s3.amazonaws.com/bucket/output.pdf"
}

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Adds a header and/or footer to a PDF referenced by URL, then returns a JSON object containing the output file URL.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	Source PDF URL. Must be a URI.
footer_text	String	No	Footer text to place in the PDF.
header_text	String	No	Header text to place in the PDF.
footer_alignment	ENUM	No	Alignment for the footer content. Allowed values: `left`, `center`, `right`. Default: `center`.
footer_image_url	String	No	Footer image URL. Must be a URI.
header_alignment	ENUM	No	Alignment for the header content. Allowed values: `left`, `center`, `right`. Default: `center`.
header_image_url	String	No	Header image URL. Must be a URI.

Response

Returns a JSON object with a url string field containing the output PDF URL.

Parameter	Type	Mandatory	Description
url	String	No	Output PDF URL. Must be a URI.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.