Convert PDF to Image Using Syncfusion Web API

24 Mar 20264 minutes to read

The Syncfusion PDF to Image Web API converts PDF pages into high‑quality image formats such as PNG, JPEG, and WebP. It accurately renders each page while preserving layout and clarity, making it ideal for previews, web display, and image‑based workflows.

Convert PDF to Image

To convert an PDF document to Image, send a request to the /v1/conversion/pdf-to-image endpoint, including both the PDF file as input and the settings JSON. Also, Image formats supported by Syncfusion PDF to Image Converter API are PNG, JPEG, and Webp.

Curl

curl -v --location 'http://localhost:8003/v1/conversion/pdf-to-image' \
  --form 'file=@Input.pdf' \
  --form 'settings={
    "File": "file",
    "Password": null,
    "ImageFormat": "PNG"
}'

JavaScript

const formdata = new FormData();
formdata.append("file", fileInput.files[0], "Input.pdf");

formdata.append(
  "settings",
  JSON.stringify({
    File: "file",
    Password: null,
    ImageFormat: "PNG"
  })
);

const requestOptions = {
  method: "POST",
  body: formdata,
  redirect: "follow"
};

fetch("http://localhost:8003/v1/conversion/pdf-to-image", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:8003/v1/conversion/pdf-to-image");
var content = new MultipartFormDataContent();
content.Add(new StreamContent(File.OpenRead("Input1.pdf")), "file", "Input1.pdf");

var settings = new
{
    File = "file",
    Password = (string?)null,
    ImageFormat = "PNG"
};

var json = JsonSerializer.Serialize(settings);
var settingsContent = new StringContent(json, Encoding.UTF8, "application/json");
content.Add(settingsContent, "settings");
request.Content = content;

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

PDF to Image settings

Password

Specifies the password required to open and process a protected PDF document.

ImageFormat

Defines the output image format for the converted pages, such as JPG, PNG, or WEBP.

PDF to Image Job Response

Once the request is sent, it will create a conversion job to convert the PDF to Images and return the job details as follows:

{
    "jobID": "6be827c5-d86d-4fe5-9bd5-c8fd5887a455",
    "status": "requested",
    "createdAt": "2024-05-06T09:39:13.9505828Z"
}

Check PDF to Image Job Status

Next, you can retrieve the job status by sending a request to the /v1/conversion/status/{jobID} endpoint with the job ID.

Curl

curl --location 'http://localhost:8003/v1/conversion/status/f58c9739-622e-41d4-9dd2-57a901dc13c3' \
  --output Output.pdf

JavaScript

const requestOptions = {
  method: "GET",
  redirect: "follow"
};

fetch("http://localhost:8003/v1/conversion/status/4413bbb5-6b26-4c07-9af2-c26cd2c42fe3", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:8003/v1/conversion/status/ef0766ab-bc74-456c-8143-782e730a89df");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

You will receive one of the following statuses until the job is completed. Upon completion, you will receive the actual output file.

Job Statuses:

• Queued:

{
    "jobID": "4b2782b2-9f08-478b-98fc-4464bd219ca0",
    "status": "queued"
}

• In Progress:

{
    "jobID": "ef0766ab-bc74-456c-8143-782e730a89df",
    "status": "in progress"
}

• Error:

{
    "jobID": "ef0766ab-bc74-456c-8143-782e730a89df",
    "status": "errror",
    "code": "500",
    "message": "Failed to convert the PDF to Images"        
}

NOTE

The Syncfusion Document Processing API is now available as a Docker-based solution. Try it out