Base URL

All PDFox API endpoints share a single base URL. Every path in these docs is relative to it.

Production

Base URL

https://api.pdfox.com/v1

Versioning

The API version is part of the path (/v1/). Breaking changes will be released under a new version number; previous versions are supported for at least 12 months after a new version ships.

If you are logged in to the dashboard you can see your organisation-specific base URL on the API Keys page. This is useful for private-cloud deployments.

TLS

All requests must use HTTPS. Connections over plain HTTP are rejected with a redirect to the HTTPS equivalent. We require TLS 1.2 or newer.

Content type

All request bodies must be JSON. Set Content-Type: application/json on every POST or PATCH request. Responses are always JSON unless the endpoint explicitly returns binary data (e.g. PDF download).