## Endpoint 1: HTML to PDF **Name:** HTML to PDF **Method:** POST **Path:** `/v1/html-to-pdf` **Description:** Convert an HTML string or public URL into a PDF. Supports A4/Letter/Legal page sizes, landscape mode, custom margins, and optional header/footer HTML. Provide exactly one of `html` or `url`. URL fetching blocks private/internal IPs for security. **Request body (application/json):** | Field | Type | Required | Description | |-------|------|----------|-------------| | html | string | one of html/url | HTML content to render | | url | string | one of html/url | Public http(s) URL to render | | page_size | string | no | `A4`, `Letter`, or `Legal` (default: A4) | | landscape | boolean | no | Landscape orientation (default: false) | | margins | object | no | `{top, right, bottom, left}` e.g. `"1cm"` | | header_html | string | no | HTML for page header | | footer_html | string | no | HTML for page footer | | wait_until | string | no | `load`, `domcontentloaded`, or `networkidle` | **Response:** `application/pdf` binary **Example request:** ```json { "html": "

Invoice #1042

Total: $99.00

", "page_size": "A4", "landscape": false, "margins": { "top": "1cm", "right": "1cm", "bottom": "1cm", "left": "1cm" } } ``` **curl:** ```bash curl --request POST \ --url https://simple-pdf-api.p.rapidapi.com/v1/html-to-pdf \ --header 'Content-Type: application/json' \ --header 'X-RapidAPI-Key: YOUR_RAPIDAPI_KEY' \ --header 'X-RapidAPI-Host: simple-pdf-api.p.rapidapi.com' \ --data '{"html":"

Hello

Invoice #1234

"}' \ --output document.pdf ``` **JavaScript:** ```javascript const response = await fetch("https://simple-pdf-api.p.rapidapi.com/v1/html-to-pdf", { method: "POST", headers: { "Content-Type": "application/json", "X-RapidAPI-Key": "YOUR_RAPIDAPI_KEY", "X-RapidAPI-Host": "simple-pdf-api.p.rapidapi.com", }, body: JSON.stringify({ html: "

Invoice

Total: $49.00

", page_size: "A4" }), }); const blob = await response.blob(); ``` **Python:** ```python import requests response = requests.post( "https://simple-pdf-api.p.rapidapi.com/v1/html-to-pdf", headers={ "X-RapidAPI-Key": "YOUR_RAPIDAPI_KEY", "X-RapidAPI-Host": "simple-pdf-api.p.rapidapi.com", }, json={"html": "

Invoice

Total: $99.00

"}, timeout=90, ) response.raise_for_status() with open("document.pdf", "wb") as f: f.write(response.content) ``` --- ## Endpoint 2: Merge PDFs **Name:** Merge PDFs **Method:** POST **Path:** `/v1/merge` **Description:** Combine 2–20 PDF files into a single document. Pass each PDF as a base64-encoded string in order. **Request body:** | Field | Type | Required | Description | |-------|------|----------|-------------| | pdfs_base64 | string[] | yes | Array of base64-encoded PDFs (min 2, max 20) | **Response:** `application/pdf` binary **Example:** ```json { "pdfs_base64": ["JVBERi0xLjQK...", "JVBERi0xLjQK..."] } ``` **curl:** ```bash curl --request POST \ --url https://simple-pdf-api.p.rapidapi.com/v1/merge \ --header 'Content-Type: application/json' \ --header 'X-RapidAPI-Key: YOUR_RAPIDAPI_KEY' \ --header 'X-RapidAPI-Host: simple-pdf-api.p.rapidapi.com' \ --data '{"pdfs_base64":["BASE64_PDF_1","BASE64_PDF_2"]}' \ --output merged.pdf ``` --- ## Endpoint 3: Split PDF **Name:** Split PDF **Method:** POST **Path:** `/v1/split` **Description:** Extract specific pages from a PDF into a new file. Use 1-indexed page ranges like `"1-3"`, `"5"`, or `"7-9"`. **Request body:** | Field | Type | Required | Description | |-------|------|----------|-------------| | pdf_base64 | string | yes | Base64-encoded source PDF | | ranges | string[] | yes | Page ranges, e.g. `["1-3", "5"]` | **Response:** `application/pdf` binary **Example:** ```json { "pdf_base64": "JVBERi0xLjQK...", "ranges": ["1-3", "5"] } ``` --- ## Endpoint 4: Watermark **Name:** Watermark PDF **Method:** POST **Path:** `/v1/watermark` **Description:** Add a text or image watermark to every page. Useful for CONFIDENTIAL, DRAFT, or branding overlays. **Request body:** | Field | Type | Required | Description | |-------|------|----------|-------------| | pdf_base64 | string | yes | Base64-encoded source PDF | | text | string | one of text/image | Watermark text | | image_base64 | string | one of text/image | Base64-encoded PNG/JPG | | opacity | number | no | 0.05–1.0 (default: 0.3) | | rotation | integer | no | Degrees, -180 to 180 (default: 45) | **Response:** `application/pdf` binary **Example:** ```json { "pdf_base64": "JVBERi0xLjQK...", "text": "CONFIDENTIAL", "opacity": 0.3, "rotation": 45 } ``` --- ## Endpoint 5: Compress PDF **Name:** Compress PDF **Method:** POST **Path:** `/v1/compress` **Description:** Reduce PDF file size by removing duplicate and orphaned objects. Useful before emailing or uploading to storage. **Request body:** | Field | Type | Required | Description | |-------|------|----------|-------------| | pdf_base64 | string | yes | Base64-encoded source PDF | **Response:** `application/pdf` binary **Example:** ```json { "pdf_base64": "JVBERi0xLjQK..." } ``` **curl:** ```bash curl --request POST \ --url https://simple-pdf-api.p.rapidapi.com/v1/compress \ --header 'Content-Type: application/json' \ --header 'X-RapidAPI-Key: YOUR_RAPIDAPI_KEY' \ --header 'X-RapidAPI-Host: simple-pdf-api.p.rapidapi.com' \ --data '{"pdf_base64":"BASE64_PDF"}' \ --output compressed.pdf ``` --- ## Endpoint 6: Protect PDF **Name:** Protect PDF **Method:** POST **Path:** `/v1/protect` **Description:** AES password-encrypt a PDF. Set a user password to open the file and an optional owner password for full control. Optionally restrict printing. **Request body:** | Field | Type | Required | Description | |-------|------|----------|-------------| | pdf_base64 | string | yes | Base64-encoded source PDF | | user_password | string | yes | Password required to open the PDF | | owner_password | string | no | Owner password (defaults to user_password) | | allow_printing | boolean | no | Allow printing (default: true) | **Response:** `application/pdf` binary **Example:** ```json { "pdf_base64": "JVBERi0xLjQK...", "user_password": "secret123", "allow_printing": true } ``` **curl:** ```bash curl --request POST \ --url https://simple-pdf-api.p.rapidapi.com/v1/protect \ --header 'Content-Type: application/json' \ --header 'X-RapidAPI-Key: YOUR_RAPIDAPI_KEY' \ --header 'X-RapidAPI-Host: simple-pdf-api.p.rapidapi.com' \ --data '{"pdf_base64":"BASE64_PDF","user_password":"secret123"}' \ --output protected.pdf ``` --- ## Endpoint 7: Rotate PDF **Name:** Rotate PDF **Method:** POST **Path:** `/v1/rotate` **Description:** Rotate all or selected pages by 90, 180, or 270 degrees. Useful for fixing scanned documents with incorrect orientation. **Request body:** | Field | Type | Required | Description | |-------|------|----------|-------------| | pdf_base64 | string | yes | Base64-encoded source PDF | | degrees | integer | yes | `90`, `180`, or `270` | | pages | integer[] | no | 1-indexed page numbers to rotate. Omit to rotate all pages. | **Response:** `application/pdf` binary **Example:** ```json { "pdf_base64": "JVBERi0xLjQK...", "degrees": 90, "pages": [1, 3] } ``` **curl:** ```bash curl --request POST \ --url https://simple-pdf-api.p.rapidapi.com/v1/rotate \ --header 'Content-Type: application/json' \ --header 'X-RapidAPI-Key: YOUR_RAPIDAPI_KEY' \ --header 'X-RapidAPI-Host: simple-pdf-api.p.rapidapi.com' \ --data '{"pdf_base64":"BASE64_PDF","degrees":90}' \ --output rotated.pdf ``` --- ## Endpoint 8: Extract Text **Name:** Extract Text **Method:** POST **Path:** `/v1/extract-text` **Description:** Extract plain text from a PDF. Optionally limit to specific 1-indexed page numbers. **Request body:** | Field | Type | Required | Description | |-------|------|----------|-------------| | pdf_base64 | string | yes | Base64-encoded source PDF | | pages | integer[] | no | Page numbers to extract (default: all) | **Response:** `application/json` **Example response:** ```json { "text": "Invoice #1042\nTotal: $99.00", "page_count": 2, "pages_extracted": [1, 2] } ``` --- ## FAQ **Q: HTML or URL?** A: Use `html` for dynamic templates you generate server-side. Use `url` to render an existing public web page. **Q: Does it support CSS?** A: Yes. Rendering uses headless Chromium, so modern CSS, flexbox, and print styles work. **Q: Are private/internal URLs allowed?** A: No. URL fetching blocks localhost and private IP ranges (SSRF protection). **Q: Max file size?** A: HTML input up to 2 MB. PDF inputs up to 25 MB per file. Merge supports up to 20 files. **Q: What about encrypted PDFs?** A: Encrypted/password-protected PDFs are not supported as input for merge, split, watermark, compress, rotate, or extract. Use `/v1/protect` to encrypt a PDF you already have. **Q: How much does compress actually reduce file size?** A: Results vary by PDF. Documents with repeated embedded fonts or images typically see 10–40% reduction. Already-optimised PDFs may see little change. **Q: Can I protect a PDF and restrict copying?** A: Currently the API controls printing permissions. Copy/paste restriction is not supported.