pdfRest API Toolkit Python SDK

Welcome to the docs for pdfrest, a Python client for pdfRest.

What is pdfRest?

pdfRest is a cloud PDF processing platform that provides REST APIs for common document workflows such as conversion, compression, OCR, merge/split, and redaction. You send API requests to the pdfRest service, and pdfRest returns structured responses and processed file outputs.

Useful references:

How this Python API relates to pdfRest

This repository provides the official Python SDK layer for calling pdfRest endpoints from Python applications.

The SDK:

Targets the pdfRest API host (https://api.pdfrest.com) by default.
Exposes both sync and async clients (PdfRestClient and AsyncPdfRestClient).
Provides typed request/response models and validation to make integrations safer and easier to maintain.
Includes endpoint helpers that map Python method calls to pdfRest API routes.

In short: pdfRest is the hosted API service, and this package is the Python developer interface for using that service in your code.

Ways to run pdfRest

The pdfRest docs describe three deployment options:

Cloud: fastest path with pdfRest-managed infrastructure at api.pdfrest.com.
On AWS: self-hosted deployment in your AWS environment (AMI or CloudFormation).
Container: self-hosted Docker/Kubernetes deployment for private cloud or on-prem.

For this SDK, the integration surface stays consistent across all three:

Use the default client settings for Cloud.
Point the client base_url at your deployed endpoint for AWS or Container.
Keep using the same Python methods and payload models; only deployment configuration changes.

Reference: