Edit Word Documents in Java

Mon, 28 Sep 2026 16:09:16 +0000

Editing Microsoft Word files remotely is a common challenge when building collaborative Java applications. GroupDocs.Editor Cloud SDK for Java provides a powerful REST‑based library that lets you edit Word documents in Java without handling file parsing yourself. In this guide you will learn how to authenticate, replace text, invoke the edit endpoint, and download the updated DOCX, all with clear code examples and performance tips.

How to Edit Word Documents in Java - Step by Step

Configure API client with your credentials: Create a Configuration object, set clientId, clientSecret, and the base URL, then instantiate ApiClient and the required APIs.

Configuration config = new Configuration();
config.setClientId("YOUR_CLIENT_ID");
config.setClientSecret("YOUR_CLIENT_SECRET");
config.setBaseUrl("https://api.groupdocs.cloud");

ApiClient apiClient = new ApiClient(config);
EditorApi editorApi = new EditorApi(apiClient);
FilesApi filesApi = new FilesApi(apiClient);

Prepare FileInfo for the source DOCX: Define the path of the input file stored in GroupDocs Cloud storage.

FileInfo fileInfo = new FileInfo();
fileInfo.setFilePath("input.docx");

Define ReplaceText operation: Create a ReplaceText instance with the text you want to replace and add it to a list.

ReplaceText replace = new ReplaceText();
replace.setOldValue("Hello");
replace.setNewValue("Hi");
List<ReplaceText> replaceList = new ArrayList<>();
replaceList.add(replace);

Build EditDocumentOptions and call editDocument: Combine the file info, edit options, and output settings, then invoke the editDocument method. This is the core step where you actually edit Word documents in Java.

EditOptions editOptions = new EditOptions();
editOptions.setReplaceText(replaceList);

EditDocumentOptions options = new EditDocumentOptions();
options.setFileInfo(fileInfo);
options.setOutputPath("output.docx");
options.setFormat("docx");
options.setEditOptions(editOptions);

EditDocumentRequest editRequest = new EditDocumentRequest(options);
EditDocumentResult editResult = editorApi.editDocument(editRequest);
System.out.println("Document edited. Document ID: " + editResult.getDocumentId());

Download the edited DOCX file: Use FilesApi to retrieve the edited file from cloud storage.

DownloadFileRequest downloadRequest = new DownloadFileRequest("output.docx");
InputStream inputStream = filesApi.downloadFile(downloadRequest);
try (FileOutputStream outputStream = new FileOutputStream("downloaded_output.docx")) {
    byte[] buffer = new byte[8192];
    int bytesRead;
    while ((bytesRead = inputStream.read(buffer)) != -1) {
        outputStream.write(buffer, 0, bytesRead);
    }
    System.out.println("Edited document downloaded as downloaded_output.docx");
}

For detailed class information, refer to the EditorApi reference page.

Full Working Example for Editing Word Documents in Java

The following example demonstrates how to edit a DOCX file by replacing text using GroupDocs.Editor Cloud SDK for Java.

import com.groupdocs.editor.cloud.api.EditorApi;
import com.groupdocs.editor.cloud.api.FilesApi;
import com.groupdocs.editor.cloud.client.ApiClient;
import com.groupdocs.editor.cloud.client.ApiException;
import com.groupdocs.editor.cloud.client.Configuration;
import com.groupdocs.editor.cloud.model.EditDocumentOptions;
import com.groupdocs.editor.cloud.model.EditDocumentResult;
import com.groupdocs.editor.cloud.model.EditOptions;
import com.groupdocs.editor.cloud.model.FileInfo;
import com.groupdocs.editor.cloud.model.ReplaceText;
import com.groupdocs.editor.cloud.model.requests.EditDocumentRequest;
import com.groupdocs.editor.cloud.model.requests.DownloadFileRequest;

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

public class GroupDocsEditorExample {
    public static void main(String[] args) {
        // Configuration – replace with your actual credentials
        Configuration config = new Configuration();
        config.setClientId("YOUR_CLIENT_ID");
        config.setClientSecret("YOUR_CLIENT_SECRET");
        config.setBaseUrl("https://api.groupdocs.cloud");

        ApiClient apiClient = new ApiClient(config);
        EditorApi editorApi = new EditorApi(apiClient);
        FilesApi filesApi = new FilesApi(apiClient);

        // Input and output file paths in the cloud storage
        String inputPath = "input.docx";
        String outputPath = "output.docx";

        try {
            // Prepare file information
            FileInfo fileInfo = new FileInfo();
            fileInfo.setFilePath(inputPath);

            // Define replace text operation
            ReplaceText replace = new ReplaceText();
            replace.setOldValue("Hello");
            replace.setNewValue("Hi");
            List<ReplaceText> replaceList = new ArrayList<>();
            replaceList.add(replace);

            // Set edit options
            EditOptions editOptions = new EditOptions();
            editOptions.setReplaceText(replaceList);

            // Build edit document options
            EditDocumentOptions options = new EditDocumentOptions();
            options.setFileInfo(fileInfo);
            options.setOutputPath(outputPath);
            options.setFormat("docx");
            options.setEditOptions(editOptions);

            // Execute edit operation
            EditDocumentRequest editRequest = new EditDocumentRequest(options);
            EditDocumentResult editResult = editorApi.editDocument(editRequest);
            System.out.println("Document edited. Document ID: " + editResult.getDocumentId());

            // Download the edited document
            DownloadFileRequest downloadRequest = new DownloadFileRequest(outputPath);
            InputStream inputStream = filesApi.downloadFile(downloadRequest);
            try (FileOutputStream outputStream = new FileOutputStream("downloaded_output.docx")) {
                byte[] buffer = new byte[8192];
                int bytesRead;
                while ((bytesRead = inputStream.read(buffer)) != -1) {
                    outputStream.write(buffer, 0, bytesRead);
                }
                System.out.println("Edited document downloaded as downloaded_output.docx");
            } finally {
                if (inputStream != null) {
                    inputStream.close();
                }
            }
        } catch (ApiException apiEx) {
            System.err.println("API error: " + apiEx.getMessage());
        } catch (IOException ioEx) {
            System.err.println("IO error: " + ioEx.getMessage());
        }
    }
}

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.

Modify Word Documents via REST in Java Using cURL

Below is a cURL workflow that performs the same text‑replacement operation without writing Java code. It is useful for quick testing or integration with other services.

Obtain an access token (replace placeholders with your credentials).

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

Upload the source DOCX to your cloud storage.

curl -X PUT "https://api.groupdocs.cloud/v2.0/storage/file/input.docx" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F "file=@/path/to/local/input.docx"

Call the editDocument endpoint with a JSON payload that defines the replace operation.

curl -X POST "https://api.groupdocs.cloud/v2.0/editor/edit/document" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "fileInfo": { "filePath": "input.docx" },
        "outputPath": "output.docx",
        "format": "docx",
        "editOptions": {
            "replaceText": [
                { "oldValue": "Hello", "newValue": "Hi" }
            ]
        }
      }'

Download the edited file once the operation succeeds.

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

For the full REST specification, see the API reference.

Installing and Configuring GroupDocs.Editor Cloud SDK for Java

Add the SDK to your Maven project using the provided dependency snippet.


    com.groupdocs
    groupdocs-editor-cloud
    25.7

Download the latest JARs from the download page.
Make sure your Java runtime is version 8 or higher and that you have a valid GroupDocs Cloud account with client ID and secret.

Key Features of GroupDocs.Editor Cloud SDK for Java

Full Word Editing - Replace text, images, and tables in DOCX, DOC, and ODT formats.
Cloud Storage Integration - Works directly with GroupDocs Cloud storage, eliminating local file handling.
REST API Powered - All operations are performed through secure HTTP calls, ideal for micro‑service architectures.
Streaming Download - Large documents are streamed to avoid high memory consumption.
Extensible Options - Fine‑tune editing behavior via EditOptions (e.g., replace text, remove comments).

For deeper details, refer to the official documentation.

Configuring Document Editing Options

The EditOptions object lets you specify what changes to apply. In the example we used replaceText, but you can also configure other actions such as removing comments or updating fields.

EditOptions editOptions = new EditOptions();
editOptions.setReplaceText(replaceList); // replaceList defined earlier

Additional options like removeComments or updateFields are documented in the API reference.

Performance Considerations for Word Editing via REST

Use Streaming: The SDK streams file content, which reduces heap usage for large DOCX files.
Batch Replacements: Combine multiple ReplaceText objects in a single request to avoid repeated network calls.
Keep Files in Cloud: Performing edit operations directly on cloud‑stored files avoids the overhead of uploading and downloading large binaries multiple times.
Reuse ApiClient: Instantiate ApiClient once and reuse it for multiple edit operations to benefit from connection pooling.

Conclusion

Editing Word documents in Java becomes straightforward with the GroupDocs.Editor Cloud SDK for Java. By following the steps, code example, and cURL workflow presented here, you can integrate powerful document‑editing capabilities into any Java backend service. Remember to secure your client credentials, test with a temporary license from the temporary license page, and upgrade to a production license when you move to live environments. Happy coding!

FAQs

How can I edit Word documents in Java using a REST API?
Use the editDocument endpoint of the GroupDocs.Editor Cloud SDK for Java. Send a JSON payload that defines the replace operations, and the service returns the edited DOCX.
What is the best way to authenticate calls to the Editor API?
Create a Configuration object with your client ID and client secret, then let the SDK obtain an OAuth token automatically. See the official documentation for more details.
Can I replace several placeholders in one request?
Yes. Add multiple ReplaceText entries to the replaceText list inside EditOptions. The SDK processes all replacements in a single edit call.
Is there a limit on the size of the Word file I can edit?
The cloud service handles files up to several hundred megabytes, but for optimal performance keep files under 100 MB and use streaming download to avoid memory spikes.

java document manipulation on Document Processing REST APIs | GroupDocs Cloud