pdfrest/pdf-api-toolkit repository overview

⁠pdfRest API Toolkit Container

The pdfRest API Toolkit Container⁠ delivers a powerful, containerized REST API for advanced PDF processing. Deploy the container on your own private or public cloud infrastructure to enable secure, scalable PDF operations. With dozens of API Tools⁠ and endpoints to convert, merge, split, compress, OCR, and more, harness the power of pdfRest directly from your backend or web server.

Changelogs for version tags can be found on the Release Notes⁠ documentation page.

⁠Key Features

• Containerized REST API for on-prem or cloud deployments.
• Full PDF Lifecycle: Supports conversion to and from the PDF format, encryption, compression, markdown, digital signatures, OCR, and so much more.
• Secure & Scalable: Keep your documents within your own infrastructure.
• Developer-Friendly: Comprehensive documentation⁠ and GitHub code samples⁠.
• Flexible Licensing: Options for instant self-serve subscriptions or fully offline enterprise solutions.

⁠Getting Started

Standard container deployments require an active License Key for Free Trial testing and Paid subscription plans.

1. Free Trial: New users can sign up for an account⁠ on pdfRest.com to instantly generate a Free Trial License Key and start testing.
2. Self-Serve Subscription: When you are ready to upgrade, our Self-Serve Container Subscriptions⁠ are the fastest way to move into production.
3. Enterprise Solutions: For high-volume needs or fully offline/air-gapped environments that do not require outbound license checks, contact our Enterprise Sales Team⁠.
4. Simple Deployment: Once you have your key, pull the image and run:

docker run --name pdfrest --publish 3000:3000 pdfrest/pdf-api-toolkit:latest

For deployment instructions and configuration details, refer to the Getting Started guide⁠.

⁠API Tools

⁠Convert

Convert to PDF⁠ Convert Word, Excel, PowerPoint, PostScript, HTML, EPS, BMP, TIF, PNG, JPG, EML to PDF
Convert to PDF/X⁠ Optimize for print
Convert to PDF/A⁠ Format PDF for long-term preservation
PDF to Images⁠ Rasterize pages to JPG, BMP, PNG, GIF, TIF
Convert PDF Colors⁠ Apply preset or custom ICC profiles
PDF to Excel⁠ Convert to Excel spreadsheets
PDF to Powerpoint⁠ Convert to PowerPoint files
PDF to Word⁠ Convert to Word documents

⁠Optimize

Rasterize PDF⁠ Flatten each page to rasterized image
Compress PDF⁠ Reduce file size
Linearize PDF⁠ Enable fast web viewing
Flatten Transparencies⁠ Flatten transparent PDF objects
Flatten Annotations⁠ Flatten PDF annotations
Flatten Layers⁠ Merge all PDF layers

⁠Modify

Add to PDF⁠ Insert text, images, or attachments
Merge PDFs⁠ Combine multiple PDFs into one
Split PDF⁠ Split one PDF into multiple
Set Page Boxes⁠ Set Media, Crop, Bleed, Trim, Art

⁠Extract

PDF to Markdown⁠ Transform PDF into structured Markdown
Extract Images⁠ Extract all embedded images from PDF
Extract Text⁠ Extract text from PDF with style and positional data
Query PDF⁠ Retrieve detailed PDF info about content and metadata
OCR PDF⁠ Convert image-based text to searchable, extractable text

⁠Secure

TDM Reserve PDF⁠ Apply machine-readable metadata to reserve rights against AI crawling
Sign PDF⁠ Apply digital signatures to PDF
Redact PDF⁠ Securely remove sensitive info
Watermark PDF⁠ Add text or image watermarks
Encrypt PDF⁠ Add or remove password-protection with AES-256 encryption
Restrict PDF⁠ Set or remove user restrictions, such as print, edit, or copy

⁠Simplify

Upload Files⁠ Upload one or more files from local storage or URLs
Zip Files⁠ Archive multiple files into a single Zip file
Unzip Files⁠ Remove files from Zip for processing

⁠Forms

Flatten Forms⁠ Lock in form data, make forms uneditable, and convert to standard PDF
Import Form Data⁠ Import values into PDF forms
Export Form Data⁠ Export PDF form values to external data file
XFA to Acroforms⁠ Convert PDF forms from Static and Dynamic XFA to Acroforms

⁠Build Powerful PDF Solutions

• Automate and Embed PDF Workflows: Convert, extract, archive, and secure PDFs automatically. Integrate seamlessly into apps to enhance data extraction, form handling, security, and compliance.
• Privacy and Sovereignty: Keep sensitive files behind your own firewall. Perfect for regulated industries (Legal, Finance, Healthcare) requiring strict data residency or GovCloud deployments.
• AI-Powered PDF Task Automation: Integrate with AI technology to simplify and automate complex PDF tasks. For example, pdfAssistant.ai⁠ utilizes the pdfRest API to offer an intelligent assistant that can summarize documents and manipulate PDFs.
• Automate and Optimize PDF Forms: Import and export form data for streamlined processing and integration. Flatten fields for consistent viewing, convert XFA to Acroforms for compatibility, and simplify archiving or printing.

⁠Contact Us

• Contact pdfRest Support⁠ with technical questions related to deploying and configuring the API Toolkit Container.
• Visit our Pricing Page⁠ for self-serve options or contact [email protected]⁠ for Enterprise and high-volume inquiries.