Guide to Image to PDF Conversion Using Syncfusion API

9 May 20254 minutes to read

Converting Image files to PDF is simple. Customize conversion settings, like accessibility and archiving options, to suit your needs.

Convert Image to PDF

To convert the Images to PDF, send a request to the /v1/conversion/image-to-pdf endpoint, including both the image files as inputs and the settings JSON.

curl --location 'http://localhost:8003/v1/conversion/image-to-pdf' \
--form 'file1=@"page_0b199abad.jpeg"' \
--form 'file2=@"page_1d859a4b3.jpeg"' \
--form 'settings="{
  \"Files\": [
    {
      \"File\": \"file1\",
    },
    {
      \"File\": \"file2\",
    }
  ],
  \"Orientation\": Syncfusion.Pdf.PdfPageOrientation.Portrait,
  \"Margin\": 0,
  \"EnableSaveAsSeperateFile\": false,
  \"PageSize\": ImageToPdfPageSize.A4
}"'
const formdata = new FormData();
formdata.append("file1", fileInput.files[0], "page_0b199abad.jpeg");
formdata.append("file2", fileInput.files[0], "page_1d859a4b3.jpeg");
formdata.append("settings", "{\n  \"Files\": [\n    {\n      \"File\": \"file1\",\n    },\n    {\n      \"File\": \"file2\",\n    }\n  ],\n  \"Orientation\": Syncfusion.Pdf.PdfPageOrientation.Portrait,\n  \"Margin\": 0,\n  \"EnableSaveAsSeperateFile\": false,\n  \"PageSize\": ImageToPdfPageSize.A4\n}");

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

fetch("http://localhost:4000/v1/conversion/image-to-pdf", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:8003/v1/conversion/image-to-pdf");
var content = new MultipartFormDataContent();
content.Add(new StreamContent(File.OpenRead("page_0b199abad.jpeg")), "file1", "page_0b199abad.jpeg");
content.Add(new StreamContent(File.OpenRead("page_1d859a4b3.jpeg")), "file2", "page_1d859a4b3.jpeg");
content.Add(new StringContent("{
  \"Files\": [
    {
      \"File\": \"file1\",
    },
    {
      \"File\": \"file2\",
    }
  ],
  \"Orientation\": Syncfusion.Pdf.PdfPageOrientation.Portrait,
  \"Margin\": 0,
  \"EnableSaveAsSeperateFile\": false,
  \"PageSize\": ImageToPdfPageSize.A4
}"), "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 job to merge PDF documents 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 --location 'http://localhost:8003/v1/conversion/status/ef0766ab-bc74-456c-8143-782e730a89df' \
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));
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 Image to PDF"        
}

NOTE

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