SearchCtrl+K

PDF to Image API Reference

Convert PDF pages into high-quality images in PNG, JPG, TIFF, BMP, or GIF format.

POSThttps://api.apifreaks.com/v1.0/pdf/jpg

The PDF to Image API converts PDF pages into image files in five supported formats. You can specify individual pages, ranges, or convert the entire document. Customize output with options like DPI, color mode, and image quality. Select a format above to see its specific endpoint and parameters.

Getting Started

Authentication

Pass your API key as the apiKey parameter in every request.

API Version

This is version v1.0 of the API.

LANGUAGE

curl --location --request POST 'https://api.apifreaks.com/v1.0/pdf/jpg?apiKey=API-KEY&resolution=150&quality=85&profile=rgb&output=web_images' \
--header 'X-apiKey: API-KEY' \
--form 'file=@"/path/to/file.pdf"'

Response

{
  "taskId": "04a06cd5-158d-4191-a45b-6f58249c599d",
  "inputIds": [
    "7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f"
  ]
}

All PDF to image endpoints accept the same common parameters with additional format-specific controls for color profiles and quality.

Best For: Photographs, small file sizes, general viewing

API Request

The PDF to Image API accepts a file upload, query parameters, and request headers described below.

Request Body

The request body is a single optional file upload sent as multipart/form-data. All other parameters (including file_id, resolution, and profile) are passed as query parameters, not in the request body.

{
  "file": "/path/to/document.pdf"
}

fileoptionalmultipart/form-data

The PDF file to process.

Query Parameters

All parameters must be included as query parameters. Any parameters sent in the form data will be ignored.

formatoptionalStringdefault: json

Response format: 'json' (default) or 'xml'.

file_idoptionalString

The unique ID of a PDF file already present on our server. Use this instead of uploading the file again.

outputoptionalString

Name of the output zip file (without extension) containing all generated images. Format can either be png, jpg, tif, bmp or gif.

destroyoptionalBooleandefault: false

If true, we delete the input file immediately after generating the output images.

pagesoptionalStringdefault: all

Specify the pages to be converted to image format from the PDF. Provide individual page numbers and/or ascending page ranges (e.g., 1, 3-5, 7). Use commas to separate entries and hyphens for ranges. Any duplicate pages will be removed, while preserving the original page order. You may instead provide only one of the special keywords: even - converts all even-numbered pages, odd - converts all odd-numbered pages, last - converts only the last page, all - converts all pages. Examples: "1,4-2,last" / "odd" / "all" / "1,odd" (invalid). Note: Mixing special keywords with specific pages/ranges is not allowed.

resolutionoptionalIntegerdefault: 150

Output image resolution in DPI. Acceptable range: 20 to 1200. Higher values produce sharper images but larger file sizes. Default value for pdf to gif is 100.

image_smoothingoptionalStringdefault: none

Anti-aliasing options to apply during conversion. Use none to disable all smoothing, all to enable everything, or a comma-separated combination of text, line, and image (e.g., "text,line"). If not provided, no smoothing will be applied.

webhook_urloptionalString

The URL where we'll send the webhook notification after the task completes. Authentication parameters in the URL (e.g., ?auth=token123) are passed as-is.

webhook_failure_notificationoptionalBooleandefault: false

If true, we'll send an email notification if the webhook request fails after 3 retries. The email goes to the requesting user or their org admin if user is part of an organization.

profileoptionalStringdefault: rgb

Color profile for the output JPG images. gray - 8-bit grayscale; rgb - 24-bit RGB color (default); cmyk - 32-bit CMYK color, commonly used for print workflows.

qualityoptionalIntegerdefault: 70

JPG compression quality. Range: 1 to 100. Higher values yield sharper images with larger file sizes; lower values produce smaller files with more compression artifacts.

Request Headers

Optional custom headers for webhook authorization

X-Webhook-AuthorizationoptionalString

Custom authorization header sent with the webhook request. Format: Key:Value (e.g., Authorization:Bearer token123).

API Response Schema

A successful request returns a 200 OK response with a JSON object containing the task ID and input file IDs.

taskId

Stringmandatory

Unique identifier for the PDF task, used to check status.

inputIds

Array<String>optional

Array of file IDs referencing input files used for the task. Not returned when destroy=true.

Error Status & Codes

See the HTTP Status Codes documentation for a complete reference of common API errors and HTTP status codes.

400

Please provide a valid PDF file. Other file types are not supported.

400

Please provide either a file or a file ID.

400

Please provide a valid image profile. Refer to the documentation for valid profiles.

400

Please provide a valid smoothing option or combination. Refer to the documentation for valid options.

400

Please provide a valid image resolution (DPI). Refer to the documentation for valid resolution values.

400

Please provide a valid image quality value from 1 to 100. (JPG only)

404

Please provide a valid file ID.

Task Processing Error Messages

These errors might appear in the task-status response if the background job fails.

Invalid PDF File

The provided file is not a valid PDF file.

File Saving Exception

An unknown error occurred while saving the file. Try again later.

PDF Generation Exception

An unknown error occurred while generating the PDF. Try again later.

Internal Server Error

Internal Server Error Occurred.

Invalid File ID Provided

Please provide a valid file ID.

Encrypted PDF Provided

The provided PDF file is encrypted. Please decrypt it first to perform operations.

Invalid Image Profile

Please provide a valid image profile. Refer to the documentation for valid profiles.

Invalid Page Range

One or more specified page numbers exceed the total number of pages in the PDF document.

Invalid Page Number Format

The provided page number format is invalid. Refer to the documentation for valid page number formats.

PDF to Image API Reference

Convert PDF pages into high-quality images in PNG, JPG, TIFF, BMP, or GIF format.

POSThttps://api.apifreaks.com/v1.0/pdf/jpg

Test

Getting Started

Authentication

Pass your API key as the apiKey parameter in every request.

API Version

This is version v1.0 of the API.

LANGUAGE

curl --location --request POST 'https://api.apifreaks.com/v1.0/pdf/jpg?apiKey=API-KEY&resolution=150&quality=85&profile=rgb&output=web_images' \
--header 'X-apiKey: API-KEY' \
--form 'file=@"/path/to/file.pdf"'

Response

{
  "taskId": "04a06cd5-158d-4191-a45b-6f58249c599d",
  "inputIds": [
    "7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f"
  ]
}

All PDF to image endpoints accept the same common parameters with additional format-specific controls for color profiles and quality.

Best For: Photographs, small file sizes, general viewing

API Request

The PDF to Image API accepts a file upload, query parameters, and request headers described below.

Request Body

{
  "file": "/path/to/document.pdf"
}

fileoptionalmultipart/form-data

The PDF file to process.

Query Parameters

All parameters must be included as query parameters. Any parameters sent in the form data will be ignored.

formatoptionalStringdefault: json

Response format: 'json' (default) or 'xml'.

file_idoptionalString

The unique ID of a PDF file already present on our server. Use this instead of uploading the file again.

outputoptionalString

Name of the output zip file (without extension) containing all generated images. Format can either be png, jpg, tif, bmp or gif.

destroyoptionalBooleandefault: false

If true, we delete the input file immediately after generating the output images.

pagesoptionalStringdefault: all

resolutionoptionalIntegerdefault: 150

Output image resolution in DPI. Acceptable range: 20 to 1200. Higher values produce sharper images but larger file sizes. Default value for pdf to gif is 100.

image_smoothingoptionalStringdefault: none

webhook_urloptionalString

The URL where we'll send the webhook notification after the task completes. Authentication parameters in the URL (e.g., ?auth=token123) are passed as-is.

webhook_failure_notificationoptionalBooleandefault: false

If true, we'll send an email notification if the webhook request fails after 3 retries. The email goes to the requesting user or their org admin if user is part of an organization.

profileoptionalStringdefault: rgb

Color profile for the output JPG images. gray - 8-bit grayscale; rgb - 24-bit RGB color (default); cmyk - 32-bit CMYK color, commonly used for print workflows.

qualityoptionalIntegerdefault: 70

JPG compression quality. Range: 1 to 100. Higher values yield sharper images with larger file sizes; lower values produce smaller files with more compression artifacts.

Request Headers

Optional custom headers for webhook authorization

X-Webhook-AuthorizationoptionalString

Custom authorization header sent with the webhook request. Format: Key:Value (e.g., Authorization:Bearer token123).

API Response Schema

A successful request returns a 200 OK response with a JSON object containing the task ID and input file IDs.

taskId

Stringmandatory

Unique identifier for the PDF task, used to check status.

inputIds

Array<String>optional

Array of file IDs referencing input files used for the task. Not returned when destroy=true.

Error Status & Codes

See the HTTP Status Codes documentation for a complete reference of common API errors and HTTP status codes.

400

Please provide a valid PDF file. Other file types are not supported.

400

Please provide either a file or a file ID.

400

Please provide a valid image profile. Refer to the documentation for valid profiles.

400

Please provide a valid smoothing option or combination. Refer to the documentation for valid options.

400

Please provide a valid image resolution (DPI). Refer to the documentation for valid resolution values.

400

Please provide a valid image quality value from 1 to 100. (JPG only)

404

Please provide a valid file ID.

Task Processing Error Messages

These errors might appear in the task-status response if the background job fails.

Invalid PDF File

The provided file is not a valid PDF file.

File Saving Exception

An unknown error occurred while saving the file. Try again later.

PDF Generation Exception

An unknown error occurred while generating the PDF. Try again later.

Internal Server Error

Internal Server Error Occurred.

Invalid File ID Provided

Please provide a valid file ID.

Encrypted PDF Provided

The provided PDF file is encrypted. Please decrypt it first to perform operations.

Invalid Image Profile

Please provide a valid image profile. Refer to the documentation for valid profiles.

Invalid Page Range

One or more specified page numbers exceed the total number of pages in the PDF document.

Invalid Page Number Format

The provided page number format is invalid. Refer to the documentation for valid page number formats.

Quick Links

Quick Links

PDF to Image API Reference

Getting Started

Authentication

API Version

API Request

Request Body

Query Parameters

Request Headers

API Response Schema

Error Status & Codes

Task Processing Error Messages

Docs

Integrations

Pricing & Accounts

Quick Links

Quick Links

PDF to Image API Reference

Getting Started

Authentication

API Version

API Request

Request Body

Query Parameters

Request Headers

API Response Schema

Error Status & Codes

Task Processing Error Messages

Docs

Integrations

Pricing & Accounts