PDF API Endpoints
PDFBolt has three conversion endpoints (Direct, Sync, Async) and one usage endpoint to check your remaining quota.
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
Every request requires the API-KEY header. The same key works for all endpoints – conversion (/v1/direct, /v1/sync, /v1/async) and usage monitoring (/v1/usage).
API-KEY: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Find your API key on the API Keys page in your Dashboard. You can manage up to 5 keys.
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 | Parameters |
|---|---|---|---|---|
/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 plan name, recurring quota, one-time credit packages, and remaining credits. | GET | JSON with plan, recurring, and oneTime credit details. | Usage Response |
Response Headers
PDFBolt returns headers that help you track conversion cost, monitor rate limits, and verify async webhooks. Rate-limit headers are included on all authenticated API responses after rate-limit checks pass.
| Header | Applies to | Description |
|---|---|---|
x-pdfbolt-conversion-cost | /v1/direct, /v1/sync, and async webhook callbacks | Document credits charged for the conversion. Failed conversions return 0. |
Content-Disposition | Successful /v1/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 | All API endpoints | Request limit for the current rolling minute. |
x-pdfbolt-remaining-minute | All API endpoints | Requests remaining in the current rolling minute. |
x-pdfbolt-limit-hour | All API endpoints | Request limit for the current rolling hour. |
x-pdfbolt-remaining-hour | All API endpoints | Requests remaining in the current rolling hour. |
x-pdfbolt-limit-day | All API endpoints | Request limit for the current rolling day. |
x-pdfbolt-remaining-day | All API endpoints | Requests remaining in the current rolling day. |
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
📄️ 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.