Pdftools documentation website

# 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](https://www.pdf-tools.com/docs/conversion-service/README): 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](https://www.pdf-tools.com/docs/conversion-service/api/README): Learn about the Conversion Service APIs and how to use them.
- [Add data to job](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/add-data.api): Add data such as documents, images, and other
- [Advanced API](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/advanced-api.info): 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](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/cancel-job.api): Cancel the processing of a job.
- [Create new job](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/create-job.api): Create a new job for processing using the provided `workflow` and `profile`.
- [Delete job](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/delete-job.api): When the job processing is completed, delete the job and all associated resources using `deleteJob` API request.
- [Get job info](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/get-job-info.api): Get job info.
- [Get job result data](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/get-job-result-data.api): Get result data, typically a document, of a job that has completed successfully.
- [Get job result](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/get-job-result.api): This request returns result when it is available and is blocked otherwise. You can also call the `getJobInfo` API request until
- [Get the service status](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/get-service-status.api): Get the service status.
- [List all jobs](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/list-jobs.api): List all jobs and their statuses.
- [List available workflows](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/list-workflows.api): List available workflows.
- [Start job](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/start-job.api): Signal that all data was added to a job and the Conversion Service API can start processing it.
- [Store job result data](https://www.pdf-tools.com/docs/conversion-service/api/advanced-api/store-job-result-data.api): Store the result data by sending it to a web server via HTTP(S) request.
- [REST input JSON](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/convert-to-pdf-profile-rest-input-json.api): The All to PDF Profile converts any supported input document into a standard PDF. REST input JSON allows for structured input and output for your d...
- [REST input plain HTTP](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/convert-to-pdf-profile-rest-input-plain-http.api): The All to PDF Profile converts any supported input document into a standard PDF. The REST input plain HTTP endpoint supports the conversion of var...
- [REST input JSON](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/merge-profile-rest-input-json.api): The Merge Profile merges multiple documents into a single PDF dossier. REST input JSON allows for structured input and output for your documents to...
- [REST input plain HTTP](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/merge-profile-rest-input-plain-http.api): The Merge Profile merges multiple documents into a single PDF dossier. The REST input plain HTTP endpoint supports merging multiple documents into ...
- [REST input JSON](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/pdf-a-2-profile-rest-input-json.api): The Archive PDF/A-2 endpoint outputs PDFs in the PDF/A-2 archival standard (this is a recommended archival format). The REST input JSON allows for ...
- [REST input plain HTTP](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/pdf-a-2-profile-rest-input-plain-http.api): The Archive PDF/A-2 endpoint outputs PDFs in the PDF/A-2 archival standard (this is a recommended archival format). The REST input plain HTTP endpo...
- [REST input JSON](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/pdf-a-3-profile-rest-input-json.api): The Archive PDF/A-3 endpoint outputs PDF documents compliant with the PDF/A-3 archival standard, recommended especially for use cases such as elect...
- [REST input plain HTTP](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/pdf-a-3-profile-rest-input-plain-http.api): The Archive PDF/A-3 endpoint outputs PDF documents compliant with the PDF/A-3 archival standard, recommended especially for use cases such as elect...
- [REST input JSON](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/ready-for-email-profile-rest-input-json.api): The Ready for Email PDF/A-2 workflow outputs PDF documents compliant with the PDF/A-2 archival standard, specifically with ready for email optimiza...
- [REST input plain HTTP](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/ready-for-email-profile-rest-input-plain-http.api): The Ready for Email PDF/A-2 workflow outputs PDF documents compliant with the PDF/A-2 archival standard, specifically with ready for email optimiza...
- [REST input JSON](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/ready-for-web-profile-rest-input-json.api): The Ready for Web PDF/A-2 workflow outputs PDF documents compliant with the PDF/A-2 archival standard, optimized specifically for web viewing. The ...
- [REST input plain HTTP](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/ready-for-web-profile-rest-input-plain-http.api): The Ready for Web PDF/A-2 workflow outputs PDF documents compliant with the PDF/A-2 archival standard, optimized specifically for web viewing. The ...
- [REST input JSON](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/ready-to-print-profile-rest-input-json.api): The Ready to Print PDF/A-2 workflow outputs PDF documents compliant with the PDF/A-2 archival standard, optimized specifically for printing. The RE...
- [REST input plain HTTP](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/ready-to-print-profile-rest-input-plain-http.api): The Ready to Print PDF/A-2 workflow outputs PDF documents compliant with the PDF/A-2 archival standard, optimized specifically for printing. The RE...
- [REST input JSON](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/repair-profile-rest-input-json.api): The Repair Profile validates and repairs PDFs. The REST input JSON allows for structured input and output for PDF documents to be validated and rep...
- [REST input plain HTTP](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/repair-profile-rest-input-plain-http.api): The Repair Profile validates and repairs PDFs. The REST input plain HTTP endpoint supports validating and repairing large PDF files (larger than 10...
- [Simple API](https://www.pdf-tools.com/docs/conversion-service/api/simple-api/simple-api.info): 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](https://www.pdf-tools.com/docs/conversion-service/configure/README): Learn how to configure the Conversion Service to convert documents to PDF and PDF/A output.
- [Configure connections](https://www.pdf-tools.com/docs/conversion-service/configure/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](https://www.pdf-tools.com/docs/conversion-service/configure/configure-docker-container): This page explains how to set up the Conversion Service in a Docker container to automate document conversion.
- [Configure emails](https://www.pdf-tools.com/docs/conversion-service/configure/configure-emails): You can customize how email files are processed using the Conversion Service Configurator.
- [Configure job and document options](https://www.pdf-tools.com/docs/conversion-service/configure/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](https://www.pdf-tools.com/docs/conversion-service/configure/configure-openshift): Learn how to configure and deploy the Conversion Service on OpenShift.
- [Configure Conversion Service plugins](https://www.pdf-tools.com/docs/conversion-service/configure/configure-plugins): This page explains how to use plugins in the Conversion Service to extend the service with custom workflows.
- [Configure profiles in Docker](https://www.pdf-tools.com/docs/conversion-service/configure/configure-profiles-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](https://www.pdf-tools.com/docs/conversion-service/configure/configure-profiles): This page explains how to customize the Conversion Service settings for a specific workflow to automate document conversion.
- [Configure digital signature](https://www.pdf-tools.com/docs/conversion-service/configure/configure-signature/README): Learn how to set up digital signatures with various online and offline signature providers.
- [Cryptographic providers](https://www.pdf-tools.com/docs/conversion-service/configure/configure-signature/set-up-signature/README): Learn how to set up digital signatures in the Conversion Service.
- [Windows signature](https://www.pdf-tools.com/docs/conversion-service/configure/configure-signature/set-up-signature/provider-builtin): Learn how to configure Windows cryptographic provider.
- [GlobalSign Digital Signing Service](https://www.pdf-tools.com/docs/conversion-service/configure/configure-signature/set-up-signature/provider-globalsign): Learn how to configure GlobalSign cryptographic provider.
- [PKCS#11](https://www.pdf-tools.com/docs/conversion-service/configure/configure-signature/set-up-signature/provider-pkcs11): Learn how to configure PKCS#11 cryptographic provider.
- [Swisscom All-in Signing Service](https://www.pdf-tools.com/docs/conversion-service/configure/configure-signature/set-up-signature/provider-swisscom): Learn how to configure Swisscom cryptographic provider.
- [Configure stamps and annotations](https://www.pdf-tools.com/docs/conversion-service/configure/configure-stamping): 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](https://www.pdf-tools.com/docs/conversion-service/configure/configure-win-service): This page explains how to set up the Conversion Service to automate document conversion.
- [How the Conversion Service works](https://www.pdf-tools.com/docs/conversion-service/configure/how-cs-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](https://www.pdf-tools.com/docs/conversion-service/configure/ocr/README): Configure various options of the Pdftools OCR Service.
- [Legacy 3-Heights® OCR Service](https://www.pdf-tools.com/docs/conversion-service/configure/ocr/configure-ocr-3-heights-ocr-service): Learn about the 3-Heights® OCR Service.
- [Legacy OCR using your own ABBYY license key](https://www.pdf-tools.com/docs/conversion-service/configure/ocr/configure-ocr-your-own-license-key): Configure and use optical character recognition (OCR) in Conversion Service.
- [Convert Microsoft Office files](https://www.pdf-tools.com/docs/conversion-service/configure/office-conversion): Learn how to set up the Conversion Service to convert Microsoft Office files such as DOCX, PPTX or XLSX to PDF or PDF/A as part of your document pr...
- [Troubleshooting Microsoft Office file conversion](https://www.pdf-tools.com/docs/conversion-service/configure/office-troubleshooting): Learn how to troubleshoot Microsoft Office file conversion issues.
- [Configure conversion of redlined Microsoft Word documents](https://www.pdf-tools.com/docs/conversion-service/configure/word-track-changes): 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](https://www.pdf-tools.com/docs/conversion-service/getting-started/README): This page is a navigation crossroad for getting started guides with either Windows Server or Docker.
- [Conversion Service APIs overview](https://www.pdf-tools.com/docs/conversion-service/getting-started/api/README): Learn about the Conversion Service APIs and how to use them.
- [Get started with Advanced API](https://www.pdf-tools.com/docs/conversion-service/getting-started/api/advanced-api): Learn how to convert files with the Conversion Service Advanced API.
- [Get started with Simple API](https://www.pdf-tools.com/docs/conversion-service/getting-started/api/simple-api): Learn how to convert files using the Conversion Service Simple API.
- [Conversion Service in Docker](https://www.pdf-tools.com/docs/conversion-service/getting-started/docker): Learn how to run and configure the Conversion Service in Docker.
- [Conversion Service on Windows Server](https://www.pdf-tools.com/docs/conversion-service/getting-started/windows-server): Learn how to install and use the Conversion Service on Windows Server to automate document processes.
- [Integrate the Conversion Service](https://www.pdf-tools.com/docs/conversion-service/integrate/README): This page describes how you can integrate the Conversion Service with your existing applications. You can integrate using watched folders, a shell ...
- [Connectors](https://www.pdf-tools.com/docs/conversion-service/integrate/connectors/README): Use the Conversion Service to directly integrate with various document sources like local folders, mail servers, and web services.
- [Email connectors](https://www.pdf-tools.com/docs/conversion-service/integrate/connectors/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](https://www.pdf-tools.com/docs/conversion-service/integrate/connectors/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](https://www.pdf-tools.com/docs/conversion-service/integrate/connectors/other-connectors): Use the execute command connector in the Conversion Service to implement a custom output connector.
- [REST connectors](https://www.pdf-tools.com/docs/conversion-service/integrate/connectors/rest-connectors/README): 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)](https://www.pdf-tools.com/docs/conversion-service/integrate/connectors/rest-connectors/rest-input-connectors): Learn how to use the REST connectors in the Conversion Service to automatically convert all files sent to a URL.
- [REST output](https://www.pdf-tools.com/docs/conversion-service/integrate/connectors/rest-connectors/rest-output-connectors): Learn how to send all converted files to a configurable URL.
- [PDF Client for Conversion Service](https://www.pdf-tools.com/docs/conversion-service/integrate/gui-client): 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](https://www.pdf-tools.com/docs/conversion-service/integrate/rest-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)](https://www.pdf-tools.com/docs/conversion-service/integrate/shell-client): 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](https://www.pdf-tools.com/docs/conversion-service/migrate/README): This guide explains how to migrate from the 3-Heights® Document Converter to the Conversion Service.
- [Errors and warnings](https://www.pdf-tools.com/docs/conversion-service/migrate/error-handling): The handling of errors and warnings is much more flexible in the Conversion Service and easier to understand. The user or operator has the full con...
- [Installation and configuration](https://www.pdf-tools.com/docs/conversion-service/migrate/installation): This page explains differences in the installation and configuration for the Conversion Service.
- [Command Line client](https://www.pdf-tools.com/docs/conversion-service/migrate/integrate/CLI): This page explains the differences between the CLI client for the Conversion Service and the 3-­Heights® Document Converter.
- [Integrate with the Conversion Service](https://www.pdf-tools.com/docs/conversion-service/migrate/integrate/README): The Conversion Service offers many of the same integration possibilities as the 3-­Heights® Document Converter such as watched folders, mail folder...
- [Office and Windows File Explorer integration](https://www.pdf-tools.com/docs/conversion-service/migrate/integrate/office-integration): This page explains how to integrate with Microsoft Office applications in the Conversion Service.
- [Watched Folders](https://www.pdf-tools.com/docs/conversion-service/migrate/integrate/watched-folders): This page explains how to migrate Watched Folders to the Conversion Service
- [Watched Mail Folders](https://www.pdf-tools.com/docs/conversion-service/migrate/integrate/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](https://www.pdf-tools.com/docs/conversion-service/migrate/job-processing): import PenIcon from '/img/pen-solid.svg';
- [Nested files and attachments](https://www.pdf-tools.com/docs/conversion-service/migrate/nested-files-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](https://www.pdf-tools.com/docs/conversion-service/migrate/ocr): This page explains how to use your existing 3-Heights® PDF OCR service with the Conversion Service
- [Overview](https://www.pdf-tools.com/docs/conversion-service/migrate/overview): This page explains the key differences between the Conversion Service and the 3-Heights® Document Converter.
- [PDF/A and conformance](https://www.pdf-tools.com/docs/conversion-service/migrate/pdfa-conformance): In the Conversion Service, there are four separate workflows to convert files to PDF depending on the required standard:
- [Stamping](https://www.pdf-tools.com/docs/conversion-service/migrate/stamping): This page explains the differences between stamping in the Conversion Service and the 3-Heights® Document Converter.
- [Monitor the service](https://www.pdf-tools.com/docs/conversion-service/monitor/README): This page describes how you can monitor the status and performance of the Conversion Service.
- [Health & Activity](https://www.pdf-tools.com/docs/conversion-service/monitor/health-activity): This page describes how you can view the status of the Conversion Service.
- [Service log](https://www.pdf-tools.com/docs/conversion-service/monitor/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](https://www.pdf-tools.com/docs/conversion-service/monitor/statistics): This page explains how you can track the performance of the Conversion Service over a period of time.
- [Conversion Service release notes](https://www.pdf-tools.com/docs/conversion-service/release-notes): Functional changes, updates, and bug fixes in various versions of the Conversion Service.