v2.54.1
OpenAPI 3.1.1

pdfRest API Toolkit

Proprietary

Getting Started


Welcome to the pdfRest API Toolkit reference for the Cloud API. This guide provides the information you need to start using pdfRest tools with your API key. If you do not have a key, you can create one for free.

The reference is organized by Tool and its associated endpoint. Most processing endpoints are named for the type of output they generate. For example, send a JPG file to the /pdf endpoint to convert it to a PDF. A successful processing request typically returns a unique resource ID (UUID), which you can use with the /resource/{id} endpoint to retrieve the processed file.


Cloud Deployment


Standard Cloud API - https://api.pdfrest.com

Our Standard Cloud API service is hosted in secure data centers based in the United States. By directing your API calls to our standard root endpoint, https://api.pdfrest.com, you can take advantage of our robust infrastructure designed for high performance and reliability.

EU GDPR Cloud API - https://eu-api.pdfrest.com

For users needing data processing within the European Union to comply with GDPR regulations, we offer a dedicated EU-based backend. By directing your API requests to https://eu-api.pdfrest.com, you ensure that all data is processed and stored in compliance with EU data protection laws.

Please note that additional fees may apply for using the EU GDPR-compliant service. Learn more about how this works.


Integration Options


Python package

Docker


Additional Resources


Public Cloud API

Client Libraries

Upload Files (Collapsed)

Upload files or public file URLs

Upload Files Operations

Retrieve Files (Collapsed)

Retrieve a stored resource by ID

Retrieve Files Operations

Delete Files (Collapsed)

Delete one or more stored resources

Delete Files Operations

Zip Files (Collapsed)

Create or extract ZIP archives

Zip Files Operations

API Polling (Collapsed)

Poll for the status and result of an asynchronous request

API Polling Operations

Convert PDF to Images (Collapsed)

Convert PDF pages to supported image formats

Convert PDF to Images Operations

Convert PDF to Microsoft Excel (Collapsed)

Convert PDF to Microsoft Excel

Convert PDF to Microsoft Excel Operations

Convert PDF to Microsoft PowerPoint (Collapsed)

Convert PDF to Microsoft PowerPoint

Convert PDF to Microsoft PowerPoint Operations

Convert PDF to Microsoft Word (Collapsed)

Convert PDF to Microsoft Word

Convert PDF to Microsoft Word Operations

Convert PDF to PDF/A (Collapsed)

Convert PDF to an archival PDF/A standard

Convert PDF to PDF/A Operations

Convert PDF to PostScript (Collapsed)

Convert PDF pages to PostScript

Convert PDF to PostScript Operations

Convert PDF to PDF/X (Collapsed)

Convert PDF to a print-production PDF/X standard

Convert PDF to PDF/X Operations

Convert to PDF (Collapsed)

Convert supported input files to PDF

Convert to PDF Operations

Compress PDF (Collapsed)

Reduce PDF file size

Compress PDF Operations

Convert PDF Colors (Collapsed)

Convert PDF color spaces

Convert PDF Colors Operations

Flatten Annotations (Collapsed)

Flatten PDF annotations into page content

Flatten Annotations Operations

Flatten Layers (Collapsed)

Flatten PDF layers into page content

Flatten Layers Operations

Flatten Transparencies (Collapsed)

Flatten PDF transparency effects

Flatten Transparencies Operations

Linearize PDF (Collapsed)

Optimize PDF for fast web view

Linearize PDF Operations

Rasterize PDF (Collapsed)

Convert PDF page content to raster images within PDF

Rasterize PDF Operations

Encrypt PDF (Collapsed)

Add or remove PDF open-password encryption

Redact PDF (Collapsed)

Preview and apply permanent PDF text redactions

Restrict PDF (Collapsed)

Add or remove PDF permissions restrictions

Sign PDF (Collapsed)

Apply a digital signature to PDF

Sign PDF Operations

TDM Reserve PDF (Collapsed)

Apply a text and data mining reservation policy to PDF

TDM Reserve PDF Operations

Watermark PDF (Collapsed)

Add a watermark to PDF

Watermark PDF Operations

Convert PDF to Markdown (Collapsed)

Convert PDF content to Markdown

Convert PDF to Markdown Operations

Extract Images (Collapsed)

Extract embedded images from PDF

Extract Images Operations

Extract Text (Collapsed)

Extract text and optional layout information from PDF

Extract Text Operations

OCR PDF (Collapsed)

Add searchable OCR text to PDF

OCR PDF Operations

Query PDF (Collapsed)

Query PDF metadata and document properties

Query PDF Operations

Add to PDF (Collapsed)

Create Blank PDF (Collapsed)

Create a blank PDF document

Create Blank PDF Operations

Merge PDFs (Collapsed)

Merge multiple PDFs into one document

Merge PDFs Operations

Set Page Boxes (Collapsed)

Set PDF page boundaries

Set Page Boxes Operations

Split PDF (Collapsed)

Split PDF into multiple files

Split PDF Operations

Extract Form Data (Collapsed)

Extract form data from PDF

Extract Form Data Operations

Flatten Forms (Collapsed)

Flatten PDF form fields into page content

Flatten Forms Operations

Import Form Data (Collapsed)

Import form data into PDF

Import Form Data Operations

XFA to AcroForms (Collapsed)

Convert XFA forms to AcroForms

XFA to AcroForms Operations

Summarize PDF (Collapsed)

Summarize PDF, Markdown, or plain-text content

Summarize PDF Operations

Translate PDF (Collapsed)

Translate PDF, Markdown, or plain-text content

Translate PDF Operations