Full Working Example to Remove Annotation Objects from PDF with REST in Node.JS

This example demonstrates how to upload a PDF, delete all its annotations, and download the cleaned file using the GroupDocs.Annotation SDK.

const fs = require('fs');
const path = require('path');
const GroupDocsAnnotationCloud = require("@groupdocs/annotation-cloud");

// ==== Authentication =========================================================
const clientId = "YOUR_CLIENT_ID";
const clientSecret = "YOUR_CLIENT_SECRET";

const config = new GroupDocsAnnotationCloud.Configuration(clientId, clientSecret);
const annotationsApi = new GroupDocsAnnotationCloud.AnnotationsApi(config);
const storageApi = new GroupDocsAnnotationCloud.StorageApi(config);

// ==== Local & Remote file definitions =======================================
const localInputPath = path.resolve(__dirname, "input.pdf");
const localOutputPath = path.resolve(__dirname, "output.pdf");
const remoteFilePath = "input.pdf";

// ==== Main workflow ==========================================================
(async () => {
    // 1. Upload PDF to GroupDocs Cloud storage
    const fileBytes = fs.readFileSync(localInputPath);
    const uploadRequest = new GroupDocsAnnotationCloud.UploadFileRequest({
        path: remoteFilePath,
        file: fileBytes
    });
    await storageApi.uploadFile(uploadRequest);

    // 2. Build FileInfo object for the uploaded PDF
    const fileInfo = new GroupDocsAnnotationCloud.FileInfo({
        filePath: remoteFilePath
    });

    // 3. Retrieve all existing annotations
    const getAnnotationsRequest = new GroupDocsAnnotationCloud.GetAnnotationsRequest({
        fileInfo: fileInfo
    });
    const annotationsResult = await annotationsApi.getAnnotations(getAnnotationsRequest);
    const annotationIds = (annotationsResult.annotations || []).map(a => a.id);

    // 4. Delete all annotations (if any)
    if (annotationIds.length > 0) {
        const deleteRequest = new GroupDocsAnnotationCloud.DeleteAnnotationsRequest({
            fileInfo: fileInfo,
            annotationIds: annotationIds
        });
        await annotationsApi.deleteAnnotations(deleteRequest);
    }

    // 5. Download the cleaned PDF back to local storage
    const downloadRequest = new GroupDocsAnnotationCloud.DownloadFileRequest({
        path: remoteFilePath
    });
    const fileStream = await storageApi.downloadFile(downloadRequest);
    fs.writeFileSync(localOutputPath, fileStream);
    console.log(`All annotations removed. Clean file saved to ${localOutputPath}`);
})();

Note: This code example demonstrates the core functionality. Before using it in your project, make sure to update any file paths and configuration values to match your actual environment, verify that all required dependencies are properly installed, and test thoroughly in your development environment. If you encounter any issues, please refer to the official documentation or reach out to the support team for assistance.

Delete PDF Annotations via REST API Using cURL

Below are the cURL commands that perform the same annotation removal workflow through the GroupDocs.Annotation Cloud REST endpoints.

# 1. Obtain an access token
curl -X POST "https://api.groupdocs.cloud/v2.0/auth/token" \
     -H "Content-Type: application/json" \
     -d "{\"client_id\":\"YOUR_CLIENT_ID\",\"client_secret\":\"YOUR_CLIENT_SECRET\"}"

# 2. Upload the source PDF
curl -X PUT "https://api.groupdocs.cloud/v2.0/storage/file/input.pdf" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/pdf" \
     --data-binary "@input.pdf"

# 3. Retrieve annotation IDs
curl -X GET "https://api.groupdocs.cloud/v2.0/annotation/annotations?filePath=input.pdf" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

# 4. Delete all retrieved annotations
curl -X DELETE "https://api.groupdocs.cloud/v2.0/annotation/annotations?filePath=input.pdf" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d "{\"annotationIds\":[\"id1\",\"id2\"]}"

# 5. Download the cleaned PDF
curl -X GET "https://api.groupdocs.cloud/v2.0/storage/file/input.pdf" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -o output.pdf

For a complete list of endpoints and parameters, see the official API documentation.

How Remove Annotation Objects from PDF with REST in Node.JS Works

1. Authentication Setup - The Configuration class is instantiated with your clientId and clientSecret, creating an authenticated context for all subsequent API calls.

   const config = new GroupDocsAnnotationCloud.Configuration(clientId, clientSecret);
   

2. File Upload - UploadFileRequest sends the local PDF bytes to GroupDocs Cloud storage. The storageApi.uploadFile method handles the transfer.

   const uploadRequest = new GroupDocsAnnotationCloud.UploadFileRequest({
       path: remoteFilePath,
       file: fileBytes
   });
   await storageApi.uploadFile(uploadRequest);
   

3. Retrieve Annotations - GetAnnotationsRequest builds a request object with a FileInfo reference. The annotationsApi.getAnnotations call returns a collection of annotation objects, from which IDs are extracted.

   const getAnnotationsRequest = new GroupDocsAnnotationCloud.GetAnnotationsRequest({
       fileInfo: fileInfo
   });
   const annotationsResult = await annotationsApi.getAnnotations(getAnnotationsRequest);
   

4. Delete Annotations - If any IDs exist, DeleteAnnotationsRequest is populated and passed to annotationsApi.deleteAnnotations, which permanently removes the annotations from the stored PDF.

   const deleteRequest = new GroupDocsAnnotationCloud.DeleteAnnotationsRequest({
       fileInfo: fileInfo,
       annotationIds: annotationIds
   });
   await annotationsApi.deleteAnnotations(deleteRequest);
   

5. Download Clean PDF - Finally, DownloadFileRequest fetches the updated file, and fs.writeFileSync writes it to the local filesystem.

   const downloadRequest = new GroupDocsAnnotationCloud.DownloadFileRequest({
       path: remoteFilePath
   });
   const fileStream = await storageApi.downloadFile(downloadRequest);
   fs.writeFileSync(localOutputPath, fileStream);
   

For detailed class and method definitions, refer to the API reference.

Installing and Configuring GroupDocs.Annotation Cloud SDK for Node.js

The SDK is distributed as an npm package. Install it with the command below and then require it in your project.

npm install groupdocs-annotation-cloud

You can also download the latest package directly from the GitHub releases page or the official download URL.

After installation, import the library and create a configuration object as shown in the code example:

const GroupDocsAnnotationCloud = require("@groupdocs/annotation-cloud");
const config = new GroupDocsAnnotationCloud.Configuration("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET");

Make sure your runtime environment meets the Node.js version requirements and that you have a valid GroupDocs account to obtain the client credentials.

Annotation Removal Options and Settings

The SDK exposes several parameters you can tune:

• clientId / clientSecret - Credentials for OAuth authentication. Set them in the Configuration constructor.
• fileInfo.filePath - The path of the PDF in GroupDocs Cloud storage. Adjust this if you store files in a different folder.
• annotationIds - An array of IDs returned by GetAnnotations. Supplying a subset allows selective deletion.

Additional settings such as request timeouts and proxy configuration are available in the SDK documentation; see the official documentation for the full list.

Best Practices for Removing PDF Annotations via REST

• Validate Annotation IDs - Always check that the IDs you intend to delete exist; attempting to delete non‑existent IDs can cause a 404 error.
• Use HTTPS - All API calls must be made over HTTPS to protect your credentials and document data.
• Handle Large Files with Chunked Uploads - For PDFs larger than 100 MB, prefer the multipart upload endpoint to avoid timeouts.
• Log API Responses - Store request IDs and responses for audit trails and easier troubleshooting.
• Reuse Access Tokens - Cache the OAuth token until it expires to reduce authentication overhead.

Common Questions

• How do I authenticate with GroupDocs.Annotation Cloud API?
  Obtain a client ID and secret from your GroupDocs account, then request an access token via the OAuth endpoint. See the official documentation for details.

• Can I delete specific annotations instead of all?
  Yes, provide the IDs of the annotations you want to remove in the DeleteAnnotationsRequest. The SDK returns the list of annotation IDs after a GetAnnotations call.

• How can I remove Annotation objects from PDF with REST in Node.JS?
  Use the GroupDocs.Annotation Cloud SDK for Node.js to call the DeleteAnnotations endpoint after retrieving annotation IDs. The full workflow is demonstrated in the code example and cURL section of this guide.

• What licensing is required for production use?
  A paid license is needed for production. You can acquire a temporary license from the temporary license page while evaluating.

Further Reading

• Extract or Remove Annotations from PDF using REST API in Node.js
• Strikethrough Text in a PDF with Node.js and REST API
• Remove Annotations from PDF using REST API in Python

Edit Excel File in Node.js via REST - 5 Step Guide

1. Install the SDK and configure credentials: Set your CLIENT_ID and CLIENT_SECRET so the library can authenticate with GroupDocs Cloud.

const CLIENT_ID = "YOUR_CLIENT_ID";
const CLIENT_SECRET = "YOUR_CLIENT_SECRET";

const config = new GroupDocsEditorCloud.Configuration(CLIENT_ID, CLIENT_SECRET);
const editApi = new GroupDocsEditorCloud.EditApi(config);

2. Load the Excel workbook for editing: Use EditDocumentRequest to open the file stored in your cloud storage.

const editRequest = new GroupDocsEditorCloud.EditDocumentRequest({
    fileInfo: new GroupDocsEditorCloud.FileInfo({ filePath: "input.xlsx" })
});
const editResult = await editApi.editDocument(editRequest);

3. Retrieve the first worksheet and locate the target cell: The SDK returns a document object that contains worksheets and cells.

const worksheet = editResult.document.worksheets[0];
let targetCell = worksheet.cells.find(c => c.rowIndex === 0 && c.columnIndex === 0);

4. Update or create the cell value: Change the content of cell A1 (or add it if it does not exist).

if (!targetCell) {
    targetCell = new GroupDocsEditorCloud.Cell({
        rowIndex: 0,
        columnIndex: 0,
        value: "Edited via GroupDocs Editor Cloud"
    });
    worksheet.cells.push(targetCell);
} else {
    targetCell.value = "Edited via GroupDocs Editor Cloud";
}

5. Save the edited workbook back to storage: Provide an outputPath and call saveDocument.

const saveOptions = new GroupDocsEditorCloud.SaveOptions({ outputPath: "output.xlsx" });
const saveRequest = new GroupDocsEditorCloud.SaveDocumentRequest({
    documentId: editResult.documentId,
    document: editResult.document,
    saveOptions: saveOptions
});
await editApi.saveDocument(saveRequest);

For a full list of classes and methods, see the API reference.

Edit Excel File in Node.js via REST - Complete Code Example

The following example demonstrates how to edit Excel file in Node.js via REST using GroupDocs.Editor Cloud SDK.

const GroupDocsEditorCloud = require("@groupdocs/editor-cloud");

// Replace with your actual GroupDocs Cloud credentials
const CLIENT_ID = "YOUR_CLIENT_ID";
const CLIENT_SECRET = "YOUR_CLIENT_SECRET";

// Paths for the source Excel file and the edited result
const INPUT_FILE_PATH = "input.xlsx";
const OUTPUT_FILE_PATH = "output.xlsx";

async function editExcel() {
    // Configure the SDK
    const config = new GroupDocsEditorCloud.Configuration(CLIENT_ID, CLIENT_SECRET);
    const editApi = new GroupDocsEditorCloud.EditApi(config);

    // 1. Load the Excel workbook for editing
    const editRequest = new GroupDocsEditorCloud.EditDocumentRequest({
        fileInfo: new GroupDocsEditorCloud.FileInfo({
            filePath: INPUT_FILE_PATH
        })
    });

    const editResult = await editApi.editDocument(editRequest);
    const documentId = editResult.documentId;
    const document = editResult.document;

    // 2. Retrieve the first worksheet
    const worksheet = document.worksheets[0];

    // 3. Update cell A1 (rowIndex = 0, columnIndex = 0) with a new value
    let targetCell = worksheet.cells.find(c => c.rowIndex === 0 && c.columnIndex === 0);
    if (!targetCell) {
        targetCell = new GroupDocsEditorCloud.Cell({
            rowIndex: 0,
            columnIndex: 0,
            value: "Edited via GroupDocs Editor Cloud"
        });
        worksheet.cells.push(targetCell);
    } else {
        targetCell.value = "Edited via GroupDocs Editor Cloud";
    }

    // 4. Save the edited workbook back to storage
    const saveOptions = new GroupDocsEditorCloud.SaveOptions({
        outputPath: OUTPUT_FILE_PATH
    });

    const saveRequest = new GroupDocsEditorCloud.SaveDocumentRequest({
        documentId: documentId,
        document: document,
        saveOptions: saveOptions
    });

    const saveResult = await editApi.saveDocument(saveRequest);
    console.log(`Edited file saved to: ${saveResult.path}`);
}

// Execute the edit operation
editExcel().catch(error => {
    console.error("Error during Excel editing:", error);
});

Note: This code example demonstrates the core functionality. Before using it in your project, make sure to update any file paths and configuration values to match your actual environment, verify that all required dependencies are properly installed, and test thoroughly in your development environment. If you encounter any issues, please refer to the official documentation or reach out to the support team for assistance.

Update XLSX Sheet Using REST API in Node.js via cURL

Below is a quick walkthrough of the same operation using raw HTTP calls. Replace the placeholder values with your actual credentials and file names.

1. Obtain an access token

   curl -X POST "https://api.groupdocs.cloud/v2.0/connect/token" \
        -H "Content-Type: application/x-www-form-urlencoded" \
        -d "client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials"
   

   The response contains access_token.

2. Upload the source XLSX file

   curl -X POST "https://api.groupdocs.cloud/v2.0/storage/file/input.xlsx" \
        -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
        -F "file=@input.xlsx"
   

3. Edit the workbook (modify cell A1)

   curl -X POST "https://api.groupdocs.cloud/v2.0/editor/edit" \
        -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
              "fileInfo": { "filePath": "input.xlsx" },
              "options": {
                  "cells": [
                      { "rowIndex": 0, "columnIndex": 0, "value": "Edited via GroupDocs Editor Cloud" }
                  ]
              }
            }'
   

4. Download the edited file

   curl -X GET "https://api.groupdocs.cloud/v2.0/storage/file/output.xlsx" \
        -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
        -o output.xlsx
   

For more details on request payloads, see the official API documentation.

Prerequisites and Setup for GroupDocs.Editor Cloud SDK for Node.js

To start using the SDK, you need Node.js 14 or later and a GroupDocs Cloud account.

npm install groupdocs-editor-cloud

You can also download the latest package from the release page. After installation, create a client_id and client_secret in your GroupDocs Cloud dashboard and keep them safe.

What Makes GroupDocs.Editor Cloud SDK for Node.js Ideal for Modifying Excel Worksheets

• Full XLSX support - Load, edit, and save workbooks while preserving formulas, styles, and data validation.
• Cell‑level editing - Access individual cells, rows, or columns programmatically, which is perfect for updating reports or dashboards.
• Cloud storage integration - Work directly with files stored in GroupDocs Cloud without downloading them locally.
• Secure REST communication - All operations happen over HTTPS, and the SDK handles token management for you.

For a deeper dive, refer to the documentation.

Fine-Tuning Excel Editing Options in GroupDocs.Editor Cloud

The SDK exposes several options that let you control how the edited workbook is saved.

const saveOptions = new GroupDocsEditorCloud.SaveOptions({
    outputPath: "output.xlsx",
    // You can also set compression level, password protection, etc.
});

• outputPath - Destination path in cloud storage.
• compressionLevel - Reduce file size for large workbooks (available in the API reference).
• password - Protect the resulting file with a password if required.

Adjust these settings to match your project’s security and performance needs.

Performance Considerations for Editing XLSX Workbooks via REST

1. Reuse the configuration object - Creating a new Configuration for every request adds overhead. Keep a single instance for the lifetime of your application.
2. Batch cell updates - If you need to modify many cells, collect them in an array and send a single edit request instead of multiple calls.
3. Limit worksheet size - Very large worksheets increase memory consumption. Consider splitting data across multiple sheets when possible.
4. Avoid unnecessary saves - Only call saveDocument after all required changes are applied to reduce I/O operations.

Conclusion

Editing an Excel file in Node.js via REST becomes straightforward with the GroupDocs.Editor Cloud SDK for Node.js. You can programmatically load a workbook, modify cells, and save the result using just a few API calls or simple cURL commands. The SDK’s cloud‑based architecture eliminates the need for local Office installations and scales with your application’s workload. For production deployments, purchase a license that fits your usage pattern, and you can also obtain a temporary license for testing from the temporary license page. Start integrating Excel editing today and streamline your data‑processing pipelines.

FAQs

How do I edit an Excel file in Node.js via REST without writing custom HTTP code?
Use the GroupDocs.Editor Cloud SDK for Node.js, which abstracts the REST calls and lets you edit Excel file in Node.js via REST with simple method invocations.

Can I update an XLSX sheet using REST api Node.js for large files?
Yes. The SDK streams data and supports batch updates, making it suitable for large workbooks. Adjust compressionLevel and batch cell changes to improve performance.

What is the best way to modify Excel worksheet programmatically Node.js?
Work with the worksheet and cell objects returned by editDocument. This gives you full control over rows, columns, and cell values without leaving the Node.js environment.

Where can I find pricing and licensing information?
All licensing details, including pricing tiers and a temporary license for evaluation, are available on the temporary license page.

Read More

• Edit Excel Sheet via REST in Java
• Edit Excel Sheet using REST API in Python
• Best Practices for CSV Editor Development in Java