Guide to PDF to Image Conversion Using Syncfusion API

9 May 20253 minutes to read

Converting an PDF document to Images is simple. Customize conversion settings, like accessibility and archiving options, to suit your needs.

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 --location 'http://localhost:8003/v1/conversion/pdf-to-image' \
--form 'file=@"invoice.pdf"' \
--form 'settings="{
  \"File\": \"file\",
  \"Password\": null,
  \"ImageFormat\": ImageFormats.PNG
}"'

JavaScript

const formdata = new FormData();
formdata.append("file", fileInput.files[0], "invoice.pdf");
formdata.append("settings", "{\n  \"File\": \"file\",\n  \"Password\": null,\n  \"ImageFormat\": ImageFormats.PNG\n}");

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

fetch("http://localhost:4000/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("invoice.pdf")), "file", "invoice.pdf");
content.Add(new StringContent("{
  \"File\": \"file\",
  \"Password\": null,
  \"ImageFormat\": ImageFormats.PNG
}"), "settings");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

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"
}

Poll the status of the Conversion Job

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/ef0766ab-bc74-456c-8143-782e730a89df' \

JavaScript

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

fetch("http://localhost:4000/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