API Endpoints
PDFBolt provides endpoints to generate PDFs from HTML, URLs, and templates. You can also merge, compress, or convert existing PDFs to PDF/X, manage reusable templates, and check your plan and remaining credits.
For an interactive view of endpoints, schemas, error responses, and webhook payloads, see the OpenAPI Reference.
Base URL
All API requests are made to:
https://api.pdfbolt.com
Authentication
API Key
Use a conversion API key in the API-KEY header for /v1/direct, /v1/sync, /v1/async, /v1/usage, and /v1/tools/* requests.
API-KEY: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Find your conversion API key on the API Credentials page in your Dashboard.
Personal Access Token
Protected Template API requests require a Personal Access Token in the PERSONAL-ACCESS-TOKEN header.
PERSONAL-ACCESS-TOKEN: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Create a Personal Access Token on the API Credentials page in your Dashboard.
GET and HEAD requests to /v1/templates/contract are public and do not require authentication.
Quick Example
Convert a webpage to PDF and save it as webpage.pdf:
curl 'https://api.pdfbolt.com/v1/direct' \
-H 'API-KEY: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{"url": "https://example.com"}' \
-o webpage.pdf
This example converts a URL. You can also use HTML or a template ID with data. See source parameters for all input options.
Endpoints Overview
| Endpoint | Description | Method | Response | Documentation |
|---|---|---|---|---|
/v1/direct | Generates PDFs from URLs, HTML, or templates and returns them in the response. | POST | Raw PDF or Base64-encoded PDF in the HTTP response body. | Direct Parameters Common Parameters |
/v1/sync | Generates PDFs from URLs, HTML, or templates and provides a downloadable URL. | POST | JSON containing a downloadable URL to the generated PDF. | Sync Parameters Common Parameters |
/v1/async | Processes URLs, HTML, or templates and sends results via webhook. | POST | JSON with requestId, plus webhook callback when generation completes. | Async Parameters Common Parameters |
/v1/usage | Returns the current plan, recurring and one-time conversion packages, and remaining conversions. | GET | JSON with plan, recurring, and oneTime conversion details. | Usage Response |
/v1/templates/* | Lists, validates, previews, compares, saves, and publishes reusable templates. | GET / POST | JSON or raw PDF, depending on operation. | Template API |
/v1/tools/* | Merges, compresses, or converts existing PDFs to PDF/X. | POST | PDF in the response body (Direct) or JSON with result metadata (Sync). | PDF Tools |
Response Headers
PDFBolt returns headers that help you track conversion cost, monitor rate limits, and verify async webhooks. When a Conversion API, PDF Tools API, Template API preview, or Template API diff request passes the conversion rate limiter, its response includes the rate-limit headers below. /v1/usage and successful Template API management responses do not include them. Template API management responses with HTTP 429 include Retry-After.
| Header | Applies to | Description |
|---|---|---|
x-pdfbolt-conversion-cost | /v1/direct, /v1/sync, PDF Tools Direct/Sync, Template API preview/diff, and async webhook callbacks | Document credits charged for the request. |
Content-Disposition | Successful /v1/direct and PDF Tools Direct responses | Controls inline vs attachment delivery. Includes filename when provided. |
x-pdfbolt-signature | Async webhook callbacks | HMAC-SHA256 signature of the raw request body, prefixed sha256=. |
x-pdfbolt-limit-minute | Conversion API, PDF Tools API, and Template API preview/diff | Request limit for the current rolling minute. |
x-pdfbolt-remaining-minute | Conversion API, PDF Tools API, and Template API preview/diff | Requests remaining in the current rolling minute. |
x-pdfbolt-limit-hour | Conversion API, PDF Tools API, and Template API preview/diff | Request limit for the current rolling hour. |
x-pdfbolt-remaining-hour | Conversion API, PDF Tools API, and Template API preview/diff | Requests remaining in the current rolling hour. |
x-pdfbolt-limit-day | Conversion API, PDF Tools API, and Template API preview/diff | Request limit for the current rolling 24‑hour window. |
x-pdfbolt-remaining-day | Conversion API, PDF Tools API, and Template API preview/diff | Requests remaining in the current rolling 24‑hour window. |
Retry-After | Template API management responses with HTTP 429 | Number of seconds to wait before retrying the request. |
See Rate Limits for request limits and concurrency rules.
Endpoint Documentation
Read the detailed documentation for each endpoint:
📄️ Direct Conversion
📄️ Sync Conversion
📄️ Async Conversion
📄️ Usage Monitoring
📄️ Template API
📄️ PDF Tools: Merge, Compress, and PDF/X
📄️ OpenAPI Reference
Related Topics
- Error Handling – HTTP status codes, error response format, and recommended actions.
- Rate Limits – Per-plan request limits, concurrency rules, and 429 handling.
- IP Addresses – Static outbound IPs to add to your firewall allowlist.
- Conversion Parameters – Full reference for all PDF generation options.