▣ FILE CONVERSION · FILE MANIPULATION

Apply Footers on PDF API

What it does

PDF Header Footer stamps a header and footer onto an existing PDF, using either text or PNG images. Send a source PDF as an uploaded file or by URL, choose the header and footer content, and get back the modified document.

Use the file-based endpoints when you want the processed PDF streamed directly back, or the URL-based endpoints when you want a signed URL for the stamped file. The input supports file or file_url, plus header_text or header_image_url for the header and footer_text or footer_image_url for the footer. When both text and image are provided for the same slot, text wins.

You can also control presentation details like alignment, font size, and opacity. Shared settings such as font_size and font_opacity apply as fallbacks, while header_font_size, footer_font_size, header_alignment, footer_alignment, header_opacity, and footer_opacity let you tune each edge independently. Image stamps support header_image_size and footer_image_size for sizing PNG logos or marks.

Use PDF Header Footer for document branding, report pagination labels, draft or confidentiality marks, and internal distribution copies that need consistent top and bottom text or imagery.

▣ ENDPOINT 01 / 04

POST

Stamp header/footer onto an uploaded PDF, stream result back

https://api.eu.apyverse.com/apyhub/pdf-header-footer/file/download

QUICKSTART

GUIDE

Quickstart

Stamp a PDF with a header and footer, then download the generated file.

curl -X POST "https://api.eu.apyverse.com/apyhub/pdf-header-footer/file/download" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/source.pdf" \
  -F "header_text=Confidential" \
  -F "footer_text=Page 1"

What you'll get back

Returns a binary file (string with format: "binary"), which is the processed PDF for download.

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.

body*

header_text/header_image (one required) and footer_text/footer_image (one required); if both text and image given for a slot, text wins.

file*

Source PDF file to stamp. Required.

Choose a file…

footer

header

font_size

Shared fallback for header_font_size/footer_font_size.

footer_text

Alias: footer. Required if footer_image not given. Wins over footer_image if both present.

header_text

Alias: header. Required if header_image not given. Wins over header_image if both present.

font_opacity

footer_image

PNG image. Required if footer_text not given.

Choose a file…

header_image

PNG image. Required if header_text not given.

Choose a file…

footer_opacity

header_opacity

Falls back to font_opacity when header_text set, else 1.

footer_alignment

footer_font_size

header_alignment

header_font_size

Falls back to font_size if unset.

footer_image_size

header_image_size

About this endpoint

What it does

Uploads a PDF and stamps a header and/or footer onto it, then streams the modified PDF back as the response. The request body must include the source PDF file and at least one header source and one footer source for each slot, using text or PNG image inputs as defined below.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	Source PDF file to stamp.
footer	String	No	Footer text. Alias of `footer_text`; if both text and image are provided for the footer slot, text wins.
header	String	No	Header text. Alias of `header_text`; if both text and image are provided for the header slot, text wins.
font_size	Number	No	Shared fallback for `header_font_size` / `footer_font_size`. Minimum `8`, maximum `24`.
footer_text	String	No	Alias of `footer`. Required if `footer_image` is not given. Wins over `footer_image` if both are present.
header_text	String	No	Alias of `header`. Required if `header_image` is not given. Wins over `header_image` if both are present.
font_opacity	Number	No	Opacity for text rendering. Minimum `0`, maximum `1`.
footer_image	String	No	PNG footer image. Required if `footer_text` is not given.
header_image	String	No	PNG header image. Required if `header_text` is not given.
footer_opacity	Number	No	Footer opacity. Default is `1`. Minimum `0`, maximum `1`.
header_opacity	Number	No	Header opacity. Default is `1`. Falls back to `font_opacity` when `header_text` is set, otherwise `1`. Minimum `0`, maximum `1`.
footer_alignment	ENUM	No	Footer alignment. Allowed values: `left`, `right`, `center`. Default is `center`.
footer_font_size	Number	No	Footer text size. Default is `12`. Minimum `8`, maximum `24`.
header_alignment	ENUM	No	Header alignment. Allowed values: `left`, `right`, `center`. Default is `center`.
header_font_size	Number	No	Header text size. Default is `12`. Falls back to `font_size` if unset. Minimum `8`, maximum `24`.
footer_image_size	Number	No	Footer image size scale. Default is `0.1`. Minimum `0.1`, maximum `1`.
header_image_size	Number	No	Header image size scale. Default is `0.1`. Minimum `0.1`, maximum `1`.

Response

Returns a binary file stream containing the stamped PDF. The success response is a single binary string, not a JSON object.

Parameter	Type	Mandatory	Description
string	String	Yes	Binary PDF output streamed back by the endpoint.

Body

Name

Type

Description

bodyREQUIRED

object

header_text/header_image (one required) and footer_text/footer_image (one required); if both text and image given for a slot, text wins.

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

Stamp header/footer onto an uploaded PDF, get a signed URL back

https://api.eu.apyverse.com/apyhub/pdf-header-footer/file/url

QUICKSTART

GUIDE

Quickstart

Upload a PDF plus header/footer text, and the API returns a URL for the generated file.

curl -X POST "https://api.eu.apyverse.com/apyhub/pdf-header-footer/file/url" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/input.pdf" \
  -F "header_text=Confidential" \
  -F "footer_text=Page 1"

What you'll get back

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

{
  "url": "https://example.com/generated.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.

body*

header_text/header_image (one required) and footer_text/footer_image (one required); if both text and image given for a slot, text wins.

file*

Source PDF file to stamp. Required.

Choose a file…

footer

header

font_size

Shared fallback for header_font_size/footer_font_size.

footer_text

Alias: footer. Required if footer_image not given. Wins over footer_image if both present.

header_text

Alias: header. Required if header_image not given. Wins over header_image if both present.

font_opacity

footer_image

PNG image. Required if footer_text not given.

Choose a file…

header_image

PNG image. Required if header_text not given.

Choose a file…

footer_opacity

header_opacity

Falls back to font_opacity when header_text set, else 1.

footer_alignment

footer_font_size

header_alignment

header_font_size

Falls back to font_size if unset.

footer_image_size

header_image_size

output

About this endpoint

What it does

Stamps a header and/or footer onto an uploaded PDF file and returns a JSON object containing a signed output URL. The request body includes the source PDF plus either text or image content for each slot, with text taking precedence over image when both are provided.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	Source PDF file to stamp. Binary upload.
footer	String	No	Footer content. Alias of `footer_text`. Text wins over `footer_image` if both are present.
header	String	No	Header content. Alias of `header_text`. Text wins over `header_image` if both are present.
font_size	Number	No	Shared fallback for `header_font_size` and `footer_font_size`. Minimum 8, maximum 24.
footer_text	String	No	Alias: `footer`. Required if `footer_image` is not given. Wins over `footer_image` if both are present.
header_text	String	No	Alias: `header`. Required if `header_image` is not given. Wins over `header_image` if both are present.
font_opacity	Number	No	Opacity for font-based header/footer content. Minimum 0, maximum 1.
footer_image	String	No	PNG image. Binary upload. Required if `footer_text` is not given.
header_image	String	No	PNG image. Binary upload. Required if `header_text` is not given.
footer_opacity	Number	No	Opacity for the footer. Default: 1. Minimum 0, maximum 1.
header_opacity	Number	No	Opacity for the header. Default: 1. Falls back to `font_opacity` when `header_text` is set, otherwise 1. Minimum 0, maximum 1.
footer_alignment	ENUM	No	Allowed values: `left`, `right`, `center`. Default: `center`.
footer_font_size	Number	No	Footer font size. Default: 12. Minimum 8, maximum 24.
header_alignment	ENUM	No	Allowed values: `left`, `right`, `center`. Default: `center`.
header_font_size	Number	No	Header font size. Default: 12. Falls back to `font_size` if unset. Minimum 8, maximum 24.
footer_image_size	Number	No	Footer image size. Default: 0.1. Minimum 0.1, maximum 1.
header_image_size	Number	No	Header image size. Default: 0.1. Minimum 0.1, maximum 1.

Response

Returns a JSON object with a url string field containing a URI to the generated output file.

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

Query parameters

Name

Type

Description

outputOPTIONAL

string

—

DEFAULT test-sample

Body

Name

Type

Description

bodyREQUIRED

object

header_text/header_image (one required) and footer_text/footer_image (one required); if both text and image given for a slot, text wins.

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

Stamp header/footer onto a PDF fetched from a URL, stream result back

https://api.eu.apyverse.com/apyhub/pdf-header-footer/url/download

QUICKSTART

GUIDE

Quickstart

Generate a PDF with a header and footer from a PDF URL.

curl -X POST "https://api.eu.apyverse.com/apyhub/pdf-header-footer/url/download" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "file_url": "https://example.com/sample.pdf",
    "header_text": "Confidential",
    "footer_text": "Page footer"
  }'

What you'll get back

Returns a binary file response containing the generated 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

This endpoint fetches a PDF from the provided URL, applies the requested header and/or footer settings, and returns the modified PDF as a binary response.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	URL of the source PDF. Must be a URI. Required.
footer	String	No	Footer content.
header	String	No	Header content.
font_size	Number	No	Font size for the stamped text. Minimum 8, maximum 24.
footer_text	String	No	Footer text content.
header_text	String	No	Header text content.
font_opacity	Number	No	Opacity for the stamped content. Minimum 0, maximum 1.
footer_opacity	Number	No	Footer opacity. Default: 1. Minimum 0, maximum 1.
header_opacity	Number	No	Header opacity. Default: 1. Minimum 0, maximum 1.
footer_alignment	ENUM	No	Footer alignment. Allowed values: `left`, `right`, `center`. Default: `center`.
footer_font_size	Number	No	Footer font size. Default: 12. Minimum 8, maximum 24.
footer_image_url	String	No	URL of a PNG image. Required if `footer_text` is not given. Must be a URI.
header_alignment	ENUM	No	Header alignment. Allowed values: `left`, `right`, `center`. Default: `center`.
header_font_size	Number	No	Header font size. Default: 12. Minimum 8, maximum 24.
header_image_url	String	No	URL of a PNG image. Required if `header_text` is not given. Must be a URI.
footer_image_size	Number	No	Footer image size. Default: 0.1. Minimum 0.1, maximum 1.
header_image_size	Number	No	Header image size. Default: 0.1. Minimum 0.1, maximum 1.

Response

Returns the generated PDF as a binary payload. The response schema is a single binary string, so there is no JSON wrapper or named response fields to extract.

Body

Name

Type

Description

bodyREQUIRED

object

header_text/header_image_url (one required) and footer_text/footer_image_url (one required).

▣ ENDPOINT 04 / 04

POST

Stamp header/footer onto a PDF fetched from a URL, get a signed URL back

https://api.eu.apyverse.com/apyhub/pdf-header-footer/url/url

QUICKSTART

GUIDE

Quickstart

Generate a PDF from a source file URL with a header and footer, then returns a downloadable URL.

curl -X POST "https://api.eu.apyverse.com/apyhub/pdf-header-footer/url/url" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "file_url": "https://example.com/sample.pdf",
    "header_text": "Monthly Report",
    "footer_text": "Confidential"
  }'

What you'll get back

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

{
  "url": "https://example.com/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

Fetches a PDF from the provided source URL, stamps header and/or footer content onto it, and returns a signed URL to the generated PDF.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	URL of the source PDF. Must be a URI.
footer	String	No	Additional footer content.
header	String	No	Additional header content.
font_size	Number	No	Font size for the stamp content. Minimum 8, maximum 24.
footer_text	String	No	Footer text to render. One of `footer_text` or `footer_image_url` is required.
header_text	String	No	Header text to render. One of `header_text` or `header_image_url` is required.
font_opacity	Number	No	Opacity for the stamp content. Minimum 0, maximum 1.
footer_opacity	Number	No	Footer opacity. Default: 1. Minimum 0, maximum 1.
header_opacity	Number	No	Header opacity. Default: 1. Minimum 0, maximum 1.
footer_alignment	ENUM	No	Footer alignment. Allowed values: `left`, `right`, `center`. Default: `center`.
footer_font_size	Number	No	Footer font size. Default: 12. Minimum 8, maximum 24.
footer_image_url	String	No	URL of a PNG image for the footer. One of `footer_text` or `footer_image_url` is required. Must be a URI.
header_alignment	ENUM	No	Header alignment. Allowed values: `left`, `right`, `center`. Default: `center`.
header_font_size	Number	No	Header font size. Default: 12. Minimum 8, maximum 24.
header_image_url	String	No	URL of a PNG image for the header. One of `header_text` or `header_image_url` is required. Must be a URI.
footer_image_size	Number	No	Footer image size. Default: 0.1. Minimum 0.1, maximum 1.
header_image_size	Number	No	Header image size. Default: 0.1. Minimum 0.1, maximum 1.

Response

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

Parameter	Type	Mandatory	Description
url	String	No	Signed URL to the generated PDF. Must be a URI.

Query parameters

Name

Type

Description

outputOPTIONAL

string

—

DEFAULT test-sample

Body

Name

Type

Description

bodyREQUIRED

object

header_text/header_image_url (one required) and footer_text/footer_image_url (one required).

▣ 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.