PDFHQ logo

Documents

DocumentationGetting started

AI operation quotes

Read the unified HQ-credit balance, discover approved model tariffs and request account-scoped quotes before quote-bound AI execution.

Server-side API keys Signed storage uploads

AI prices and quote discovery#

PDFHQ supports account-scoped AI pricing discovery and quotation via HQTools. AI execution is disabled by default and uses a separate quote-bound job API; these quote endpoints do not run a model or charge credits. Approved, active model tariffs are returned; otherwise the list is empty. Do not activate prices before reviewing provider costs and approving HQTools tariffs.

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

curl 'https://api.pdfhq.io/v1/ai/billing/prices' -H 'x-api-key: YOUR_API_KEY'

# Model catalogue shows provider, tier and tariff availability; no credentials exposed.
curl 'https://api.pdfhq.io/v1/ai/billing/models' -H 'x-api-key: YOUR_API_KEY'

curl -X POST 'https://api.pdfhq.io/v1/ai/billing/quotes' \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"price_id":"APPROVED_PRICE_ID","quantity":"1"}'

Choose OpenAI, Claude or Gemini#

The model list is curated and priced by HQTools. A model is shown as available only when the deployment enables inference, the provider credential is configured server-side, the model is on the operator allowlist, and an approved HQTools tariff exists. The selected price_id determines the provider/model and HQ-credit quote; callers cannot override it by sending an arbitrary model name. All models use the same validated document evidence, consent, project isolation, and durable settlement lifecycle. Never put provider API keys in browser code.

cURL
# 1. Find available models and approved prices
curl 'https://api.pdfhq.io/v1/ai/billing/models' -H 'x-api-key: YOUR_API_KEY'
curl 'https://api.pdfhq.io/v1/ai/billing/prices' -H 'x-api-key: YOUR_API_KEY'
# 2. Quote a price_id for your chosen provider/model; jobs use the returned quote_id
curl -X POST 'https://api.pdfhq.io/v1/ai/billing/quotes' \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"price_id":"APPROVED_PRICE_ID","quantity":"1"}'

Dual-wallet pricing#

HQTools calculates the AI provider leg and a separate base HQ processing leg for each PDFHQ AI quote. Only trusted processing services can reserve, settle or release credits. A customer cannot submit arbitrary actual usage or reserve credits by calling these public routes. The quote returns an expiry; do not reuse stale quotes.

Both wallets are visible in your account credit dashboard . API keys need the pdfhq.ai.quote scope and an enabled API entitlement. Quote-bound asynchronous AI execution is described on the AI jobs page; it is gated off unless the operator enables and verifies its model, billing and privacy configuration.

PDFHQ logo

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

© 2026 PDFHQ. All rights reserved.