Document Editor Cloud API

Browse our Products

Are you looking for an evaluation version of a product?

If so you can download any of the below versions for testing. The product will function as normal except for an evaluation limitation. At the time of purchase we provide a license file via email that will allow the product to work in its full capacity. If you would also like an evaluation license to test without any restrictions for 30 days, please follow the directions provided here.

Are you having troubles in downloading?

If you experience errors, when you try to download a file, make sure your network policies (enforced by your company or ISP) allow downloading ZIP and/or MSI files.

Installation
The package is available at PyPI and it can be installed via pip by executing following command:
pip install groupdocs-editor-cloud

Requirements

Python 2.7 or 3.4+
pip package manager
GroupDocs Cloud credentials — Client ID and Client Secret from the Dashboard

Dependencies

The SDK automatically installs the following packages:

Package	Constraint
urllib3	>= 1.15
six	>= 1.10
certifi	—
python-dateutil	—

Edit 40+ Document Formats in Cloud via REST

GroupDocs.Editor Cloud SDK for Python is a REST API designed to integrate document editing capabilities into Python web apps, scripts, and automation workflows. Supporting over 40 file formats, this API allows you to easily edit Word documents, spreadsheets, presentations, and more directly from the cloud without the need for third-party software like MS Office. Features include handling password-protected files, multi-language support, and customizable formatting options. Developers can perform file operations such as loading, editing, and saving documents across web, desktop, and mobile platforms with ease.

Editing Word Processing Documents

Supported formats - DOC, DOCX, DOCM, DOT, DOTM, DOTX, ODT, OTT, RTF, and more.
Cloud storage workflow - Upload, edit, and save Word processing documents directly from cloud storage.
Password-protected documents - Handle password-protected Word documents during load and save.
Load options - Enable pagination, extract fonts, and handle multi-language information.

Editing Spreadsheet Documents

Supported formats - XLS, XLSX, XLSM, XLSB, ODS, CSV, TSV, and others.
Worksheet selection - Load spreadsheets into editable HTML and work on specific worksheets.
Hidden worksheets - Exclude hidden worksheets from editing if desired.
Password protection - Handle password-protected spreadsheet documents.

Editing Presentation Documents

Supported formats - PPT, PPTX, PPTM, PPSX, POTX, ODP, OTP, and more.
Slide selection - Load specific slides from presentations for editing.
Hidden slides - Include or exclude hidden slides during the editing process.

Editing Text Documents

Plain text support - Handle TXT files and recognize simple structures like lists and indents.
Save to Word format - Save edited TXT files back to Word processing format if needed.
Formatting options - Control leading and trailing spaces and enable pagination in output HTML.

Editing Delimiter-Separated Values (DSV) Documents

Custom delimiters - Support CSV, TSV, and files with custom separators.
Data conversion - Specify custom separators and handle date/numeric data conversion.
Consecutive delimiters - Option to treat consecutive delimiters as a single entity.

Document Information Retrieval

File details - Retrieve file extension, document size, page count, and password protection status.
Supported formats info - Get the full list of editable file types from the API.

File and Storage Operations

Download files - Download files from cloud storage via the API.
File versions - Retrieve specific file versions from storage systems that support versioning.
Storage checks - Verify cloud storage existence and list files within folders.

Licensing and Authentication

Evaluation Mode - Try the API with a free trial account.
Secure Authentication - Use Client ID and Client Secret for secure API access.
MIT License - The Python SDK is licensed under the MIT License.

Supported Document Formats

GroupDocs.Editor Cloud supports 40+ file formats with editing and auto-detection capabilities:

Word Processing: DOC, DOCX, DOCM, DOT, DOTM, DOTX, ODT, OTT, RTF, FlatOPC, WordML
Spreadsheets: XLS, XLT, XLSX, XLSM, XLTX, XLTM, XLSB, XLAM, ODS, FODS, DIF, CSV, TSV, DSV
Presentations: PPT, PPTX, PPTM, PPS, PPSX, PPSM, POT, POTX, POTM, ODP, OTP
Other: TXT, HTML, XML

Supported operations vary by format. For the complete format matrix, see the documentation.

Quick Start

Get your API credentials

To use GroupDocs.Editor Cloud, sign up at GroupDocs.Cloud Dashboard and get your Client ID and Client Secret.

Initialize the API

Use the following code to start using the GroupDocs.Editor Cloud SDK for Python:

import groupdocs_editor_cloud

# Get your ClientId and ClientSecret at https://dashboard.groupdocs.cloud
client_id = "YourClientId"
client_secret = "YourClientSecret"

# Create API configuration
configuration = groupdocs_editor_cloud.Configuration(client_id, client_secret)
configuration.api_base_url = "https://api.groupdocs.cloud"

# Create instance of the Edit API
edit_api = groupdocs_editor_cloud.EditApi.from_config(configuration)

Edit a Word document

Once initialized, use this basic example to load a DOCX file, edit its HTML representation, and save the result:

import groupdocs_editor_cloud

edit_api = groupdocs_editor_cloud.EditApi.from_keys("YourClientId", "YourClientSecret")
file_api = groupdocs_editor_cloud.FileApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("WordProcessing/password-protected.docx", None, None, "password")
load_options = groupdocs_editor_cloud.WordProcessingLoadOptions()
load_options.file_info = file_info
load_options.output_path = "output"
load_result = edit_api.load(groupdocs_editor_cloud.LoadRequest(load_options))

html_file = file_api.download_file(groupdocs_editor_cloud.DownloadFileRequest(load_result.html_path))
with open(html_file, "r") as file:
    html = file.read()

html = html.replace("Sample test text", "Hello world")

with open(html_file, "w") as file:
    file.write(html)

file_api.upload_file(groupdocs_editor_cloud.UploadFileRequest(load_result.html_path, html_file))

save_options = groupdocs_editor_cloud.WordProcessingSaveOptions()
save_options.file_info = file_info
save_options.output_path = "output/edited.docx"
save_options.html_path = load_result.html_path
save_options.resources_path = load_result.resources_path
save_result = edit_api.save(groupdocs_editor_cloud.SaveRequest(save_options))

print("Document edited: " + save_result.path)

With this quick start guide, you’re all set to begin editing documents using GroupDocs.Editor Cloud in your Python applications. For more details, visit the documentation.

Get Supported File Types

Retrieve the full list of supported file formats available through the Editor API.

import groupdocs_editor_cloud

info_api = groupdocs_editor_cloud.InfoApi.from_keys("YourClientId", "YourClientSecret")

result = info_api.get_supported_file_formats()

for fmt in result.formats:
    print(fmt.file_format)

Get Document Information

Retrieve document metadata such as page count and password protection status.

import groupdocs_editor_cloud

info_api = groupdocs_editor_cloud.InfoApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("WordProcessing/password-protected.docx", None, None, "password")
result = info_api.get_info(groupdocs_editor_cloud.GetInfoRequest(file_info))

print("Page count = " + str(result.page_count))

Edit Spreadsheet Document

Load a specific worksheet from an XLSX file, edit its HTML content, and save back to spreadsheet format.

import groupdocs_editor_cloud

edit_api = groupdocs_editor_cloud.EditApi.from_keys("YourClientId", "YourClientSecret")
file_api = groupdocs_editor_cloud.FileApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("Spreadsheet/four-sheets.xlsx")
load_options = groupdocs_editor_cloud.SpreadsheetLoadOptions()
load_options.file_info = file_info
load_options.output_path = "output"
load_options.worksheet_index = 0
load_result = edit_api.load(groupdocs_editor_cloud.LoadRequest(load_options))

html_file = file_api.download_file(groupdocs_editor_cloud.DownloadFileRequest(load_result.html_path))
with open(html_file, "r") as file:
    html = file.read()

html = html.replace("This is sample sheet", "This is sample sheep")

with open(html_file, "w") as file:
    file.write(html)

file_api.upload_file(groupdocs_editor_cloud.UploadFileRequest(load_result.html_path, html_file))

save_options = groupdocs_editor_cloud.SpreadsheetSaveOptions()
save_options.file_info = file_info
save_options.output_path = "output/edited.xlsx"
save_options.html_path = load_result.html_path
save_options.resources_path = load_result.resources_path
save_result = edit_api.save(groupdocs_editor_cloud.SaveRequest(save_options))

print("Document edited: " + save_result.path)

Edit Presentation Document

Load a specific slide from a PPTX file, edit its HTML content, and save back to presentation format.

import groupdocs_editor_cloud

edit_api = groupdocs_editor_cloud.EditApi.from_keys("YourClientId", "YourClientSecret")
file_api = groupdocs_editor_cloud.FileApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("Presentation/with-notes.pptx")
load_options = groupdocs_editor_cloud.PresentationLoadOptions()
load_options.file_info = file_info
load_options.output_path = "output"
load_options.slide_number = 0
load_result = edit_api.load(groupdocs_editor_cloud.LoadRequest(load_options))

html_file = file_api.download_file(groupdocs_editor_cloud.DownloadFileRequest(load_result.html_path))
with open(html_file, "r") as file:
    html = file.read()

html = html.replace("Slide sub-heading", "Hello world!")

with open(html_file, "w") as file:
    file.write(html)

file_api.upload_file(groupdocs_editor_cloud.UploadFileRequest(load_result.html_path, html_file))

save_options = groupdocs_editor_cloud.PresentationSaveOptions()
save_options.file_info = file_info
save_options.output_path = "output/edited.pptx"
save_options.html_path = load_result.html_path
save_options.resources_path = load_result.resources_path
save_result = edit_api.save(groupdocs_editor_cloud.SaveRequest(save_options))

print("Document edited: " + save_result.path)

Edit DSV Document

Load a delimiter-separated values file, edit its HTML representation, and save back to TSV format.

import groupdocs_editor_cloud

edit_api = groupdocs_editor_cloud.EditApi.from_keys("YourClientId", "YourClientSecret")
file_api = groupdocs_editor_cloud.FileApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("Spreadsheet/sample.tsv")
load_options = groupdocs_editor_cloud.DelimitedTextLoadOptions()
load_options.file_info = file_info
load_options.output_path = "output"
load_result = edit_api.load(groupdocs_editor_cloud.LoadRequest(load_options))

html_file = file_api.download_file(groupdocs_editor_cloud.DownloadFileRequest(load_result.html_path))
with open(html_file, "r") as file:
    html = file.read()

html = html.replace("32", "66")

with open(html_file, "w") as file:
    file.write(html)

file_api.upload_file(groupdocs_editor_cloud.UploadFileRequest(load_result.html_path, html_file))

save_options = groupdocs_editor_cloud.DelimitedTextSaveOptions()
save_options.file_info = file_info
save_options.output_path = "output/edited.tsv"
save_options.html_path = load_result.html_path
save_options.resources_path = load_result.resources_path
save_result = edit_api.save(groupdocs_editor_cloud.SaveRequest(save_options))

print("Document edited: " + save_result.path)

Edit Text Document

Load a plain text file, edit its HTML representation, and save the result.

import groupdocs_editor_cloud

edit_api = groupdocs_editor_cloud.EditApi.from_keys("YourClientId", "YourClientSecret")
file_api = groupdocs_editor_cloud.FileApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_editor_cloud.FileInfo("Text/document.txt")
load_options = groupdocs_editor_cloud.TextLoadOptions()
load_options.file_info = file_info
load_options.output_path = "output"
load_result = edit_api.load(groupdocs_editor_cloud.LoadRequest(load_options))

html_file = file_api.download_file(groupdocs_editor_cloud.DownloadFileRequest(load_result.html_path))
with open(html_file, "r") as file:
    html = file.read()

html = html.replace("Page Text", "New Text")

with open(html_file, "w") as file:
    file.write(html)

file_api.upload_file(groupdocs_editor_cloud.UploadFileRequest(load_result.html_path, html_file))

save_options = groupdocs_editor_cloud.TextSaveOptions()
save_options.file_info = file_info
save_options.output_path = "output/edited.txt"
save_options.html_path = load_result.html_path
save_options.resources_path = load_result.resources_path
save_result = edit_api.save(groupdocs_editor_cloud.SaveRequest(save_options))

print("Document edited: " + save_result.path)

Sample Projects on GitHub

The GroupDocs.Editor Cloud Python Samples repository includes ready-to-run examples covering:

Category	Examples
GetSupportedFileTypes	Supported file types
GetInfo	Document information (page count, password status)
EditOperations — Word	Edit word processing documents (including password-protected)
EditOperations — Spreadsheet	Edit spreadsheet documents with worksheet selection
EditOperations — Presentation	Edit presentation documents with slide selection
EditOperations — DSV	Edit delimiter-separated values documents (CSV, TSV)
EditOperations — Text	Edit plain text documents

How to run the examples

Clone or download the samples repository
Edit Examples/RunExamples.py and set your client_id and client_secret
Go to the Examples directory
Run pip install groupdocs-editor-cloud -U
Execute python RunExamples.py

For more details, visit Getting Started.