GoodPDFTools Developer REST API & API Key Portal
Integrate all 27+ GoodPDFTools features via REST API. Generate your X-API-Key to automate PDF to Excel, Merge PDF, Split PDF, Compress PDF, Edit PDF, OCR, and Sign PDF.
1. REST API Overview & Authentication (X-API-Key Required)
GoodPDFTools provides a high-performance HTTP REST API for all 27+ PDF and Microsoft Office document conversion, editing, merging, splitting, compression, OCR, and security tools. While our interactive web tools remain free in the browser, programmatic API calls to https://goodpdftools.com/api/v1/pdf/* require an API key when you opt to use the REST APIs. Pass your personal key in the X-API-Key: gpdf_live_... request header or as a Bearer token in Authorization: Bearer gpdf_live_....
2. Quick Start Example (cURL & Python)
curl -X POST "https://goodpdftools.com/api/v1/pdf/pdf-to-excel" \
-H "X-API-Key: gpdf_live_your_api_key_here" \
-F "file=@bank_statement.pdf" \
--output statement.xlsx
3. Complete REST API Endpoints Directory
Every endpoint below accepts standard multipart/form-data file uploads over HTTPS and returns the processed document binary or JSON diff payload directly:
- Merge PDF API:
POST /api/v1/pdf/merge— Combine 2 or more PDF documents into a single merged PDF file in exact order. (Web Tool) - Split PDF API:
POST /api/v1/pdf/split— Extract custom page ranges (e.g. "1-3, 5") or split every page into separate PDFs inside a ZIP archive. (Web Tool) - Compress PDF API:
POST /api/v1/pdf/compress— Reduce PDF file size using Low, Medium (Recommended), or Extreme compression profiles. (Web Tool) - PDF to Excel (Bank Statement) API:
POST /api/v1/pdf/pdf-to-excel— Extract bank statements, financial tables, and invoices from PDF into structured Microsoft Excel (.xlsx) workbooks. (Web Tool) - PDF to Word (DOCX) API:
POST /api/v1/pdf/pdf-to-word— Convert PDF documents into editable Microsoft Word (.docx) files preserving paragraphs and tables. (Web Tool) - PDF to PowerPoint (PPTX) API:
POST /api/v1/pdf/pdf-to-powerpoint— Convert PDF pages into editable Microsoft PowerPoint (.pptx) presentation slides. (Web Tool) - Word to PDF API:
POST /api/v1/pdf/word-to-pdf— Convert Microsoft Word (.docx / .doc) documents into print-ready PDF files. (Web Tool) - Excel to PDF API:
POST /api/v1/pdf/excel-to-pdf— Convert Microsoft Excel (.xlsx / .xls) spreadsheets into formatted PDF reports. (Web Tool) - PowerPoint to PDF API:
POST /api/v1/pdf/powerpoint-to-pdf— Convert PowerPoint (.pptx / .ppt) slide decks into high-resolution PDF files. (Web Tool) - Edit PDF Text & Annotations API:
POST /api/v1/pdf/edit-pdf— Programmatically add or replace text on PDF pages at exact X/Y coordinates and font size. (Web Tool) - Sign PDF API:
POST /api/v1/pdf/sign— Apply an electronic signature stamp or image signature onto a PDF document. (Web Tool) - Watermark PDF API:
POST /api/v1/pdf/watermark— Stamp custom diagonal text watermarks across all pages of a PDF. (Web Tool) - Rotate PDF API:
POST /api/v1/pdf/rotate— Rotate all pages in a PDF document by 90, 180, or 270 degrees clockwise. (Web Tool) - Protect PDF (Encrypt) API:
POST /api/v1/pdf/protect— Encrypt a PDF file with 256-bit AES password protection. (Web Tool) - Unlock PDF (Decrypt) API:
POST /api/v1/pdf/unlock— Remove password protection and restrictions from an encrypted PDF file. (Web Tool) - PDF to JPG Images API:
POST /api/v1/pdf/pdf-to-jpg— Render every page of a PDF into high-DPI JPG images packaged as a ZIP archive. (Web Tool) - JPG / Images to PDF API:
POST /api/v1/pdf/jpg-to-pdf— Convert one or more JPG/PNG images into a multi-page PDF document. (Web Tool) - Scan to PDF API:
POST /api/v1/pdf/scan-to-pdf— Combine camera scans or mobile document photos into a clean, standardized PDF. (Web Tool) - Organize PDF Pages API:
POST /api/v1/pdf/organize— Reorder, duplicate, or filter specific pages in a PDF using a comma-separated page order. (Web Tool) - Page Numbers PDF API:
POST /api/v1/pdf/page-numbers— Insert formatted "Page X of Y" numbering across all pages of a PDF. (Web Tool) - PDF to PDF/A (ISO Archival) API:
POST /api/v1/pdf/pdf-to-pdfa— Convert standard PDF files into ISO-compliant long-term archival PDF/A-1b, PDF/A-2b, or PDF/A-3b. (Web Tool) - Repair PDF API:
POST /api/v1/pdf/repair— Rebuild corrupted cross-reference tables and recover readable pages from damaged PDFs. (Web Tool) - HTML to PDF API:
POST /api/v1/pdf/html-to-pdf— Render an HTML file or webpage markup into a clean PDF document. (Web Tool) - OCR PDF (Text Recognition) API:
POST /api/v1/pdf/ocr— Extract searchable machine-readable text from scanned PDFs and documents. (Web Tool) - AI PDF Summarizer API:
POST /api/v1/pdf/ai-summarize— Generate an executive summary and key bullet points from any PDF document. (Web Tool) - Translate PDF API:
POST /api/v1/pdf/translate— Extract and prepare multi-language translated PDF documents. (Web Tool) - Redact PDF API:
POST /api/v1/pdf/redact— Permanently burn opaque black redaction boxes over sensitive regions on PDF pages. (Web Tool) - Crop PDF Margins API:
POST /api/v1/pdf/crop— Trim top, right, bottom, and left page margins across all pages of a PDF. (Web Tool) - Compare PDF Diff API:
POST /api/v1/pdf/compare— Compare two PDF files line-by-line and return a structured JSON diff report. (Web Tool) - Fill & Flatten PDF Forms API:
POST /api/v1/pdf/pdf-forms— Fill interactive AcroForm fields from JSON key-value pairs and optionally flatten the PDF. (Web Tool) - UUID & GUID Generator API:
POST /api/v1/pdf/uuid-generator— Generate bulk cryptographic UUID v4, time-ordered UUID v7, or UUID v1 identifiers in JSON format. (Web Tool) - Minify & Compress JSON API:
POST /api/v1/pdf/minify-json— Validate and minify JSON files or raw JSON strings, stripping whitespace and optionally sorting keys. (Web Tool) - JSON Formatter & Beautifier API:
POST /api/v1/pdf/json-formatter— Pretty-print and format JSON payloads with configurable indentation (2 spaces, 4 spaces) and alphabetical key sorting. (Web Tool) - JSON Validator & Syntax Checker API:
POST /api/v1/pdf/json-validator— Validate JSON payloads against RFC 8259 standards and return key counts, byte size, and syntax diagnostics. (Web Tool) - JSON Compare & Diff API:
POST /api/v1/pdf/json-compare— Compare two JSON objects or files and return added, removed, and modified key diffs. (Web Tool)
4. Rate Limiting, Quotas, Response Headers & Anti-Brute-Force Security
To protect service availability and prevent automated brute-force key guessing or credential stuffing, GoodPDFTools enforces multi-layer rate limits across our Edge Proxy, API Gateway, and Document Engine:
- REST API Quota (
/api/v1/pdf/*): 60 requests per minute per API key (sliding 60-second window) and up to 10 concurrent connections per IP. Exceeding this quota returnsHTTP 429 Too Many Requestswith error codeRATE_LIMIT_EXCEEDED. - Authentication Endpoints (
/auth/*): 15–30 requests per minute per IP address to prevent credential stuffing and automated enumeration. - Anti-Brute-Force IP Lockout: 10 failed authentication or invalid
X-API-Keyattempts within 5 minutes triggers an automatic 15-minute (900 seconds) lockout for that IP address, returningHTTP 429 Too Many Requestswith error codeBRUTE_FORCE_LOCKED. - Rate-Limit Response Headers: Every API response includes
X-RateLimit-Limit(60),X-RateLimit-Remaining, andX-RateLimit-Reset(epoch seconds), plusRetry-AfteronHTTP 429responses. - Authentication & Payload Errors: Requests missing a valid
X-API-Keyheader receiveHTTP 401 Unauthorized(API_KEY_REQUIRED). Invalid multipart parameters returnHTTP 400 Bad Request, and files exceeding the 200 MB payload limit returnHTTP 413 Payload Too Large.