The pdfToolbox Rest API - Overview

Introduction

The pdfToolbox in the cloud REST API provides programmatic access to selected pdfToolbox processing capabilities through a set of REST endpoints. It enables applications to process PDF files without user interaction and is intended for automated workflows, web applications, and system integrations.

All processing operations follow the same request model. Once you understand the general workflow, you can use any of the available operations with only minor differences in the request parameters.

Processing model

All operations are executed asynchronously.

The typical workflow is:

  1. Submit a processing request to the desired operation.
  2. Receive an operation ID that uniquely identifies the request.
  3. Poll the operation status until processing has completed.
  4. Retrieve the generated output files and processing report.

The request and response pattern is the same for every operation. Only the operation endpoint and its specific parameters differ.

Available operations

Preflight

Run a pdfToolbox Preflight profile on one or more PDF files.

Use this operation to validate, correct, optimize, or otherwise process PDF documents using predefined or custom Preflight profiles. This is the primary processing operation of the REST API.

Only a few additional operations exist and are listed below, because all other features of the pdfToolbox technology can be configured using profiles or process plans.

Retrieve Profile Variables

This operations can be used in preparation for a Preflight operation if the Profile uses variables. It retrieves the variables defined by a Preflight profile.

This operation allows an application to determine which variables a profile supports before submitting a Preflight request.

Save as Image

Convert PDF pages into raster image files.

Use this operation to generate page previews, thumbnails, or image output for further processing.

Split Layers

Split a PDF according to its Optional Content Groups (layers).

Each generated document contains the content defined by a specific layer configuration.

Split at Mark

Split a PDF into multiple documents based on marks identified by pdfToolbox checks.

This operation is intended for automated production workflows where document boundaries are defined by separator marks or similar identifiers.

The following article provides more detailed information on these operations.