Skip to main content
Version: 6.10.0

Simple API

Process files in one API call. Convert documents individually with a blocking call until the API delivers the converted files. Implement the Conversion Service with multiple applications, each with a dedicated API. Each application can include different Workflows and Profiles. Convert large files (larger than 100 MB) using the plain HTTP input endpoint of the Simple API.

By default, the Simple API operates synchronously, blocking until the conversion completes and returning the result in the response. If the Response setting in the REST Input Connector configuration is set to Immediately, the API returns a 202 Accepted status and processes the file asynchronously. In this case, results are delivered through the configured output connectors.

Pre-installed connections

The Conversion Service comes with the following pre-installed Connections that you can use out of the box. Replace the {connectionID} path parameter in the endpoint URL with one of these values:

Connection IDProfileDescription
archive-pdfa2-defaultArchive PDF/A-2Outputs PDFs in the PDF/A-2 archival standard (recommended)
archive-pdfa3-defaultArchive PDF/A-3Outputs PDFs in the PDF/A-3 archival standard (for specific cases, such as e-invoices)
convert-to-pdfAll to PDFConverts any supported input document into a standard PDF
dossier-defaultMergeMerges multiple documents into a single PDF dossier
archive-pdfa2-print-optimizationReady to Print PDF/A-2PDF/A-2 archival standard with print optimization
archive-pdfa2-web-optimizationReady for Web PDF/A-2PDF/A-2 archival standard with web optimization
archive-pdfa2-email-optimizationReady for Email PDF/A-2PDF/A-2 archival standard with email optimization
repair-pdfRepairConverts any supported document to PDF and validates and repairs the output

You can also create custom Connections in the Conversion Service Configurator and use their Connection IDs with these endpoints.

Optimization options

The Ready to Print, Ready for Web, and Ready for Email profiles accept an OPTIMIZEPROFILE job option in the JSON request body:

ProfileOPTIMIZEPROFILE value
Ready to Print PDF/A-2print
Ready for Web PDF/A-2web
Ready for Email PDF/A-2max