When to Use

User needs to call PDF API Hub endpoints (pdfapihub.com/api/v1/...) for document automation: generating PDFs from HTML/URLs, merging, splitting, compressing, OCR, watermarking, signing, encrypting/decrypting, converting between PDF and images, parsing/extracting text and tables, or managing uploaded files.

Scope

This skill ONLY:

• Provides endpoint reference, request/response contracts, and integration patterns for the PDF API Hub REST API
• Shows code examples in multiple languages (cURL, Python, Node.js, etc.)
• Explains authentication, error handling, and output format options

This skill NEVER:

• Executes API calls or generates files directly
• Stores or transmits API keys
• Accesses files outside the user's working directory

All code examples are reference patterns for the user to implement.

Quick Reference

Authentication

Every request requires the CLIENT-API-KEY header.

CLIENT-API-KEY: <your-api-key>
Content-Type: application/json

Get your API key at pdfapihub.com/signup.

Base URL

https://pdfapihub.com/api/v1/

All endpoints use POST with JSON body.

Endpoint Map

Output Formats

Most endpoints support the output_format parameter:

Error Handling

Common Response Shape

{
  "success": true,
  "pdf_url": "https://cdn.pdfapihub.com/pdf/a1b2c3d4.pdf",
  "file_size_bytes": 84321,
  "file_deletion_date": "2026-05-04",
  "source_type": "html"
}

Core Rules

1. Always Set output_format Explicitly

{ "output_format": "url" }

Don't rely on defaults — be explicit about whether you need a URL, file, or base64.

2. Use html_content for Dynamic Documents

{
  "html_content": "<h1>Invoice #{{number}}</h1>",
  "css_content": "h1 { color: #333; }",
  "dynamic_params": { "number": "INV-001" }
}

3. Use url for Webpage Capture

{
  "url": "https://example.com/report",
  "wait_until": "networkidle",
  "paper_size": "A4"
}

4. Handle Files via URL or Upload

For endpoints that operate on existing PDFs (merge, split, compress, etc.), provide files via:

• Direct URL to the PDF
• Previously uploaded file reference via the Upload File endpoint

5. Validate Responses

Always check success: true in the response before using the result.

Common Traps

Security & Privacy

• All API calls go to pdfapihub.com over HTTPS
• API keys should be stored in environment variables, never hardcoded
• Files hosted on CDN have an expiration date — download promptly
• This skill provides reference patterns only; it does not execute code or store credentials

Feedback

• Full docs: pdfapihub.com/docs
• Get API key: pdfapihub.com/signup