Merging PDFs Using Syncfusion WEB API

24 Mar 20265 minutes to read

The Syncfusion Merge PDF Web API allows you to seamlessly combine multiple PDF documents into a single, unified PDF file using a simple and efficient process. By providing the required PDF files as input to the merge PDF document service, the engine preserves the original content, layout, and formatting of each document while arranging them in the specified order.

Merge PDF Documents

To merge PDF documents, send a request to the /v1/edit-pdf/merge endpoint, including both the PDF files as input and the settings as follows:

Curl

curl --location 'http://localhost:8003/v1/edit-pdf/merge' \
--form 'file1=@Input1.pdf' \
--form 'file2=@Input2.pdf' \
--form 'settings={
  "Files": [
    { "File": "file1" },
    { "File": "file2" }
  ],
  "PreserveBookmarks": true,
  "FolderPath": ""
}'

JavaScript

const formdata = new FormData();

formdata.append("files", fileInput.files[0], "Input1.pdf");
formdata.append("files", fileInput.files[0], "Input2.pdf");
formdata.append(
  "settings",
  JSON.stringify({
    Files: [
      { File: "file1" },
      { File: "file2" }
    ],
    PreserveBookmarks: true,
    FolderPath: ""
  })
);

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

fetch("http://localhost:8003/v1/edit-pdf/merge", 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/edit-pdf/merge");
var content = new MultipartFormDataContent();
content.Add(new StreamContent(File.OpenRead("Input1.pdf")), "file1", "Input1.pdf");
content.Add(new StreamContent(File.OpenRead("Input2.pdf")), "file2", "Input2.pdf");
var settings = new
{
    Files = new[]
    {
        new { File = "file1" },
        new { File = "file2" }
    },
    PreserveBookmarks = true,
    FolderPath = "",
    Password = (string?)null,
    PdfCompliance = "PDF/A-1B",
    EnableAccessibility = false
};

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());

Merge PDFs settings

Files

Specifies the list of PDF files to be merged into a single document. At least two PDF files are required.

PreserveBookmarks

Preserves the original bookmarks from the input PDF files in the merged output document.

FolderPath

Specifies the destination folder where the merged PDF file will be saved. If not provided, the output is stored in the default location.

Merge PDF Job Response

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

Check Merge PDF Job Status

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

Curl

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

JavaScript

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

fetch("http://localhost:8003/v1/edit-pdf/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/edit-pdf/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 document to PDF"        
}

NOTE

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