PDFox API Documentation

Overview

The PDFox API allows you to programmatically edit, convert, and manage PDF documents. Build powerful document workflows directly into your applications.

API Access:

The PDFox API is currently in development. Join the waitlist below to get early access and be notified when it launches.

API Coming Soon

We're building a powerful API for developers. Sign up to be notified when it's ready.

Join Waitlist

Planned Features

Here's what you'll be able to do with the PDFox API:

Document Operations

Convert PDFs - Transform PDFs to/from Word, images, HTML
Merge PDFs - Combine multiple documents into one
Split PDFs - Extract pages or split by range
Compress PDFs - Reduce file size while maintaining quality
OCR Processing - Extract text from scanned documents

Editing Operations

Add Text - Insert text at specific coordinates
Add Images - Place images on PDF pages
Add Signatures - Apply digital signatures
Fill Forms - Populate PDF form fields programmatically
Redact Content - Remove sensitive information

Metadata & Security

Read/Write Metadata - Access document properties
Password Protection - Add/remove encryption
Watermarks - Add text or image watermarks

API Preview

Get a preview of how the API will work:

Authentication

All API requests require an API key passed in the header:

                    Request Header
                
Authorization: Bearer your_api_key_here
Content-Type: application/json

Base URL

https://api.pdfox.cloud/v1

Rate Limits: API requests will be rate-limited based on your plan. Free tier: 100 requests/day. Pro tier: 10,000 requests/day. Enterprise: Unlimited.

Example Endpoints

Here's a preview of some planned endpoints:

POST /documents/convert

Convert a PDF to another format (DOCX, PNG, HTML, TXT).

Request Body

Parameter	Type	Description
`file` required	file	PDF file to convert (max 50MB)
`format` required	string	Output format: docx, png, html, txt
`pages` optional	string	Page range, e.g., "1-5" or "1,3,5"

Example Request cURL

curl -X POST https://api.pdfox.cloud/v1/documents/convert \
  -H "Authorization: Bearer your_api_key" \
  -F "[email protected]" \
  -F "format=docx"

                            Example Response
                            JSON
                        

{
  "success": true,
  "document_id": "doc_abc123",
  "download_url": "https://api.pdfox.cloud/v1/download/doc_abc123",
  "expires_at": "2026-01-16T12:00:00Z",
  "pages_processed": 5
}
                        

POST /documents/merge

Merge multiple PDF files into a single document.

Example Request cURL

curl -X POST https://api.pdfox.cloud/v1/documents/merge \
  -H "Authorization: Bearer your_api_key" \
  -F "files[][email protected]" \
  -F "files[][email protected]" \
  -F "files[][email protected]"

POST /documents/ocr

Apply OCR to extract text from scanned documents.

Parameter	Type	Description
`file` required	file	PDF file to process
`language` optional	string	Language code (default: "eng")
`output` optional	string	"text" or "searchable_pdf"

POST /documents/add-signature

Add a signature to a PDF document at specified coordinates.

Parameter	Type	Description
`file` required	file	PDF file
`signature` required	file	Signature image (PNG with transparency)
`page` required	integer	Page number (1-indexed)
`x` required	number	X coordinate (points from left)
`y` required	number	Y coordinate (points from bottom)
`width` optional	number	Signature width in points

SDKs & Libraries

Official SDKs will be available for popular programming languages:

🟨

JavaScript

🐍

Python

💎

Ruby

🐘

PHP

☕

Java

🔷

C#

API Documentation