Merge pull request #2484 from syncfusion-content/503504-UG-Updation-HF

503504: Updated UG documentation for Web API

Author: DeepakRajSundar

Document-Processing-toc.html

@@ -7833,6 +7833,9 @@
 					<li>
 						<a href="/document-processing/web-apis/consume-apis/organize-pdf">Organize PDF</a>
 					</li>
+					<li>
+						<a href="/document-processing/web-apis/consume-apis/ocr-pdf">OCR PDF</a>
+					</li>
 				</ul>
 			</li>
 		</ul>

Document-Processing/Web-apis/consume-apis/compress-pdf.md

@@ -1,14 +1,14 @@
 ---
-title: Compress PDF Files Using Syncfusion Web API 
+title: Compress PDF Files Using Syncfusion Web API
 description: Reduce PDF file size with image optimization and structural compression while maintaining visual quality using Syncfusion compression Web API. 
 control: general
 documentation: UG
 ---
-# Guide to Compressing PDF Files with Syncfusion API 
+# Compressing PDF Files Using Syncfusion Web API
 
-The Compress PDF API allows you to reduce the size of a PDF document with various compression options.
+The Syncfusion Compress PDF Web API reduces the file size of PDF documents while maintaining acceptable visual quality. It optimizes images, fonts, metadata, and internal structures, producing smaller PDFs that are easier to store, share, and distribute. This is especially useful for email sharing, web delivery, and document archiving.
 
-## Flatten PDF Document
+## Compress PDF Document
 
 To compress a PDF document, send a request to the /v1/edit-pdf/compress endpoint with the input PDF file and compression options as shown below.
 
@@ -94,6 +94,38 @@ Console.WriteLine(await response.Content.ReadAsStringAsync());
 
 {% endtabs %}
 
+## Compress PDF settings
+
+**Password** 
+
+Specifies the password required to open and process a protected PDF file. 
+
+**ImageQuality** 
+
+Controls image compression quality. Lower values reduce file size.  
+
+**OptimizeFont** 
+
+Optimizes and subsets embedded fonts to reduce overall PDF size without affecting text appearance. 
+
+**RemoveMetadata** 
+
+Removes document metadata such as author, title, and creation details to reduce file size and improve privacy. 
+
+**OptimizePageContents** 
+
+Optimizes page content by removing unnecessary objects and streamlining internal PDF structures. 
+
+**FlattenFormFields** 
+
+Converts interactive form fields into static content to further reduce file size. 
+
+**FlattenAnnotations** 
+
+Converts annotations (such as comments and highlights) into static content to minimize PDF size. 
+
+## Compress PDF Job Response
+
 Once the request is sent, it will create a compression job to compress the PDF and return the job details as follows:
 
 ```
@@ -104,15 +136,15 @@ Once the request is sent, it will create a compression job to compress the PDF a
 }
 ```
 
-## Poll the status of the Compress PDF Job
+## Check Compress 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.
 
 {% tabs %}
 
 {% highlight c# tabtitle="Curl" %}
 
-curl --location 'http://localhost:8003/v1/conversion/status/9b131bfe-d4eb-4f1d-b946-46443a363eb5' \
+curl --location 'http://localhost:8003/v1/edit-pdf/status/9b131bfe-d4eb-4f1d-b946-46443a363eb5' \
   --output Output.pdf
 
 {% endhighlight %}
@@ -133,7 +165,7 @@ fetch("http://localhost:8003/v1/edit-pdf/status/4413bbb5-6b26-4c07-9af2-c26cd2c4
 {% highlight c# tabtitle="C#" %}
 
 var client = new HttpClient();
-var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:8003/v1/conversion/status/ef0766ab-bc74-456c-8143-782e730a89df");
+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());

Document-Processing/Web-apis/consume-apis/delete-pdf-pages.md

@@ -5,9 +5,9 @@ platform: document-processing
 control: general
 documentation: UG
 ---
-# How to Delete Pages from a PDF Using Syncfusion API
+# Delete Pages from PDF Using Syncfusion Web API 
 
-This feature allows you to delete pages in a PDF document. To perform this operation, you need to supply a PDF document as input to the Delete Pages API.
+The Syncfusion Delete PDF Pages Web API allows you to remove unwanted pages from a PDF document using a simple, API‑driven workflow. You can delete specific pages or page ranges while preserving the original layout, formatting, and quality of the remaining content. This feature is ideal for refining documents, removing sensitive information, or creating customized PDFs for specific use cases.
 
 ## Delete PDF Pages
 
@@ -88,6 +88,26 @@ Console.WriteLine(await response.Content.ReadAsStringAsync());
 
 {% endtabs %}
 
+## Delete PDF pages settings
+
+**Password** 
+
+Specifies the password required to open and process a protected PDF file. 
+
+**PageRanges** 
+
+Defines the page ranges to be deleted from the PDF. 
+
+**Start** 
+
+Specifies the starting page number of the deletion range. 
+
+**End** 
+
+Specifies the ending page number of the deletion range. 
+
+## Delete Pages Job Response 
+
 Once the request is sent, it will create a job to delete PDF pages and return the job details as follows:
 
 ```
@@ -98,15 +118,15 @@ Once the request is sent, it will create a job to delete PDF pages and return th
 }
 ```
 
-## Poll the status of the Delete Pages Job
+## Check Delete Pages 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.
 
 {% tabs %}
 
 {% highlight c# tabtitle="Curl" %}
 
-curl --location 'http://localhost:8003/v1/conversion/status/9b131bfe-d4eb-4f1d-b946-46443a363eb5' \
+curl --location 'http://localhost:8003/v1/edit-pdf/status/9b131bfe-d4eb-4f1d-b946-46443a363eb5' \
   --output Output.pdf
 
 {% endhighlight %}
@@ -128,7 +148,7 @@ fetch("http://localhost:8003/v1/edit-pdf/status/4413bbb5-6b26-4c07-9af2-c26cd2c4
 {% highlight c# tabtitle="C#" %}
 
 var client = new HttpClient();
-var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:8003/v1/conversion/status/ef0766ab-bc74-456c-8143-782e730a89df");
+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());

Document-Processing/Web-apis/consume-apis/excel-to-pdf.md

@@ -5,9 +5,9 @@ platform: document-processing
 control: general
 documentation: UG
 ---
-# Guide to Excel to PDF Conversion Using Syncfusion API
+# Converting Excel to PDF Using Syncfusion Web API 
 
-Converting an Excel document to PDF is simple. Customize conversion settings, like accessibility and archiving options, to suit your needs.
+The Syncfusion Excel to PDF Web API allows you to convert Excel workbooks into well‑formatted, high‑quality PDF files while preserving the structure and readability of worksheets. It supports accurate rendering of data such as tables, formulas (as values), charts, images, and multi‑sheet layouts in the resulting PDF. The conversion can be customized with options like accessibility tagging for assistive technologies and PDF/A compliance for long‑term archiving.  
 
 ## Convert Excel to PDF
 
@@ -73,6 +73,16 @@ Console.WriteLine(await response.Content.ReadAsStringAsync());
 
 {% endtabs %}
 
+## Excel to PDF settings
+**Password** 
+
+Specifies the password required to open a protected Word document before converting it to PDF. 
+
+**PdfCompliance** 
+
+Defines the PDF/A compliance level for archival and standards adherence. Supported levels include PDF/A‑1B, PDF/A‑2B, PDF/A‑3B, and PDF/A‑4. 
+
+## Excel to PDF Job Response 
 Once the request is sent, it will create a conversion job to convert the Excel document to PDF and return the job details as follows:
 
 ```
@@ -82,7 +92,7 @@ Once the request is sent, it will create a conversion job to convert the Excel d
     "createdAt": "2024-05-06T09:39:13.9505828Z"
 }
 ```
-## Poll the status of the Conversion Job
+## Check Excel to PDF Job Status
 
 Next, you can retrieve the job status by sending a request to the /v1/conversion/status/{jobID} endpoint with the job ID.
 

Document-Processing/Web-apis/consume-apis/flatten-pdf.md

@@ -1,15 +1,15 @@
 ---
-title: Flatten PDF Using Syncfusion Web API
+title: Flatten PDFs Using Syncfusion Web API
 description: Flatten annotations, form fields, and signatures to secure PDF content from editing using Syncfusion high‑security flattening Web API.
 platform: document-processing
 control: general
 documentation: UG
 ---
-# Guide to Flattening PDFs Using Syncfusion API
+# Flattening PDFs Using Syncfusion Web API 
 
-This feature enables you to flatten annotations and form fields in a PDF document. To use this functionality, you need to provide a PDF document as input to the Flatten PDF API.
+The Syncfusion Flatten PDF Web API enables you to permanently embed annotations and form field data into the PDF content. All interactive elements—such as form fields, comments, and highlights—are converted into static, non‑editable content while preserving the document’s appearance. This ensures consistent viewing across devices and makes the PDF suitable for final distribution, archiving, and compliance with workflows.
 
-## Flatten PDF Document
+## Flatten PDF Documents
 
 To flatten a PDF document, send a request to the /v1/edit-pdf/flatten endpoint with the input PDF and its options as shown below.
 
@@ -84,6 +84,22 @@ Console.WriteLine(await response.Content.ReadAsStringAsync());
 
 {% endtabs %}
 
+## Flatten PDFs settings
+
+**Password** 
+
+Specifies the password required to open and process a protected PDF file. 
+
+**FlattenFormFields** 
+
+Converts interactive form fields into static content, making them non‑editable in the output PDF. 
+
+**FlattenAnnotations** 
+
+Converts annotations (such as comments, highlights, and stamps) into permanent, non‑editable content in the PDF. 
+
+## Flatten PDF Job Response
+
 Once the request is sent, it will create a flatten job to flatten the PDF and return the job details as follows:
 
 ```
@@ -94,15 +110,15 @@ Once the request is sent, it will create a flatten job to flatten the PDF and re
 }
 ```
 
-## Poll the status of the Flatten Pages Job
+## Check Flatten 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.
 
 {% tabs %}
 
 {% highlight c# tabtitle="Curl" %}
 
-curl --location 'http://localhost:8003/v1/conversion/status/f58c9739-622e-41d4-9dd2-57a901dc13c3' \
+curl --location 'http://localhost:8003/v1/edit-pdf/status/f58c9739-622e-41d4-9dd2-57a901dc13c3' \
   --output Output.pdf
 --header 'Authorization: Bearer {{Placeholder for token}}'
 
@@ -125,7 +141,7 @@ fetch("http://localhost:8003/v1/edit-pdf/status/4413bbb5-6b26-4c07-9af2-c26cd2c4
 {% highlight c# tabtitle="C#" %}
 
 var client = new HttpClient();
-var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:8003/v1/conversion/status/ef0766ab-bc74-456c-8143-782e730a89df");
+var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:8003/v1/edit-pdf/status/ef0766ab-bc74-456c-8143-782e730a89df");
 request.Headers.Add("Authorization", "Bearer {{Placeholder for token}}");
 var response = await client.SendAsync(request);
 response.EnsureSuccessStatusCode();

Document-Processing/Web-apis/consume-apis/html-to-pdf.md

@@ -5,9 +5,9 @@ platform: document-processing
 control: general
 documentation: UG
 ---
-# Guide to Converting HTML to PDF Using Syncfusion API
+# Converting HTML to PDF Using Syncfusion Web API 
 
-With the Syncfusion document processing engine, you can easily convert an HTML template or URL to a PDF document. To convert an HTML template to a PDF document, you need to provide both the HTML template file and its assets.
+The Syncfusion HTML to PDF Web API allows you to convert web content into high‑quality PDF documents. It supports converting both static HTML templates and live web pages via URLs, ensuring accurate rendering of layouts, styles, images, and fonts. When converting an HTML template, you need to provide the main HTML file along with its dependent assets such as CSS files, images, fonts, and scripts, so the engine can fully render the content as it appears in a browser.
 
 ## Convert HTML to PDF
 
@@ -121,6 +121,80 @@ Console.WriteLine(await response.Content.ReadAsStringAsync());
 
 {% endtabs %}
 
+## HTML to PDF settings
+**PaperSize** 
+
+Defines the page size for the generated PDF (e.g., A4, Letter). 
+
+**Assets** 
+
+Specifies additional resources—such as CSS files, images, and fonts—required for converting HTML templates. 
+
+**IndexFile** 
+
+Indicates the main HTML file that serves as the entry point for the conversion. 
+
+**Settings** 
+
+Provides rendering and conversion options for the Blink engine used during HTML to PDF processing. 
+
+**RenderingEngine** 
+
+Specifies the browser engine used to render HTML content before generating the PDF. 
+
+**Url** 
+
+Defines the source URL or HTML location to be converted into a PDF. 
+
+**Orientation** 
+
+Defines the page orientation of the PDF, such as Portrait or Landscape. 
+
+**Rotation** 
+
+Specifies the rotation angle applied to the pages in the generated PDF. 
+
+**Margins** 
+
+Configures the margin size for all sides of each PDF page. 
+
+**AdditionalDelay** 
+
+Adds a wait time (in milliseconds) before conversion to ensure dynamic content fully loads. 
+
+**EnableLinks** 
+
+Preserves active, clickable hyperlinks within the generated PDF. 
+
+**EnableScripts** 
+
+Allows JavaScript execution during HTML rendering for dynamic content support. 
+
+**EnableForms** 
+
+Enables interactive form fields in the generated PDF document. 
+
+**EnableToc** 
+
+Generates a table of contents based on the HTML document structure. 
+
+**EnableBookmarks** 
+
+Creates PDF bookmarks for easier navigation within the document. 
+
+**SinglePagePdf** 
+
+Renders the entire HTML content into one continuous PDF page. 
+
+**ShowHeader** 
+
+Displays header content on each page of the generated PDF. 
+
+**ShowFooter** 
+
+Displays footer content on each page of the generated PDF.
+
+## HTML to PDF Job Response 
 To convert HTML to PDF, send a request to the /v1/conversion/html-to-pdf endpoint, including both the HTML file as input and its assets as follows:
 
 {% tabs %}
@@ -254,7 +328,7 @@ Once the request is sent, it will create a conversion job to convert HTML to PDF
 }
 ```
 
-## Poll the status of the Conversion Job
+## Check HTML to PDF Job Status 
 
 Next, you can retrieve the job status by sending a request to the /v1/conversion/status/{jobID} endpoint with the job ID.