PDFHQ logo

Documents

DocumentationGetting started

API Authentication

Authenticate with scoped HQTools API keys and protect your server credentials.

Server-side API keys Signed storage uploads

Project-scoped API keys#

Use x-api-key: YOUR_API_KEY in each API request from your trusted backend. API keys are resolved against HQTools project entitlements and usage limits, and PDFHQ enforces account and key ownership when reading tasks and uploads.

cURL
curl https://api.pdfhq.io/v1/tasks -H 'x-api-key: YOUR_API_KEY'

Never embed API keys in website bundles or public Git repositories. Use your backend to create upload tickets and return only their expiring S3 form fields to the browser.

Authentication errors#

Missing or invalid credentials return an authorization error. Objects owned by a different account or API key return 404 to avoid disclosing their existence.

PDFHQ logo

PDF tools and document intelligence. Prepare, understand and work with your documents.

© 2026 PDFHQ. All rights reserved.