Skip to main content

API Credentials

Use the API Credentials section to manage conversion API keys, Personal Access Tokens, and the webhook signing secret for async callbacks.

API Credentials page showing conversion API keys, Personal Access Tokens, and the webhook signing secret
CredentialUse it forRelated header
Conversion API KeyGenerating PDFs through /v1/direct, /v1/sync, and /v1/async, and retrieving usage from /v1/usage.API-KEY
Personal Access TokenManaging templates through the Template API.PERSONAL-ACCESS-TOKEN
Webhook Signing SecretVerifying that /v1/async callback requests came from PDFBolt.x-pdfbolt-signature

Conversion API Keys

Conversion API keys are shared by all team members. You can have up to 5 API keys, including blocked keys. A default key is created during registration. New keys are active by default.

Manage conversion API keys

  1. Click New API Key to create another key if fewer than 5 keys exist.

  2. Click the eye icon to show or hide a key. Click the copy icon to copy it to your clipboard.

Details view of an API key, showing its name, status, copy and edit button
  1. Send the key in the API-KEY header when calling the Conversion API.

    API-KEY: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
  2. Use Edit to change the key name. Names can be up to 50 characters.

  3. In the edit dialog, change the status to Blocked when the key should stop authorizing API requests.

Edit button to rename or block an API key Modal window for editing an API key, including renaming or blocking options
Keep your API keys secure

Do not share API keys publicly or expose them in client-side code. Blocked keys cannot be reactivated in the Dashboard and still count toward the 5-key limit. Contact support to restore access.

Personal Access Tokens

Personal Access Tokens let external tools and AI agents use the Template API to manage templates. Tokens belong to the user who creates them, and each user can have up to 5 tokens, including deactivated tokens.

Personal Access Tokens section on the API Credentials page

These tokens are separate from conversion API keys and are intended for CI workflows, Claude Code, Codex, and other AI-assisted template editors. A token grants full Template API access to every template in the user's current team. It can list templates, read their content, sampleData, and parameters, create or update drafts, publish versions, and run preview or diff renders. Tokens have no fine-grained scopes and do not expire automatically.

Manage personal access tokens

  1. Click New Token to create a token.

  2. Click the eye icon to show or hide the token. Click the copy icon to copy it to your clipboard.

  3. Send the token in the PERSONAL-ACCESS-TOKEN header when calling the Template API.

    PERSONAL-ACCESS-TOKEN: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
  4. Use Edit to change the token name. Names can be up to 50 characters.

  5. Deactivate a token when an external tool should stop accessing your templates. Deactivation cannot be undone in the Dashboard, and the token continues to count toward the 5-token limit.

Keep your tokens secure

Store each token in an environment variable or secret manager, issue a separate token for each integration, and never expose it in client-side code, logs, or source control. Deactivate a token when it is no longer needed or may have been compromised.

Webhook Signature

The Webhook Signature section shows the secret PDFBolt uses to sign callback requests from /v1/async conversions. The same secret is used for all async callbacks and is available to all team members. It cannot authorize API requests.

  • Click the eye icon to show or hide the secret.
  • Click the copy icon to copy it to your clipboard.
Webhook Signature section showing the secret key with show/hide and copy options

For details on how to verify webhook signatures in your code, see Webhook Signature Verification.