How to Convert PDF to PNG with cURL, Tutorial

Share this page

Why Convert PDF to PNG with cURL?

Empower your development workflows with the pdfRest PDF to Images API Tool. This versatile tool simplifies the process of programmatically converting PDF documents into various image formats like JPEG, PNG, and TIFF. Whether you need to transform entire PDFs or extract specific pages, the API offers a smooth and efficient solution. This tutorial will guide you through utilizing cURL – a command-line tool for data transfer – to send an API call and leverage the power of pdfRest's image conversion capabilities.

Transforming PDFs into images unlocks a range of valuable applications. Imagine a web app where users can preview a PDF's first page as a thumbnail before downloading. Or, a document management system that automatically converts uploaded PDFs to images for faster, reader-independent viewing. These are just a glimpse of the possibilities offered by the pdfRest PDF to Images API.

Convert PDF to PNG with cURL Code Example

curl -X POST "https://api.pdfrest.com/png" \
  -H "Accept: application/json" \
  -H "Content-Type: multipart/form-data" \
  -H "Api-Key: xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
  -F "file=@/path/to/file" \
  -F "output=example_out" \
  -F "pages=1-last" \
  -F "resolution=300" \
  -F "color_model=rgb"

Reference to the code: pdfRest API samples on GitHub.

Breaking Down the Code

The above code block demonstrates how to use cURL to make a POST request to the pdfRest API's PDF to Images endpoint. Here's what each part of the command does:

-X POST "https://api.pdfrest.com/png"

This specifies that you are making a POST request to the endpoint that converts PDFs to PNG images.

-H "Accept: application/json"

This header tells the server that the client expects a response in JSON format.

-H "Content-Type: multipart/form-data"

This header indicates that the data being sent in the request is multipart form data, which is necessary for file uploads.

-H "Api-Key: xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

You must replace the placeholder with your actual API key to authenticate the request.

-F "file=@/path/to/file"

This form field is where you specify the file path to the PDF you want to convert.

-F "output=example_out"

Here you define the base name for the output files. The API will add a page number and file extension to this base name.

-F "pages=1-last"

This field specifies the range of pages to convert. "1-last" means all pages in the PDF will be converted.

-F "resolution=300"

The resolution field sets the DPI (dots per inch) for the output images, which affects their quality and size.

-F "color_model=rgb"

This option sets the color model for the output images. "rgb" is suitable for full-color images.

Beyond the Tutorial

In this tutorial, you've learned how to use cURL to call the pdfRest PDF to Images API to convert a PDF into PNG files. By following the steps outlined above, you can integrate this functionality into your own applications or workflows. To explore more possibilities and try out all of the pdfRest API Tools, visit the API Lab. For a deeper understanding of the API's capabilities and additional options you can use in your requests, refer to the API Reference Guide.

Note: This is an example of a multipart API call. Code samples using JSON payloads can be found at pdfRest API samples on GitHub.