Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blinkpdf.io/llms.txt

Use this file to discover all available pages before exploring further.

Every request to the Blink PDF API (except GET /v1/health) must be authenticated with an API key. Authentication uses the standard HTTP Bearer token scheme — you include your key in the Authorization header of every request. Your key identifies your account, determines your plan limits, and (on Pro+ plans) lets you attribute usage across multiple keys.

​
API Key Format

All Blink PDF API keys start with the prefix sk_live_ followed by a unique alphanumeric string. You can recognise a production key at a glance: 
sk_live_aBcDeFgHiJkLmNoPqRsTuVwX
Keep your API key secret. Do not commit it to source control, expose it in client-side JavaScript, or share it in public forums. If a key is compromised, rotate it immediately from the dashboard.

​
Sending the Authorization Header

Include your API key as a Bearer token in the Authorization header on every authenticated request: 
Authorization: Bearer sk_live_...
Here is a minimal example using curl: 
curl -X POST https://api.blinkpdf.io/v1/render \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"markdown": "# Hello"}' \
  --output hello.pdf

​
Getting Your API Key

You can create, view, and revoke API keys from the Blink PDF dashboard: https://app.blinkpdf.io Navigate to Settings → API Keys to generate a new key. You can create multiple keys — for example, one per environment or one per service — and revoke individual keys without affecting the others.
API keys are shown in full only at creation time. Copy and store your key securely before closing the dialog — you will not be able to retrieve it again.

​
Per-Key Usage Attribution

On Pro+ plans, each API key carries its own usage attribution. This means you can track how many renders each key has performed independently, which is useful when you manage multiple environments (development, staging, production) or multiple services that each call the render endpoint.
Per-key usage reporting is a Pro+ feature. On lower-tier plans, all keys share a single usage counter tied to your account.

​
Authentication Errors

If your request cannot be authenticated or authorised, the API returns one of the following errors:
Status CodeMeaningCommon Cause
401 UnauthorizedThe API key is missing or invalidThe Authorization header was omitted, the key was malformed, or the key has been revoked
403 ForbiddenThe key is valid but lacks access to this featureYour plan does not include the endpoint or option you requested
A 401 response always means the API could not verify your identity. Check that you are including the Authorization header and that the key value starts with sk_live_. A 403 response means your key is valid but your current plan does not cover the feature — upgrade your plan at https://app.blinkpdf.io to gain access.