Stirling PDF icon

Stirling PDF

Merged API: Stirling PDF - Processing API + Stirling PDF - Management API + Stirling PDF - System API

Actions260

Convert → Convert To Image

AI-generated

Summary

Convert PDF files into images with customizable output options including page selection, image format, color type, DPI, and annotation inclusion.

Inputs

  • fileInputBinaryProperty — The binary property name in the input containing the PDF file data; defaults to 'data' if not specified.
  • fileId — ID of a previously processed file on the server to use instead of uploading a new file binary.
  • pageNumbers (required) — Specifies which pages to convert; supports explicit pages, ranges, 'all', or page functions like '2n+1'.
  • imageFormat (required) — The desired format for the output images (png, jpeg, jpg, gif, webp).
  • singleOrMultiple (required) — Determines if output is a single image containing all pages or multiple images per page.
  • colorType (required) — Defines the color mode of the output images (color, greyscale, blackwhite).
  • dpi (required) — Dots per inch setting controlling the resolution of the output images.
  • includeAnnotations — Whether to include PDF annotations such as comments in the output images.

Output shape

one or more binary images in the specified format

Returns images corresponding to the selected pages as single or multiple files based on configuration; binary data is included in output under a binary property. Handles server-side files if fileId is provided instead of binary input.

Links

Discussion