Skip to main content

Conversion Service APIs overview

Learn about the Conversion Service APIs and how to use them. Integrate and automate complex file processing pipelines using a locally hosted API.

The Conversion Service provides two APIs that you can use to automate documentation workflows and processes:

  • Simple API: Process files in one API call. Get started fast with the Simple API, designed to solve common use cases of the conversion process.
  • Advanced API: Leverage fine-grained control over the conversion process, letting you convert many documents in bulk and check their status during the conversion process. Reliably process the harmonization of documents from various sources and prepare them optimally for your intended purpose.

Simple API​

The Simple API lets you leverage the following use cases:

  • Convert files with one API call.
  • Convert documents one by one with a blocking call until the API delivers the converted PDFs.
  • Implement the Conversion Service with multiple applications with a dedicated API for each application. 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.

Advanced API​

The Advanced API lets you leverage the following use cases:

  • Merge hundreds of documents into a single PDF using the Dossier workflow.
  • List and monitor all jobs processed, workflows, and profiles on your server.
  • Monitor the status of the Conversion Service to ensure that everything is running correctly.
  • Store the results of the conversion on an Amazon S3, Azure Blob Storage, SharePoint and choose the destination location on the fly.
  • Collect all the files over time and wait until all documents are ready to be converted. Create a job, add files over time, and then start the conversion job.
  • Convert large files (larger than 100 MB).
info

If you already reviewed both getting started guides, learn more details about the Simple API and Advanced APIs on the API references page.