▣ FILE CONVERSION · FILE MANIPULATION

Convert PDF to Image API

Hosted on ApyHub

What it does

PDF to Images converts each page of a PDF into image files. Send a PDF as a file upload, a publicly accessible PDF URL, or base64-encoded PDF content, and choose the rendering quality and output image format.

Use the upload endpoints when you already have the PDF in your application, or the URL endpoints when the document is hosted elsewhere. The service accepts quality values of low, medium, high, or ultra, and img_format values of jpg or png. For URL-based requests, provide file_url; for base64 requests, provide pdf_base64.

The response depends on the endpoint you choose. Download variants return the converted pages as a binary ZIP file. URL variants return a JSON object containing download_url, which points to the generated ZIP in storage.

Use PDF to Images when you need page images for previews, thumbnails, document workflows, or downstream image processing where a PDF is the source format and individual page images are easier to handle.

▣ ENDPOINT 01 / 06

POST

Convert PDF pages to images

http://localhost:8080/apyhub/convert-pdf-pages-to-images/file/download

QUICKSTARTGUIDE

Quickstart

Upload a PDF to convert its pages into images.

curl -X POST "http://localhost:8080/apyhub/convert-pdf-pages-to-images/file/download" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/document.pdf"

What you'll get back

Returns a binary file (string with format: binary) containing the converted image output.

TRY ITLIVE · 150 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

About this endpoint

What it does

Converts an uploaded PDF file into page images and returns the result as a downloadable binary file. The request accepts the PDF plus optional rendering settings for image quality and output format.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	PDF file to convert. Binary upload. Max 10 MB.
quality	ENUM	No	Image rendering quality. Allowed values: `low`, `medium`, `high`, `ultra`. Default: `medium`. Higher quality increases processing time.
img_format	ENUM	No	Output image format for all pages. Allowed values: `jpg`, `png`. Default: `jpg`.

Response

Returns a binary file download containing the converted page images. The success response is a single binary payload, not a JSON object.

Parameter	Type	Mandatory	Description
binary response	String	Yes	Downloadable file content returned by the endpoint.

Notes

The uploaded PDF file must be no larger than 10 MB.

Body

Name

Type

Description

bodyREQUIRED

object

—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 02 / 06

POST

Convert PDF pages to images

http://localhost:8080/apyhub/convert-pdf-pages-to-images/file/url

QUICKSTARTGUIDE

Quickstart

Upload a PDF file to convert its pages into images.

curl -X POST "http://localhost:8080/apyhub/convert-pdf-pages-to-images/file/url" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/file.pdf"

What you'll get back

Returns a JSON object with an optional download_url string field containing the URI to the generated images archive.

{
  "download_url": "https://s3.amazonaws.com/bucket/images.zip"
}

TRY ITLIVE · 150 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

About this endpoint

What it does

Converts the pages of an uploaded PDF file into images and returns a download URL for the generated output. The request sends the PDF as a file upload and can optionally control image quality and output image format.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	PDF file upload (`binary` format).
quality	ENUM	No	Image quality for the generated pages. Allowed values: `low`, `medium`, `high`, `ultra`. Default: `medium`.
img_format	ENUM	No	Output image format. Allowed values: `jpg`, `png`. Default: `jpg`.

Response

Returns a JSON object with a download_url string field containing a URI to the generated images package. The success response body is an object with one top-level field: download_url (string).

Parameter	Type	Mandatory	Description
download_url	String	No	Download URL for the generated output (`uri` format).

Body

Name

Type

Description

bodyREQUIRED

object

—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 03 / 06

POST

Convert PDF pages to images

http://localhost:8080/apyhub/convert-pdf-pages-to-images/url/download

QUICKSTARTGUIDE

Quickstart

Download a converted image version of a PDF from a public URL.

curl -X POST "http://localhost:8080/apyhub/convert-pdf-pages-to-images/url/download" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "file_url": "https://assets.apyhub.com/samples/sample.pdf"
  }'

What you'll get back

Returns a binary file (string with format: binary) containing the converted image data.

TRY ITLIVE · 150 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Converts the PDF at the given public URL into page images and returns the result as a ZIP download. You provide the source PDF URL plus optional image quality and output image format.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	Publicly accessible PDF URL. Format: URI.
quality	ENUM	No	Output quality. Allowed values: `low`, `medium`, `high`, `ultra`. Default: `medium`.
img_format	ENUM	No	Image format for the generated pages. Allowed values: `jpg`, `png`. Default: `jpg`.

Response

Returns a binary response containing the ZIP download of the converted PDF pages.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 04 / 06

POST

Convert PDF pages to images

http://localhost:8080/apyhub/convert-pdf-pages-to-images/url/url

QUICKSTARTGUIDE

Quickstart

Convert a PDF from a public URL into a set of page images by sending the PDF URL in a JSON body.

curl -X POST "http://localhost:8080/apyhub/convert-pdf-pages-to-images/url/url" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"file_url":"https://assets.apyhub.com/samples/sample.pdf"}'

What you'll get back

Returns a JSON object with a download_url string field containing the URL of the generated images archive.

{
  "download_url": "https://s3.amazonaws.com/bucket/images.zip"
}

TRY ITLIVE · 150 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Converts a PDF available at a URL into page images and returns a JSON object containing a download_url for the generated output.

Request Body

Parameter	Type	Mandatory	Description
file_url	String	Yes	The URL of the PDF to convert. Must be a URI.
quality	ENUM	No	Image quality: `low`, `medium`, `high`, or `ultra`. Default: `medium`.
img_format	ENUM	No	Output image format: `jpg` or `png`. Default: `jpg`.

Response

Returns a JSON object with a download_url string field containing a URI for the generated images archive.

Parameter	Type	Mandatory	Description
download_url	String	No	A URI where the converted images can be downloaded.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 05 / 06

POST

Convert PDF pages to images

http://localhost:8080/apyhub/convert-pdf-pages-to-images/base64/download

QUICKSTARTGUIDE

Quickstart

Convert a base64-encoded PDF into image files using the default medium quality and jpg format.

curl -X POST "http://localhost:8080/apyhub/convert-pdf-pages-to-images/base64/download" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "pdf_base64": "JVBERi0xLjQKJcTl8uXrp..."
  }'

What you'll get back

Returns a binary file response (string with format: binary) containing the converted image output.

TRY ITLIVE · 150 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Converts a PDF provided as base64-encoded content into image files for its pages, and returns the result as a downloadable ZIP archive. The request body accepts the PDF content plus optional image quality and output format settings.

Request Body

Parameter	Type	Mandatory	Description
pdf_base64	String	Yes	Base64-encoded PDF content.
quality	ENUM	No	Image quality. Allowed values: `low`, `medium`, `high`, `ultra`. Default: `medium`.
img_format	ENUM	No	Output image format. Allowed values: `jpg`, `png`. Default: `jpg`.

Response

Returns a binary response containing the ZIP download. The output schema is a binary string, so the success response is a downloadable file rather than a JSON object.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 06 / 06

POST

Convert PDF pages to images

http://localhost:8080/apyhub/convert-pdf-pages-to-images/base64/url

QUICKSTARTGUIDE

Quickstart

Convert a PDF passed as a base64 string into images in a downloadable archive.

curl -X POST "http://localhost:8080/apyhub/convert-pdf-pages-to-images/base64/url" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "pdf_base64": "JVBERi0xLjQKJc..."
  }'

What you'll get back

Returns a JSON object with an optional download_url string field containing the URL to the generated image archive.

{
  "download_url": "https://s3.amazonaws.com/bucket/images.zip"
}

TRY ITLIVE · 150 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Converts a PDF provided as a base64 string into page images and returns a download URL for the generated output. The request body includes the source PDF and optional conversion settings for image quality and format.

Request Body

Parameter	Type	Mandatory	Description
pdf_base64	String	Yes	The PDF file encoded as base64.
quality	ENUM	No	Image quality for the converted pages. Allowed values: `low`, `medium`, `high`, `ultra`. Default: `medium`.
img_format	ENUM	No	Output image format. Allowed values: `jpg`, `png`. Default: `jpg`.

Response

Returns a JSON object with a download_url string field containing a URI to download the generated images archive.

Parameter	Type	Mandatory	Description
download_url	String	No	A URI where the converted images archive can be downloaded.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.