From e15a2e2895c726bec7f996dd36457dcaf063f8e9 Mon Sep 17 00:00:00 2001 From: Eric Shore Date: Tue, 21 Apr 2026 12:02:13 -0500 Subject: [PATCH] Update README.md Update readme to include new AI endpoints along with Python and Docker integration links --- README.md | 100 +++++++++++++++++++----------------------------------- 1 file changed, 34 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index 768ebc98..238807b9 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ ![pdfRest](https://cms.pdfrest.com/content/images/2022/11/pdfRest_logo_tag_750_275_light_bg.png) -[pdfRest.com](https://pdfrest.com/) |  [Get Started](https://pdfrest.com/getstarted/)  |  [API Lab](https://pdfrest.com/apilab/) |  [Explore the Toolkit](https://pdfrest.com/apitools/)  |  [Solutions](https://pdfrest.com/learning/solutions/)  |  [Pricing](https://pdfrest.com/pricing/)  |  [Documentation](https://docs.pdfrest.com/)  |  [Support](https://pdfrest.com/support/) +[pdfRest.com](https://pdfrest.com/) | [Get Started](https://pdfrest.com/getstarted/) | [API Lab](https://pdfrest.com/apilab/) | [Explore the Toolkit](https://pdfrest.com/apitools/) | [Solutions](https://pdfrest.com/learning/solutions/) | [Pricing](https://pdfrest.com/pricing/) | [Documentation](https://docs.pdfrest.com/) | [Support](https://pdfrest.com/support/) -
## pdfRest API Toolkit -pdfRest is a REST API Toolkit for developers with all of the API Tools you'll need to power your PDF processing requirements, designed and documented by PDF experts to make your development work easier than ever. Rapidly integrate PDF capabilities into web applications in minutes, not days. +**pdfRest** is a professional-grade REST API Toolkit designed for developers who need to integrate high-quality PDF processing into web applications. Built on Adobe® technology, it allows you to rapidly deploy PDF capabilities in minutes. -| [Compress PDF](https://pdfrest.com/apitools/compress-pdf/) | [Convert to PDF](https://pdfrest.com/apitools/convert-to-pdf/) | **[Convert to PDF/A](https://pdfrest.com/apitools/convert-to-pdfa/)** | [Convert to PDF/X](https://pdfrest.com/apitools/convert-to-pdfx/) | +| [Compress PDF](https://pdfrest.com/apitools/compress-pdf/) | [Convert to PDF](https://pdfrest.com/apitools/convert-to-pdf/) | [Convert to PDF/A](https://pdfrest.com/apitools/convert-to-pdfa/) | [Convert to PDF/X](https://pdfrest.com/apitools/convert-to-pdfx/) | | :--- | :--- | :--- | :--- | | **[Encrypt PDF](https://pdfrest.com/apitools/encrypt-pdf/)** | **[Restrict PDF](https://pdfrest.com/apitools/restrict-pdf/)** | **[Merge PDFs](https://pdfrest.com/apitools/merge-pdfs/)** | **[Split PDF](https://pdfrest.com/apitools/split-pdf/)** | | **[Decrypt PDF](https://pdfrest.com/apitools/encrypt-pdf/)** | **[Unrestrict PDF](https://pdfrest.com/apitools/restrict-pdf/)** | **[Add to PDF](https://pdfrest.com/apitools/add-to-pdf/)** | **[PDF to Images](https://pdfrest.com/apitools/pdf-to-images/)** | @@ -17,81 +16,50 @@ pdfRest is a REST API Toolkit for developers with all of the API Tools you'll ne | **[Flatten Forms](https://pdfrest.com/apitools/flatten-forms/)** | **[Import Form Data](https://pdfrest.com/apitools/import-form-data/)** | **[Export Form Data](https://pdfrest.com/apitools/export-form-data/)** | **[Extract Text](https://pdfrest.com/apitools/extract-text/)** | | **[PDF to Word](https://pdfrest.com/apitools/pdf-to-word/)** | **[PDF to Excel](https://pdfrest.com/apitools/pdf-to-excel/)** | **[PDF to PowerPoint](https://pdfrest.com/apitools/pdf-to-powerpoint/)** | **[Extract Images](https://pdfrest.com/apitools/extract-images/)** | | **[OCR to PDF](https://pdfrest.com/apitools/ocr-pdf/)** | **[API Polling](https://pdfrest.com/apitools/api-polling/)** | **[Rasterize PDF](https://pdfrest.com/apitools/rasterize-pdf/)** | **[Convert PDF Colors](https://pdfrest.com/apitools/convert-pdf-colors/)** | -| **[Redact PDF](https://pdfrest.com/apitools/redact-pdf/)** | **[PDF to Markdown](https://pdfrest.com/apitools/pdf-to-markdown/)** | **[Sign PDF](https://pdfrest.com/apitools/sign-pdf/)** | | -
+| **[Redact PDF](https://pdfrest.com/apitools/redact-pdf/)** | **[PDF to Markdown](https://pdfrest.com/apitools/pdf-to-markdown/)** | **[Sign PDF](https://pdfrest.com/apitools/sign-pdf/)** | **[Summarize PDF](https://pdfrest.com/apitools/summarize-pdf/)** | +| **[Translate PDF](https://pdfrest.com/apitools/translate-pdf/)** | | | | +--- -Get started quickly with our [API Lab](https://pdfrest.com/apilab/) web app, trust in high quality Adobe® technology, and keep costs to a minimum with the best fit plan for every business application (including a generous free plan). +## Integration Options -
+### Package Managers & Containers +* **Python (PyPI):** Install the [pdfrest package](https://pypi.org/project/pdfrest/) via pip. View the [Python Documentation](https://python.pdfrest.com/). +* **Docker:** Pull images from [pdfRest on Docker Hub](https://hub.docker.com/r/pdfrest/pdf-api-toolkit). +* **Postman:** Fast-track testing with our [Postman Collection](https://www.postman.com/pdfrest). -## Integrate Advanced PDF Solutions +### AI Automation +Connect with AI solutions to automate complex PDF operations. For example, [pdfAssistant.ai](https://pdfassistant.ai/) uses this API to provide an intelligent, chat-based PDF processing interface. -- **Automatic Document Processes:** Improve business workflows by automatically converting received documents to PDF, pulling critical data, managing records for adherence, and beyond. +--- -- **Implement PDF Features in Applications:** Easily integrate pdfRest's abilities within your existing software to provide strong PDF processing features such as optimizing file submissions, obtaining form values, or protecting documents. +## Getting Started -- **Artificial Intelligence for PDF Automation:** Connect with AI solutions to streamline and automate sophisticated PDF operations. For instance, [pdfAssistant.ai](https://pdfassistant.ai/) leverages pdfRest's powerful API to deliver an intelligent assistant that can perform a range of PDF processing actions from a simple, chat-based interface. +1. **Get an API Key:** [Register for a free account](https://pdfrest.com/getstarted/) to receive your key (includes 100 free monthly calls). +2. **Clone this Repo:** Use the code samples in this repository to see how to submit requests programmatically. +3. **Configure Samples:** + * Find the comment: `Place your api key here` + * Replace `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` with your actual key. -
+### Downloading Files +Each directory contains a `get-resource` sample. When you perform a POST call, the API returns a UUID for your file. Replace `xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` in the sample with your specific UUID to download the output. -## Getting Started with Code Samples +### Privacy & File Deletion +To delete sensitive files immediately after processing, edit the sample file and set its local deletion flag to `true`. This is disabled by default. -This GitHub repository provides public access to code examples that demonstrate how to programmatically submit requests to the [pdfRest API Toolkit](https://pdfrest.com/) service. - -Start by [generating a free API Key](https://pdfrest.com/getstarted/), required to run these samples. Create an account with a Starter plan for 100 free API Calls per month. [Plans](https://pdfrest.com/pricing/) scale up from there to support all projects and applications, big and small. - -
- -## Instructions for Running Code Samples - -### Uploading an input file - -POST requests require an API Key. To apply your API Key, you must include it in your requests as a header called `Api-Key`. - -Before running each sample program, look for a comment that reads: - -> `Place your api key here` - -and replace `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` with your API Key. - -### Downloading your output file(s) - -Each subdirectory includes a `get-resource` sample that demonstrates how to download output files. - -When you make a POST call to one of the API endpoints, you will receive back a response that includes an ID reference to each resource, including newly uploaded input files and newly generated output files. These IDs are in the form of a universally unique identifier (UUID). - -Before running this sample program, look for a comment that reads: - -> `place resource uuid here` - -and replace `xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` with the resource UUID you received back from a previous POST request. You may also wish to update the variable containing the output file name before sending your GET request. - -### Optional deletion of sensitive files - -Many language samples include an optional step to delete uploaded or generated files from pdfRest servers (e.g., unredacted, unencrypted, unrestricted, or unwatermarked files). Deletion is off by default. To enable it, edit the sample file and set its local deletion flag to true for that language, for example: - -- JavaScript: `const DELETE_SENSITIVE_FILES = false;` → `true` -- Python: `DELETE_SENSITIVE_FILES = False` → `True` -- PHP: `$DELETE_SENSITIVE_FILES = false;` → `true` -- .NET (C#): `var deleteSensitiveFiles = false;` → `true` -- Java: `final boolean DELETE_SENSITIVE_FILES = false;` → `true` -- cURL: `# DELETE_SENSITIVE_FILES=true` → `DELETE_SENSITIVE_FILES=true` - -Refer to each language README for details. +* JavaScript: Change `const DELETE_SENSITIVE_FILES = false` to `true` +* Python: Change `DELETE_SENSITIVE_FILES = False` to `True` +* PHP: Change `$DELETE_SENSITIVE_FILES = false` to `true` +* .NET (C#): Change `var deleteSensitiveFiles = false` to `true` +* Java: Change `final boolean DELETE_SENSITIVE_FILES = false` to `true` +* cURL: Uncomment `# DELETE_SENSITIVE_FILES=true` +--- ## API Documentation -After you've successfully sent an API Call using these examples, take a look at the [API Reference Guide](https://docs.pdfrest.com/cloud-api-reference/) for a full description of each endpoint and parameters you can adjust to customize your solution. - -
- -## Postman Collection +After you have successfully sent an API Call using these examples, take a look at the [API Reference Guide](https://docs.pdfrest.com/cloud-api-reference/) for a full description of each endpoint and parameters you can adjust to customize your solution. -Use Postman to fast-track your API testing! Check out the pdfRest [Postman Collection](https://www.postman.com/pdfrest) to start sending POST requests with just a few clicks from pre-configured POST requests. - -
+--- ## Support - -If you have any trouble getting started, please reach out to us through our [Support](https://pdfrest.com/support) form, and a member of the pdfRest team will be in touch as soon as possible. +Need help? Contact us through our [Support form](https://pdfrest.com/support) and our team will assist you.