The pdfToolbox Rest API - Operation: Save as image
The Save as Image operation renders PDF pages as raster image files.
Use this operation to generate page previews, thumbnails, or high-resolution images from PDF documents for display, archiving, or further processing.
When to use
Use the Save as Image operation when PDF content needs to be converted into one or more image files.
Typical use cases include:
- Generate page previews for web applications.
- Create document thumbnails.
- Export PDF pages as images for further processing.
- Produce high-resolution raster output for print or review.
Endpoint
Submit a POST request to the Save as Image endpoint.
The request is processed asynchronously and follows the same execution model as all other REST API operations. See Overview for details about the processing workflow.
Request
A request consists of:
- one or more input PDF files,
- the image format to generate,
- rendering options such as resolution and color settings,
- optional output parameters.
The available rendering options determine the appearance and quality of the generated images.
Response
After processing has completed, the operation returns one or more image files generated from the input PDF.
The number of generated images depends on the selected processing options and the number of pages in the input document.
If processing fails, the operation returns status and error information.
Typical workflow
A common workflow is:
- Submit a PDF document.
- Configure the desired image output settings.
- Wait for processing to complete.
- Download the generated image files.