API Docs

Quickstart guides, option references, error codes and live playground.

Quickstart

Register, login, create API key, convert first PDF.

Authentication

JWT for dashboard routes, Basic Auth for convert endpoint.

Convert options

Full request body options and examples.

Error codes

Actionable meanings for every API error code.

Playground

Run real conversion requests from browser.

Webhooks

Configure Paddle subscription lifecycle events.

SDK snippets

Copy-paste snippets for JavaScript, Python and PHP.

1) Create account + API key

POST /v1/auth/register
POST /v1/auth/token
POST /v1/keys

2) Convert HTML to PDF

curl -X POST "https://api.html2pdf.online/v1/convert" \
  -u "sk_live_xxx:" \
  -H "Content-Type: application/json" \
  -d '{"source":"<html><body><h1>Hello</h1></body></html>"}' \
  --output output.pdf

3) Async mode

POST /v1/convert/async
GET /v1/jobs/{job_id}

Error codes

  • invalid_api_key
  • rate_limit_exceeded
  • invalid_source
  • render_timeout
  • render_failed
  • invalid_option