Base URL

All PDFox API endpoints share a single base URL. Every path in these docs (for example /v1/generate) is relative to it.

Production

Base URL

https://api.pdf-fox.com

Endpoints live under the /v1 prefix, so a full URL looks like https://api.pdf-fox.com/v1/generate.

Versioning

The API version is part of the path (/v1/). Breaking changes will be released under a new version number.

When running PDFox locally, the API listens on http://localhost:3000 by default, so paths become http://localhost:3000/v1/....

TLS

Always use HTTPS in production. Your API key travels in the Authorization header, so never send requests over plain HTTP.

Content type

Request bodies are JSON: set Content-Type: application/json on POST and PATCH requests. JSON bodies are limited to 100 KB (larger bodies return 413). The one exception is asset upload (POST /v1/assets), which takes multipart/form-data. Responses are JSON unless the endpoint returns a file (a PDF or asset download).