ConverterHQDevelopers
Documentation

Authentication

API keys, OAuth, scopes, test/live isolation and safe credential handling.

Server integrations authenticate with Bearer API keys. Delegated integrations such as MCP and Zapier use HQTools OAuth 2.0 Authorization Code + PKCE.

API keys

Authorization header
Authorization: Bearer hq_live_...

Test and live keys address isolated environments. Rotating a key never changes ownership of existing Files or Jobs because resources belong to the account, not the key.

OAuth

OAuth access tokens are scoped JWTs signed by HQTools and validated locally by ConverterHQ through JWKS. Third-party applications receive explicit user consent and revocable grants.

Scopes

Permissions are granular: Files, Jobs, Tasks, Workflows, Webhooks, Connections, Usage, Logs, Signed URLs and Realtime each have read/write scopes where applicable.

Credential safety