Pdftools Documentation

Technical documentation of the main Pdftools products, such as Pdftools SDK, Conversion Service, PDF Viewer SDK, and other legacy SDKs and products. This documentation also includes links to various API references and resources.

This file contains links to documentation sections following the llmstxt.org standard.

Table of Contents

• Conversion Service: The Conversion Service lets you automate document processes, taking input files in multiple formats and transforming them into standard PDF and PDF...
• Conversion Service API references: Learn about the Conversion Service APIs and how to use them.
• Add data to job: Add data such as documents, images, and other
• Advanced API: Gain fine-grained control over the conversion process, letting you convert many documents in bulk and check their status during the conversion proc...
• Cancel job: Cancel the processing of a job.
• Create new job: Create a new job for processing using the provided workflow and profile. To get a full list of available workflows, call the [List available wo...
• Delete job: When the job processing is completed, delete the job and all associated resources using deleteJob API request.
• Get job info: Get job info.
• Get job result data: Get result data, typically a document, of a job that has completed successfully.
• Get job result: This request returns the result when it is available and is blocked otherwise. You can also call the getJobInfo API request until
• Get the service status: Get the service status.
• List all jobs: List all jobs and their statuses.
• List available workflows: List available workflows.
• Start job: Signal that all data was added to a job and the Conversion Service API can start processing it.
• Store job result data: Store the result data by sending it to a web server via HTTP(S) request.
• Archive PDF/A-2: Convert documents to the PDF/A-2 archival standard using the Simple API.
• Archive PDF/A-3: Convert documents to the PDF/A-3 archival standard using the Simple API.
• All to PDF Profile: Convert any supported input document into a standard PDF using the Simple API.
• Merge Profile: Merge multiple documents into a single PDF dossier using the Simple API.
• Ready for Email PDF/A-2: Convert documents to PDF/A-2 optimized for email using the Simple API.
• Ready for Web PDF/A-2: Convert documents to PDF/A-2 optimized for web viewing using the Simple API.
• Ready to Print PDF/A-2: Convert documents to PDF/A-2 optimized for printing using the Simple API.
• Repair Profile: Convert, validate, and repair documents to PDF using the Simple API.
• REST input JSON: Submit files for conversion using structured JSON input. Upload documents using a URL or in Base64-encoded format. This endpoint supports structure...
• REST input plain HTTP: Submit a file for conversion using a binary upload. This endpoint supports large files (larger than 100 MB). Provide the file as `multipart/form-da...
• Simple API: Process files in one API call. Convert documents individually with a blocking call until the API delivers the converted files. Implement the Conver...
• Configure the Conversion Service: Learn how to configure the Conversion Service to convert documents to PDF and PDF/A output.
• Configure connections: Integrate the Conversion Service into your environment by connecting input sources (for example a watched folder) to output destinations (for examp...
• Set up the service in your Docker container: This page explains how to set up the Conversion Service in a Docker container to automate document conversion.
• Configure emails: You can customize how email files are processed using the Conversion Service Configurator.
• Configure job and document options: You can set up custom options in the Configurator that let you override specific profile settings for jobs or specific documents when you run a wor...
• Conversion Service on OpenShift: Learn how to configure and deploy the Conversion Service on OpenShift.
• Configure Conversion Service plugins: This page explains how to use plugins in the Conversion Service to extend the service with custom workflows.
• Configure profiles in Docker: This page explains how to use profiles to customize your Conversion Service workflows and change the settings used for the document conversion proc...
• Configure profiles: This page explains how to customize the Conversion Service settings for a specific workflow to automate document conversion.
• Configure digital signature: Learn how to set up digital signatures with various online and offline signature providers.
• Cryptographic providers: Learn how to set up digital signatures in the Conversion Service.
• Windows signature: Learn how to configure Windows cryptographic provider.
• GlobalSign Digital Signing Service: Learn how to configure GlobalSign cryptographic provider.
• PKCS#11: Learn how to configure PKCS#11 cryptographic provider.
• Swisscom All-in Signing Service: Learn how to configure Swisscom cryptographic provider.
• Configure stamps and annotations: You can add a barcode, image, and text stamp and annotation to pages of the output documents using the Conversion Service Configurator.
• Set up using the Configurator: This page explains how to set up the Conversion Service to automate document conversion.
• How the Conversion Service works: Learn how the Pdftools Conversion Service processes input files in image, PDF, and office formats and converts them into PDF and PDF/A output suita...
• Configure OCR: Configure various options of the Pdftools OCR Service.
• Legacy 3-Heights® OCR Service: Learn about the 3-Heights® OCR Service.
• Legacy OCR using your own ABBYY license key: Configure and use optical character recognition (OCR) in Conversion Service.
• Convert Microsoft Office files: Learn how to convert Word, Excel, and PowerPoint files to PDF using the Standard Converter, a local Microsoft Office installation, or the Office fo...
• Troubleshooting Microsoft Office file conversion: Learn how to troubleshoot Microsoft Office file conversion issues.
• Configure conversion of redlined Microsoft Word documents: Learn how to set up the Conversion Service to convert Microsoft Word documents with tracked changes (revisions, also called redlining) to PDF.
• Get started with the Conversion Service: This page is a navigation crossroad for getting started guides with either Windows Server or Docker.
• Conversion Service APIs overview: Learn about the Conversion Service APIs and how to use them.
• Get started with Advanced API: Learn how to convert files with the Conversion Service Advanced API.
• Get started with Simple API: Learn how to convert files using the Conversion Service Simple API.
• Conversion Service in Docker: Learn how to run and configure the Conversion Service in Docker.
• Conversion Service on IONOS Cloud: Learn how to deploy and run Conversion Service on IONOS Cloud using Windows virtual machines or Managed Kubernetes.
• Conversion Service on Windows Server: Learn how to install and use the Conversion Service on Windows Server to automate document processes.
• Integrate the Conversion Service: This page describes how you can integrate the Conversion Service with your existing applications. You can integrate using watched folders, a shell ...
• Connectors: Use the Conversion Service to directly integrate with various document sources like local folders, mail servers, and web services.
• Email connectors: Integrate the Conversion Service with a mail server as part of your automated document conversion process. You can set up the service to send an au...
• Docker Email connectors: Integrate the Docker container Conversion Service with a mail server as part of your automated document conversion process. You can set up the serv...
• Windows Email connectors: Integrate the Conversion Service with a mail server as part of your automated document conversion process. You can set up the service to send an au...
• Folder connectors: Integrate the Conversion Service with the local file system, allowing you to convert all files dropped in a specific folder to PDF format, for exam...
• Action connectors: Use the execute command connector in the Conversion Service to implement a custom output connector.
• REST connectors: Learn how to use the REST connectors in the Conversion Service to automatically convert all files sent to a URL and send the results to a configura...
• REST input (Simple API): Learn how to use the REST connectors in the Conversion Service to automatically convert all files sent to a URL.
• REST output: Learn how to send all converted files to a configurable URL.
• PDF Client for Conversion Service: Learn how you can use the PDF client to convert files to PDF, dragging and dropping the files you want to convert to the conversion window.
• Integrate through Advanced API: Learn how you can use a REST API (Conversion Service Advanced API) to directly schedule and manage the jobs of the Conversion Service with greater ...
• Integrate via shell client (CLI): This page explains how you can use a shell client application to interact with the Conversion Service as part of your document conversion process.
• Migrating from 3-Heights® Document Converter: This guide explains how to migrate from the 3-Heights® Document Converter to the Conversion Service.
• Errors and warnings: Learn about the differences in error and warning handling between the Conversion Service and the 3-Heights® Document Converter.
• Installation and configuration: This page explains differences in the installation and configuration for the Conversion Service.
• Command Line client: This page explains the differences between the CLI client for the Conversion Service and the 3-­Heights® Document Converter.
• Integrate with the Conversion Service: Compare integration options between the Conversion Service and the 3-Heights® Document Converter, including REST API, watched folders, and client a...
• Office and Windows File Explorer integration: This page explains how to integrate with Microsoft Office applications in the Conversion Service.
• Watched Folders: This page explains how to migrate Watched Folders to the Conversion Service
• Watched Mail Folders: This page explains the differences between Watched Mailboxes in the Conversion Service and the 3-­Heights® Document Converter.
• Job and document processing options: Find equivalent Conversion Service settings for application, job, and document processing options when migrating from the 3-Heights® Document Conve...
• Nested files and attachments: This page explains the differences in how nested files are handled in the Conversion Service and the 3-Heights® Document Converter
• 3-Heights® OCR Service: This page explains how to use your existing 3-Heights® PDF OCR service with the Conversion Service
• Overview: This page explains the key differences between the Conversion Service and the 3-Heights® Document Converter.
• PDF/A and conformance: Learn how PDF/A output documents and conformance levels are handled in the Conversion Service, and find equivalent settings from the 3-Heights® Doc...
• Stamping: This page explains the differences between stamping in the Conversion Service and the 3-Heights® Document Converter.
• Monitor the service: This page describes how you can monitor the status and performance of the Conversion Service.
• Health & Activity: This page describes how you can view the status of the Conversion Service.
• OpenTelemetry (OTLP): Export traces, logs, and metrics from the Conversion Service using OpenTelemetry Protocol (OTLP).
• Service log: This page explains how you can use the service logs created in the Conversion Service to troubleshoot any issues with the service.
• Statistics: This page explains how you can track the performance of the Conversion Service over a period of time.
• Conversion Service release notes: Functional changes, updates, and bug fixes in various versions of the Conversion Service.
• Update Conversion Service: This page explains how to update the Conversion Service to the latest version.
• Update Conversion Service in Docker: Learn how to update the Conversion Service to the latest version in Docker.
• Update Conversion Service on Windows Server: Learn how to update the Conversion Service to the latest version on Windows Server.
• Workflows: Learn how to automate the conversion of specific file formats to PDF, TIFF, or PDF/A through the Conversion Service workflows (Convert to PDF, Crea...
• Convert to PDF workflow: This page explains how you can use the Convert to PDF workflow in the Conversion Service to automatically convert images, documents, presentations ...
• Convert to XML workflow: Learn how to automatically extract text data from documents, images, and office files as XML using the Convert to XML workflow in the Conversion Se...
• Create Dossier PDF workflow: Learn how you can use the Create Dossier PDF workflow in the Conversion Service to assemble several PDF documents into a single PDF dossier with ex...
• Error and event codes: Reference for all error and event codes returned by the Conversion Service during workflow processing, including descriptions and applicable file f...
• Extract XML from PDF workflow: Learn how to extract XML information related to OCR data from PDFs in the Conversion Service.
• Prepare Invoice PDF workflow: Learn how you can use the Prepare Invoice PDF workflow in the Conversion Service to automate the conversion of invoices to PDF/A-3 format.
• Metadata in workflows: Learn how to customize the metadata of the converted PDFs in all workflows.
• Archive as PDF/A-1 workflow: This page explains how to use the Archive as PDF/A-1 workflow in the Conversion Service to automatically convert documents, images and Office files...
• Archive as PDF/A-2 workflow: This page explains how to use the Archive as PDF/A-2 workflow in the Conversion Service to automatically convert documents, images and Office files...
• Archive as PDF/A-3 workflow: This page explains how to use the Archive as PDF/A-3 workflow in the Conversion Service to automatically convert documents, images and Office files...
• Sign PDF workflow: Learn about how to use the Sign PDF workflow in the Conversion Service to automate signing of documents.
• Stamp and annotation: Learn how you can add text and image stamps, as well as barcodes to PDF documents as part of your document conversion process in the Conversion Ser...
• Archive as TIFF workflow: Learn how to automatically convert documents, images, and office files to TIFF format suitable for archiving using the Archive as TIFF workflow in ...
• PDF information: Essential information about PDF standards, specifications, and digital signatures to help you understand and work with PDF documents.
• Digital signature basics: Learn about electronic signatures and their subtype digital signatures. Find out about public key infrastructure, certificate authorities, and elec...
• PDF/A specification: This page explains what the PDF/A specification is, the versions available, and the differences between the versions.
• PDF standards: This page explains what PDF is and the various international standards that govern the format.
• Licenses of Pdftools products: Learn about license keys for Pdftools products including the Pdftools SDK, Toolbox add-on, Conversion Service, and PDF Viewer SDK.
• Pdftools Licensing Service: This page provides details about Pdftools Licensing Service, Pdftools Licensing Gateway
• Containerized mode: Learn how to run and configure the Licensing Gateway Service in connected mode or full offline mode in Docker.
• Connected mode: Learn how to configure partial offline license key validation, which enables the system to remain operational without a network connection for vary...
• Full offline mode: Learn how to configure fully offline license key validation for at least three months or more.
• Configure SSL: Learn how to configure the Pdftools Licensing Gateway Service (LGS) to use the SSL and create HTTPS communication for your license key validation.
• Pdftools Portal: Manage licenses, users, and notifications in the Pdftools Portal.
• 3-Heights SDK product licensing: Overview of 3-Heights SDK licenses.
• Conversion Service licensing: This page explains the licensing infrastructure of the Conversion Service.
• Pdftools OCR Service licensing: Learn how to set up the Pdftools OCR Service license.
• PDF Toolbox SDK licensing: Overview of the PDF Toolbox SDK.
• Pdftools SDK license management: Learn how to manage a license to use the Pdftools SDK and the Pdftools SDK Shell Tool.
• AI Smart Redact licensing: Learn how to set up and configure your AI Smart Redact license.
• Toolbox add-on license management: Learn how to manage a license to use the Toolbox add-on.
• PDF Viewer SDK licensing: Overview of the PDF Viewer SDK license.
• Pdftools OCR Service: Learn how to use and configure optical character recognition to extract text from images and scanned documents, transforming them into searchable a...
• Get started with the Pdftools OCR Service: Get started with Pdftools OCR Service on Windows or Docker.
• OCR Service in Docker: Learn how to run and configure the Pdftools OCR Service in Docker.
• Get started with Pdftools OCR Service on Windows: Learn how to set up Pdftools OCR Service on Windows with Conversion Service or with Pdftools SDK.
• Set up Pdftools OCR Service with Conversion Service: Install Pdftools OCR Service on Windows and enable it in Conversion Service.
• Set up Pdftools OCR Service with Pdftools SDK: Install Pdftools OCR Service on Windows and apply OCR to a PDF programmatically with Pdftools SDK.
• Configure: Configure various options of the Pdftools OCR Service.
• Monitor Pdftools OCR Service: Learn how to monitor the Pdftools OCR Service programmatically.
• Work with profiles: Fine-tune the OCR engine using various parameters.
• Scale Pdftools OCR Service: Learn how to scale the Pdftools OCR Service.
• Update Pdftools OCR Service: Learn how to update the Pdftools OCR Service to a newer version.
• Pdftools OCR Service references: Configuration options for the Pdftools OCR Service.
• Supported languages: Configuration options for the Pdftools OCR Service.
• Parameters: Pdftools OCR Service parameters configuration options.
• Custom profiles: Create custom INI-format profiles to adjust preprocessing, recognition, synthesis, and other OCR processing parameters.
• [BarcodeParams] INI file section: Configure how to detect, decode, and customize the interpretation of various barcode types.
• [DocumentProcessingParams] INI file section: Specifies if document synthesis is performed.
• [DocumentStructureDetectionParams] INI file section: Configure document structure detection parameters including headlines, footnotes, table of contents, columns, and other structural elements.
• [FontFormattingDetectionParams] INI file section: Detect font formatting and typographic attributes such as bold, italics, font family, size, and spacing during OCR text synthesis.
• [ImageProcessingParams] INI file section: Control how the OCR engine transforms individual image blocks before recognition by adjusting their rotation, mirroring, or color inversion.
• [ObjectsExtractionParams] INI file section: Control how the Pdftools OCR Service processes visual objects, noise, and embedded or low-quality text from scanned documents.
• [PageAnalysisParams] INI file section: Set how the Pdftools OCR Service analyzes page content during layout analysis, including detection of text, tables, images, barcodes, and layout st...
• [PagePreprocessingParams] INI file section: Configure OCR image preprocessing, including options for correcting image orientation, skew, geometry, resolution, binarization, and background whi...
• [PageProcessingParams] INI file section: Main configuration options for preprocessing, layout analysis, and recognition.
• [PrepareImageMode] INI file section: Configure how images are prepared before OCR processing, including compression, document type, image source type, and free text annotation handling.
• [RecognizerParams] INI file section: Control OCR language, text types, performance, and fine-tuning options used by the Pdftools OCR Service during text recognition.
• [SortingBlocksParams] INI file section: Configure how layout blocks are grouped by proximity when determining reading order during OCR processing.
• [SynthesisParamsForDocument] INI file section: Control document synthesis, including structure detection, font formatting, and memory optimization during OCR processing.
• [SynthesisParamsForPage] INI file section: Define page-level synthesis settings for paragraph structure, font formatting, link detection, and color detection.
• [TableAnalysisParams] INI file section: Define how the Pdftools OCR Service analyzes and interprets table structures during document processing.
• [TextLayerInjectionParams] INI file section: Configure parameters for creating a searchable PDF with text layer injection, including PDF/A compliance and image correction settings.
• Pdftools OCR Service release notes: Learn about new updates in the OCR Service, including new features, improvements, and bug fixes.
• Pdftools SDK overview: The Pdftools SDK lets developers integrate advanced PDF manipulation, optimization, and validation functionalities into in-house applications. Lear...
• API references and technical notes: Links to API references and technical notes.
• Technical notes: Links to various technical notes
• C technical notes: Technical details about Pdftools SDK for C.
• .NET technical notes: Specifics of the .NET interface of the Pdftools SDK.
• General technical notes: Technical details about Pdftools SDK for all programming languages.
• Java technical notes: Technical details of the Pdftools SDK for Java.
• Pdftools SDK code samples: The code samples in Java, .NET, C, and Python for the Pdftools SDK help you to start using the library for advanced PDF manipulation, optimization,...
• Getting started with the Pdftools SDK: Learn to get up and running with the Pdftools SDK and the Pdftools SDK Shell Tool.
• Getting started with the Pdftools SDK: Get up and running with the Pdftools SDK to integrate advanced PDF optimization, validation, and manipulation functionalities into your in-house ap...
• Get started with C: Learn how to work with samples and integrate the Pdftools SDK using C.
• Get started with .NET: Learn how to work with samples and integrate the Pdftools SDK using .NET.
• Get started with Java: Learn how to work with samples and integrate the Pdftools SDK using Java.
• Get started with other programming languages: Learn how to use interface binding to support Go or other programming languages with the Pdftools SDK.
• Get started with Python: Learn how to use interface binding to use Python with the Pdftools SDK.
• Pdftools SDK Shell Tool: Use the Pdftools SDK from the command line.
• Guides: Explore guides for the Pdftools SDK covering conversion, optimization, validation, signing, and more.
• Archive with the Pdftools SDK: Learn how to archive PDFs to PDF/A files by using the Pdftools SDK.
• Archive an image to an accessible PDF: Learn how to archive an image to a PDF/A document with A-level conformance. Valid PDF/A documents with A-level conformance require text that can be...
• Archive a PDF document to PDF/A: Learn how to convert a PDF file to a defined PDF/A standard and conformance level. The PDF/A conversion process applies the minimum changes require...
• Archive PDF document to TIFF image archive: Learn how to convert a PDF document to an image. The Pdftools SDK supports output files in TIFF, JPEG and PNG image formats. Default conversion pro...
• Merge and split PDF documents: Learn how to merge and split documents, and how you can use the Pdftools SDK to assemble your PDFs.
• Merge PDF documents: Learn how to merge multiple PDF documents into a single document, such as for converting a portfolio of documents uploaded by a customer into a sin...
• Split PDF document: Learn how to split a single PDF document into multiple output documents and images, such as for generating multiple customer invoices from a single...
• Convert with the Pdftools SDK: Learn how to convert images to PDF, and convert PDFs to image format.
• Conversion profiles: Learn about conversion profiles, and how they are used when converting PDF documents to images, and images to PDF documents. Each conversion profil...
• Convert an image to a PDF document: Learn to convert an image to a PDF document. The Pdftools SDK supports the conversion of images in TIFF, JPEG, BMP, GIF, PNG, JBIG2, and JPEG2000 f...
• Convert a PDF document to an image: Learn how to convert a PDF document to an image. The Pdftools SDK supports output files in TIFF, JPEG and PNG image formats. Default conversion pro...
• Embed e-invoice: Learn how to embed e-invoices such as ZUGFeRD or Factur-X into PDF files, ensuring compliance with international e-invoicing standards. This guide ...
• OCR with Pdftools SDK: Learn how to use OCR to make scanned PDFs searchable programmatically, fix non-extractable text, and add accessibility tagging with Pdftools SDK.
• OCR a PDF document: Apply OCR to a PDF document to make scanned content searchable and text extractable using Pdftools SDK.
• OCR best practices: Optimize OCR performance, manage resources, and handle thread safety when using OCR in Pdftools SDK.
• OCR a PDF with the Shell Tool: Apply OCR to a PDF document from the command line with Pdftools SDK Shell Tool to make scanned content searchable and text extractable.
• Compress and optimize PDF documents: Learn about PDF optimization, why you need to optimize PDF documents, and how to use the Pdftools SDK to optimize your PDFs.
• Optimization profiles: Learn about optimization profiles and how the Pdftools SDK uses them to optimize PDF documents for web, print, archive, and minimal file size.
• Compress and optimize a PDF document: Learn to optimize a PDF document for a specific purpose, such as for viewing in a web browser, reducing file size, or using in long-term archiving....
• Sign and secure PDF documents: Learn about the security (encryption) and digital signature capabilities of the Pdftools SDK.
• Secure PDF documents: Learn about encryption, its limitations in PDF documents, and how to encrypt PDF documents with the Pdftools SDK.
• Encrypt and decrypt a PDF document: Learn to use the Pdftools SDK to open and save encrypted PDF documents.
• Encryption in PDF documents: Learn how encryption is handled in PDF documents.
• Sign PDF documents: Sign PDF documents with the Pdftools SDK. Create, manage, and validate digital signatures using local and online cryptographic providers.
• Set up digital signing for Pdftools SDK: Configure HTTPS connections, set up a proxy, and store local certificates for creating digital signatures with the Pdftools SDK.
• Cryptographic providers: Cryptographic providers supported by the Pdftools SDK, including the built-in provider, PKCS#11, and online signing services.
• Embed long-term validation (LTV) information: Embed long-term validation information when digitally signing PDF documents with the Pdftools SDK.
• Built-in cryptographic provider: Use the built-in cryptographic provider with the Pdftools SDK. The built-in provider uses the cryptographic functions of the local operating system...
• GlobalSign cryptographic provider: Use the GlobalSign cryptographic provider with the Pdftools SDK. The GlobalSign provider enables access to the GlobalSign Digital Signing Service t...
• PKCS#11 cryptographic provider: Use the PKCS#11 cryptographic provider with the Pdftools SDK. The PKCS#11 provider enables access to a cryptographic device using a PKCS#11 driver ...
• Swisscom cryptographic provider: Use the Swisscom cryptographic provider with the Pdftools SDK. The Swisscom provider enables access to the Swisscom Signing Service to perform cryp...
• Certify a PDF document: Digitally certify a PDF document with the Pdftools SDK. This type of signature records the identity of the document author, and allows users to mak...
• Sign a PDF document: Digitally sign a PDF document with the Pdftools SDK. This type of digital signature records the identity of the signer, and confirms that the conte...
• Add a document time-stamp: Add a time-stamp to a PDF document with the Pdftools SDK. This type of digital signature provides evidence that a document existed at a specific ti...
• Validate signatures in a signed PDF document: Validate signatures in a digitally signed PDF document. Confirm the validity of signing certificates by referencing offline and online sources such...
• Create a signature visual appearance: Create a signature with a visual appearance on a page of a PDF, or set a visual appearance on an existing signature field before signing.
• Use a time-stamp authority: Learn how to use a time-stamp authority (TSA) to create digital document timestamps with the Pdftools SDK.
• Validate PDF documents: Validate PDF documents with the Pdftools SDK. Check conformance to PDF/A, PDF/UA, and other standards.
• Conformance levels: Conformance levels for PDF/A and PDF/UA standards, and which levels can be validated with the Pdftools SDK.
• Reporting levels for validation: Learn how to configure validation reporting levels in the Pdftools SDK.
• Validate PDF document: Learn to validate that a PDF file conforms to a specified PDF version, or a PDF/A standard and level. The result is a report that indicates all obj...
• Validation checks: Lexical, syntactic, and semantic validation checks performed by the Pdftools SDK, organized by specification type.
• Migrate from version 1.14 or earlier: Update your Java project setup when migrating from Pdftools SDK 1.14 or earlier to version 1.15+.
• Release notes: Changes, additions and fixes of the Pdftools SDK and the Pdftools SDK Shell Tool.
• Pdftools SDK technical specifications: Learn about requirements, supported CPU architectures, supported languages and frameworks, and about supported operating systems.
• PDF Viewer SDK: The PDF Viewer SDK lets developers integrate PDF viewing and editing functionality into web applications.
• PDF Viewer SDK architecture: Get an overview of the PDF Viewer SDK architecture.
• Customize the PDF Viewer SDK: Learn how to customize the PDF Viewer SDK.
• Getting started with the PDF Viewer SDK: Get started with and set up the PDF Viewer SDK.
• Custom implementation guides: Learn about various advanced functionalities of the PDF Viewer SDK.
• Manage annotations in PDF: Learn how to add, modify, and delete annotations in a PDF document with the PDF Viewer SDK.
• Create custom plugins: Learn how to create and integrate custom plugins to extend the PDF Viewer SDK functionality.
• Read PDF information: Learn how to read information from a PDF document with the PDF Viewer SDK.
• Navigate within PDF: Learn how to programmatically navigate within a PDF document with the PDF Viewer SDK.
• Search text in PDF: Learn how to programmatically search text within a PDF document with the PDF Viewer SDK and how to listen to search events.
• View a PDF: Learn how to view a PDF file with the PDF Viewer SDK.
• Manage events: Learn how to listen to and programmatically dispatch events with the PDF Viewer SDK.
• Release notes: Changes, additions, and fixes of the PDF Viewer SDK
• Standard implementation overview: Learn about the standard functionality of the PDF Viewer SDK and customization capabilities.
• Customize the PDF Viewer SDK: Learn about the customizable elements of the PDF Viewer SDK to modify various functionalities.
• View a PDF: Learn how to view a PDF file with the PDF Viewer SDK.
• Other shell tools and SDKs: This page explains the state of products that are part of other shell tools and SDKs.
• Code samples for Image to PDF Converter: Link page to Image to PDF Converter documentation.
• Image to PDF Converter documentation: Here you'll find the documentation for the Image to PDF Converter. Image to PDF Converter converts image files to PDF documents. Convert images to ...
• Legacy products documentation: Here you can find documentation for legacy Classic Pdftools products.
• PDF Analysis & Repair documentation: Here you'll find documentation for PDF Analysis & Repair. Get started with PDF Analysis & Repair, which detects corrupt PDF documents and lets you ...
• PDF Extract documentation: Here you'll find the documentation for PDF Extract. Transform PDF content and metadata into usable information with PDF Extract. Convert binary dat...
• PDF to Image Converter documentation: Here you'll find the documentation for PDF to Image Converter. Transform PDF documents into single page or multi-page raster images such as TIFF or...
• PDF Merge Split documentation: Here you'll find documentation for PDF Merge Split. Divide and re-assemble the pages of PDF and PDF/A-compliant documents with PDF Merge Split. Pro...
• PDF OCR documentation: Here you'll find the documentation for 3-Heights PDF OCR. Enhance PDF documents using information detected by an OCR engine.
• Code samples for PDF Optimizer: Link page to PDF Optimizer documentation.
• PDF Optimizer documentation: This page provides documentation of the PDF Optimizer and a migration guide to the Pdftools SDK.
• Code samples for PDF to PDF/A Converter: Link page to PDF to PDF/A Converter documentation.
• PDF to PDF/A Converter documentation: Here you'll find documentation for PDF to PDF/A Converter. Convert PDF documents into PDF/A format for long-term archiving with PDF to PDF/A Conver...
• Code samples for PDF Printer: Link page to PDF Printer documentation.
• PDF Printer documentation: Here you'll find the documentation for PDF Printer. Automate PDF printing either as a single document or an entire batch with PDF Printer. Get high...
• PDF Producer documentation: Here you'll find the documentation for 3-Heights PDF Producer. Create files conforming to PDF and PDF/A from any Windows application via the print ...
• Code samples for PDF Security: Link page to PDF Security documentation.
• PDF Security documentation: Here you'll find documentation for PDF Security. Comprehensive functionalities for electronic signature and encryption in PDF documents with PDF Se...
• PDF Toolbox SDK: The PDF Toolbox SDK has been rebranded as the Toolbox add-on. Learn about the migration path and access legacy documentation.
• Code samples for PDF Validator: Link page to PDF Validator documentation.
• PDF Validator documentation: Here you'll find documentation for PDF Validator. Guarantee the quality of PDF documents with PDF Validator. Check single documents or an entire ba...
• Scan to PDF Server documentation: Here you'll find the documentation for 3-Heights Scan to PDF Server. A service-based application for scan post processing.
• AI Smart Redact: Self-hosted service that detects and permanently removes personally identifiable information (PII) from PDFs. No data leaves your infrastructure.
• Get started with AI Smart Redact: Deploy AI Smart Redact with Docker Compose and run your first detection and redaction workflow.
• Guides: Step-by-step guides for configuring, deploying, scaling, and operating AI Smart Redact.
• Authenticate with AI Smart Redact: Learn how to authenticate with the AI Smart Redact Orchestrator API using JWT tokens, API keys, and the first log-in flow.
• Configure AI Smart Redact: Operational guide for configuring AI Smart Redact services, covering encryption-key generation and rotation, S3 and MinIO file storage, GPU deploym...
• Set up the HITL web application: Learn how to set up and use the AI Smart Redact Human-in-the-Loop (HITL) web application for reviewing and approving detected entities before redac...
• Monitor AI Smart Redact: Learn how to monitor AI Smart Redact using health check endpoints, log files, and the RabbitMQ management UI.
• Set up observability for AI Smart Redact: Learn how to set up OpenTelemetry traces, logs, and metrics for AI Smart Redact, and connect them to Grafana or any OTLP-compatible backend.
• Scale AI Smart Redact: Learn how to scale AI Smart Redact horizontally with multiple Workers, vertically with GPU acceleration and batch inference tuning, and plan memory...
• Update AI Smart Redact: Learn how to update AI Smart Redact to a new version, including Docker image updates, automatic database migrations, and rollback.
• References: API references, detection and redaction concepts, and configuration reference for AI Smart Redact.
• API: Learn about the AI Smart Redact APIs, the low-level Manager and the higher-level Orchestrator.
• Manager API: Overview of the Manager API for direct integration with AI Smart Redact.
• Detection: Manager API endpoints for running sensitive-entity detection on a PDF and retrieving the result.
• Files: Manager API endpoints for uploading, downloading, listing, and deleting files in AI Smart Redact.
• Redaction: Manager API endpoints for redacting sensitive entities from a PDF and retrieving the redacted result.
• Orchestrator API: Overview of the Orchestrator API for the higher-level redaction workflow in AI Smart Redact.
• Jobs: Orchestrator API endpoints for managing the end-to-end redaction workflow as jobs in AI Smart Redact.
• Architecture: Component overview of AI Smart Redact — Manager, Orchestrator, Worker, and clients with their protocols and storage.
• Configuration reference: Configuration reference for the AI Smart Redact services — environment variables, naming convention, and per-service settings.
• Manager: Configuration reference for the AI Smart Redact Manager service.
• Orchestrator: Configuration reference for the AI Smart Redact Orchestrator service.
• Worker: Configuration reference for the AI Smart Redact Worker service.
• Detection: Learn about the AI Smart Redact detection pipeline, methods, and overlap resolution rules.
• Detection accuracy: F1 benchmarks and configuration comparisons for AI Smart Redact detection accuracy.
• Detection configuration: Learn about the detectionConfiguration object schema that controls AI Smart Redact detection requests.
• Entity types: Learn about the built-in pattern-based and semantic entity types detected by AI Smart Redact.
• Keyword exclusions: Learn about keyword exclusions (allowlists) that suppress detected entities in AI Smart Redact.
• Keyword recognizers: Learn about keyword recognizers (denylists) in AI Smart Redact detection.
• Pattern recognizers: Learn about built-in and custom pattern recognizers, format and checksum validators, context boosting, and regex safety in AI Smart Redact.
• Semantic recognizer: Learn about the AI Smart Redact semantic recognizer, including default entity mappings, customization, and limitations.
• Redaction: How AI Smart Redact applies redactions by removing content and rebuilding the PDF from scratch.
• Release notes: Version history and changelog for AI Smart Redact, including added features, fixed issues, and breaking changes.
• System requirements: Minimum RAM and CPU allocation per AI Smart Redact service container, with sizing notes for CPU and GPU deployments.
• Pdftools Technical Support: Welcome to the Pdftools Support page. Reach out to us if you have any issues with our products. We're happy to help!
• About this documentation site: How the Pdftools documentation site organizes content, how search and the Ask AI assistant work, and how to get the most out of it.
• Release management: Learn about versioning of the Pdftools products and their supported releases.
• Toolbox add-on overview: The Toolbox add-on provides low-level access to PDF content for fine-grained PDF creation and modification. Learn to get up and running with the To...
• API references and technical notes: Links to API references and technical notes.
• Technical notes: Technical details about Toolbox add-on for various programming languages.
• C technical notes: Technical details about Toolbox add-on for C.
• .NET technical notes: Specifics of the .NET interface of the Toolbox add-on.
• General technical notes: Technical details about Toolbox add-on for all programming languages.
• Java technical notes: Technical details of the Toolbox add-on for Java.
• Toolbox add-on code samples: The code samples in Java, .NET, C, and Python for the Toolbox add-on can help you to integrate low-level access to the content of PDF files into yo...
• Getting started with the Toolbox add-on: Get up and running with the Toolbox add-on.
• Get started with C: Work with samples and integrate the Toolbox add-on using C.
• Get started with .NET: Work with samples and integrate the Toolbox add-on using .NET.
• Get started with Java: Work with samples and integrate the Toolbox add-on using Java.
• Get started with Python: Use Python interface bindings with the Toolbox add-on.
• Guides: Guides for the Toolbox add-on covering low-level PDF content access and manipulation.
• A primer on PDF accessibility: Accessibility in PDF documents, covering key concepts, why it matters, and how to achieve it with the Toolbox add-on.
• Add logical structure to an existing PDF: Add logical structure to existing PDFs using the Toolbox add-on for PDF remediation, including tags and structure for accessibility.
• Create an accessible PDF from scratch: Create a tagged, accessible PDF/UA-compliant document from scratch using the Toolbox add-on.
• Read PDF logical structure: Read and traverse the logical structure of a tagged PDF document using the Toolbox add-on.
• Add and fill form fields: Create and fill form fields such as text fields and radio buttons in a PDF.
• Manage annotations: Use the Toolbox add-on to manage annotations such as sticky notes and highlights in PDFs.
• Add and remove content: Edit content such as text stamps, barcodes, and images to a PDF document.
• Extract: Extract information such as text and images from a PDF document.
• Generate PDFs: Generate a new PDF file from scratch using C#, Java, and Python.
• Manage metadata: Add, remove, and update metadata in PDF documents using the Toolbox add-on.
• Layout for printing: Create a PDF layout ready for printing by setting the page orientation or placing multiple pages on one printed page.
• Redact: Remove and redact content from a PDF document, for example text, images, and paths.
• Migrate from version 1.11 or earlier: Update your Java project setup when migrating from Toolbox add-on 1.11 or earlier to version 1.12+.
• Toolbox add-on release notes: Learn about the changes, additions and fixes of the Toolbox add-on.
• Toolbox add-on technical specifications: Requirements, supported CPU architectures, languages, frameworks, and operating systems for the Toolbox add-on.
• Class: AnnotationRenderProperties: The AnnotationRenderProperties class encapsulates the rendering properties of a PDF annotation,
• Abstract Class: DrawingAnnotation: Experimental
• Class: EllipseAnnotation: Experimental
• Class: FreeTextAnnotation: An annotation that displays text
• Abstract Class: Layer<T>: Abstract base class for a Layer, which is an event emitter that renders on a native HTML element.
• Class: LineAnnotation: Experimental
• Abstract Class: MarkupAnnotation: Base class for all markup annotations
• Class: NoteAnnotation: Experimental
• Class: PageRenderOptions: Experimental
• Class: Point: Represents a point in a two-dimensional coordinate system.
• Class: Quadrilateral<T>: Represents a polygon with four sides and four corners.
• Class: Rectangle<T>: Represents a rectangle in a two-dimensional coordinate system.
• Class: RectangleAnnotation: Experimental
• Class: RgbColor: Represents a color with red, green and blue components.
• Class: RgbaColor: Represents a color with red, green, blue, and alpha components.
• Abstract Class: ShapeAnnotation: Experimental
• Class: Size: Represents the dimensions of an object in terms of width and height.
• Class: StampAnnotation: Base class for all stamp annotations
• Class: Stroke: Experimental
• Class: TextMarkupAnnotation: Experimental
• Enumeration: AnnotationLockedState: > All: 3
• Enumeration: AnnotationType: Annotation Type
• Enumeration: BlendMode: Blend Mode controls how new content is painted and allows the new pixels to
• Enumeration: BorderEffect: Types of border effects that can be applied to a drawing annotation.
• Enumeration: DestinationType: Supported PDF destination types
• Enumeration: FitMode: Setting how the viewport will be fitted to the visible content
• Enumeration: LineEnding: Line ending style controls how the end of a line is painted.
• Enumeration: NoteAnnotationIcon: Icons for note annotation
• Enumeration: PageLayoutMode: Setting how the pages will be arranged on the viewport.
• Enumeration: PredefinedTextStampType: An enum defining predefined text stamp types.
• Enumeration: Rotation: Enumerates different rotation values in 90 degree steps.
• Enumeration: StampAnnotationSubtype: An enum defining stamp annotation subtypes.
• Enumeration: StampColor: An enum defining stamp colors.
• Enumeration: TextMarkupType: Enum representing different types of text markup annotations used to visually highlight or mark text.
• @pdftools/pdf-web-viewer: - AnnotationLockedState
• Abstract Interface: Annotation: Base class for all annotations.
• Interface: AnnotationOptions: Base options for all annotations
• Interface: Cloneable<T>: Represents an object that can be cloned to create a deep copy.
• Interface: CustomStampAnnotationOptions: Experimental
• Interface: CustomTextStampAnnotationOptions: An interface specific to custom text stamp annotations, defining the text and color.
• Interface: Destination: > optional bottom: number
• Interface: Disposable: Disposable defines a contract for objects that require explicit
• Interface: Document: Groups all the API actions related to document handling.
• Interface: DocumentSaveOptions: Options for configuring the document save behavior.
• Interface: DocumentView: Groups all the API actions related to the document view.
• Interface: DrawingAnnotationOptions: Base options for all annotations
• Interface: EllipseAnnotationOptions: - ShapeAnnotationOptions
• Interface: EventHandler<TEventMap>: Base interface for components with event handling capabilities.
• Interface: FreeTextAnnotationOptions: Base options for all annotations
• Interface: ImageStampAnnotationOptions: An interface specific to image stamp annotations, defining the registered image used for creating the annotation.
• Interface: InputFile: A file that can be opened on a Blob, File or Uint8Array.
• Interface: InputUri: A file that can be opened on a text-uri.
• Interface: LineAnnotationOptions: Base options for all annotations
• Interface: MarkupAnnotationOptions: Base options for all annotations
• Interface: NoteAnnotationOptions: Base options for all annotations
• Interface: Page: A single page in a Pdf document.
• Interface: PdfStampAnnotationOptions: An interface specific to PDF stamp annotations, defining the registered PDF content (PDF page) used for creating the annotation.
• Interface: PdfToolsViewer: API for interacting with the PDF Viewer SDK, exposing core functionalities for document interaction, event handling, and UI management.
• Interface: Plugin: Represents a plugin that can be registered, activated, and deactivated.
• Interface: Plugins: Groups all the API actions related to plugins in the Viewer.
• Interface: PredefinedTextStampAnnotationOptions: An interface specific to predefined text stamp annotations, defining the predefined text stamp type.
• Interface: RectangleAnnotationOptions: - ShapeAnnotationOptions
• Interface: ShapeAnnotationOptions: - DrawingAnnotationOptions
• Interface: StampAnnotationOptions: Base options for all annotations
• Interface: TextFragment: Represents a text fragment within a document, containing information about its position, content, and layout.
• Interface: TextMarkupAnnotationOptions: Interface representing options for text markup annotations.
• Interface: UIDocumentView: Class for managing the presentation and interaction with a PDF document within a container element.
• Type Alias: BuiltInLocale: > BuiltInLocale = "en" | "de" | "fr"
• Type Alias: ComponentName: > ComponentName = keyof typeof COMPONENT_MAP
• Type Alias: Cursor: > Cursor = "auto" | "crosshair" | "pointer" | "wait"
• Type Alias: DocumentEventMap: > DocumentEventMap = object
• Type Alias: DocumentOpenOptions: > DocumentOpenOptions = object
• Type Alias: DocumentPrintOptions: > DocumentPrintOptions = object
• Type Alias: DocumentViewEventMap: > DocumentViewEventMap = object
• Type Alias: DocumentViewPoint: > DocumentViewPoint = Brand<Point, "DocumentViewPoint">
• Type Alias: EventMap: > EventMap = object
• Type Alias: LicenseKey: > LicenseKey = `<VIEWWEB,V5,${string}>`
• Type Alias: LocaleCode: > LocaleCode = BuiltInLocale | "auto"
• Type Alias: NoteAnnotationColor: > NoteAnnotationColor = "#86F9AC" | "#FFECB3" | "#FFD6B3" | "#FBB6F5" | "#B6DDFB"
• Type Alias: OverridableButtonEventType: > OverridableButtonEventType = typeof OVERRIDABLE_BUTTON_EVENTS[number]
• Type Alias: PartialTranslationMap: > PartialTranslationMap = Partial<TranslationMap>
• Type Alias: PdfPoint: > PdfPoint = Brand<Point, "PdfPoint">
• Type Alias: PluginsEventMap: > PluginsEventMap = object
• Type Alias: StampData: > StampData = PredefinedTextStampAnnotationOptions | [`CustomTextStampAnnotationOpt...
• Type Alias: ThumbnailOptions: > ThumbnailOptions = object
• Type Alias: TranslationKey: > TranslationKey = keyof typeof translationsEn
• Type Alias: TranslationMap: > TranslationMap = { readonly [K in TranslationKey]: string }
• Type Alias: ViewerConfig: > ViewerConfig = object
• Class: EventEmitter<T>: EventEmitter is a class designed for managing and dispatching events.
• Enumeration: LogLevel: Enum representing different log levels.
• Function: delay(): > delay(seconds): Promise<unknown>
• Core: - LogLevel
• Interface: Cloneable<T>: Represents an object that can be cloned to create a deep copy.
• Interface: Disposable: Disposable defines a contract for objects that require explicit
• Type Alias: Brand<T, U>: > Brand<T, U> = T & object
• Variable: logger: > const logger: Logger
• Class: AnnotationManager: Class for managing annotations within a PDF document.
• Class: Controller: Class used for managing PDF documents.
• Class: Document: Represents a Pdf document.
• Class: FileNotFoundError: - Error
• Class: InvalidPasswordError: - Error
• Class: Metadata: Document metadata according to the PDF standard (PDF 1.7)
• Class: NotLoadedError: - Error
• Class: Page: A single page in a Pdf document.
• Class: PageList: Class for all page-related operations in a PDF document.
• Class: PageRenderOptions: Experimental
• Enumeration: DestinationType: Supported PDF destination types
• Enumeration: FitMode: Setting how the viewport will be fitted to the visible content
• Enumeration: LicensedFeatureId: Enum representing a unique identifier for each PDF Web SDK licensed feature.
• Enumeration: OutputMedium: The intended target for page rendering.
• Enumeration: PageLayoutMode: Setting how the pages will be arranged on the viewport.
• Enumeration: Rotation: Enumerates different rotation values in 90 degree steps.
• Enumeration: RotationDirection: > clockwise: 0
• Pdf: - Actions
• Interface: ControllerEventMap: Interface defining event types for Pdf.Controller.
• Interface: Destination: > optional bottom?: number
• Interface: DocumentEventMap: Interface defining event types for Pdf.Document.
• Interface: DocumentSaveOptions: Options for configuring the document save behavior.
• Interface: HttpOptions: Options that are applied to an HTTP request.
• Interface: InputDocument: - InputFile
• Interface: InputFile: A file that can be opened on a Blob, File or Uint8Array.
• Interface: InputUri: A file that can be opened on a text-uri.
• Interface: PageEventMap: Interface defining event types for Pdf.Page.
• Interface: PdfImage: An interface representing an image which is registered in a PDF document and can be reused.
• Interface: SaveOptions: Options used for saving Pdf.Documents.
• Interface: TextFragment: Represents a text fragment within a document, containing information about its position, content, and layout.
• Abstract Class: Action: Experimental
• Class: GoToAction: Experimental
• Class: RemoteGoToAction: Experimental
• Class: ResetFormAction: Experimental
• Class: SubmitFormAction: Experimental
• Class: UriAction: Experimental
• Actions: - Action
• Abstract Class: Annotation: Base class for all annotations.
• Class: AnnotationRenderProperties: The AnnotationRenderProperties class encapsulates the rendering properties of a PDF annotation,
• Class: CaretAnnotation: Experimental
• Abstract Class: DrawingAnnotation: Experimental
• Class: EllipseAnnotation: Experimental
• Abstract Class: FileAttachmentAnnotation: Experimental
• Class: FreeTextAnnotation: An annotation that displays text
• Class: InkAnnotation: Experimental
• Class: InternalLinkAnnotation: Experimental
• Class: LineAnnotation: Experimental
• Class: LinkAnnotation: Experimental
• Abstract Class: MarkupAnnotation: Base class for all markup annotations
• Class: NoteAnnotation: Experimental
• Class: PolyLineAnnotation: Experimental
• Class: PolygonAnnotation: Experimental
• Class: RectangleAnnotation: Experimental
• Abstract Class: ShapeAnnotation: Experimental
• Class: StampAnnotation: Base class for all stamp annotations
• Class: TextMarkupAnnotation: Experimental
• Class: WatermarkAnnotation: Experimental
• Class: WidgetAnnotation: A widget annotation.
• Enumeration: AnnotationLockedState: > All: 3
• Enumeration: AnnotationType: Annotation Type
• Enumeration: FileAttachmentAnnotationIcon: Specifies the type of icon displayed on a page for a .
• Enumeration: NoteAnnotationIcon: Icons for note annotation
• Enumeration: PredefinedTextStampType: An enum defining predefined text stamp types.
• [Enumeration: StampAnnotationSubtype](https://www.pdf-tools.com/docs/pdf-web-viewer/api-references/web-sdk/@pdftools/namespaces/P

… [truncated — open the raw llms.txt above for the full file]