The pdfToolbox Rest API - Operations
The pdfToolbox in the cloud REST API provides a small set of processing operations. Each operation performs a specific task and follows the common asynchronous processing model described in the Overview.
Choose the operation that best matches your processing requirements.
Preflight
Run a pdfToolbox Preflight profile on one or more PDF files.
Use this operation to validate, correct, optimize, or otherwise process PDF documents. It is the primary processing operation of the REST API and supports both predefined and custom Preflight profiles.
Typical use cases
- Validate PDF files
- Correct PDF problems
- Convert to PDF standards
- Optimize PDF files
- Run production quality checks
Other related articles
Retrieve Profile Variables
Retrieve the variables defined by a Preflight profile.
This operation allows applications to determine which variable values a profile accepts before executing a Preflight request.
Typical use cases
- Build dynamic user interfaces
- Validate user input
- Configure profile-specific variables
Save as Image
Convert PDF pages into raster image files.
Use this operation to create page previews, thumbnails, or high-resolution images for further processing.
Typical use cases
- Generate previews
- Create thumbnails
- Export PDF pages as images
Split Layers
Split a PDF according to its Optional Content Groups (layers).
Each generated document contains the content defined by a particular layer configuration.
Typical use cases
- Extract language layers
- Separate technical drawings
- Produce layer-specific output
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 separator marks define document boundaries.
Typical use cases
- Split print jobs
- Separate batches of documents
- Create individual PDFs from a combined document