Authentication

The doclinth API authenticates with a secret key. Create and manage keys in API Keys. Each key looks like dl_live_… and is shown only once at creation.

Sending the key

Pass your key as a Bearer token on every request:

Authorization: Bearer dl_live_YOUR_KEY

An X-API-Key: dl_live_… header is also accepted.

Test mode

Create a test key (prefix dl_test_…) to build your integration without side effects. Test keys:

  • never consume your monthly PDF quota;
  • always stamp a diagonal TEST DOCUMENT · NOT FOR DELIVERYwatermark, so a test render can't be mistaken for a real one;
  • are rate-limited to 10 requests/minute regardless of plan;
  • share a hard account allowance of 100 test requests per UTC day.

Everything else (the endpoint, request shape, and responses) is identical to live mode. Switch to a dl_live_…key when you're ready to ship.

Keep keys secret

  • Use keys only from your server; never ship them in client-side or mobile code.
  • doclinth stores only a hash of your key. If you lose it, revoke it and create a new one.
  • Revoking a key takes effect immediately.