Installation

The package is available at PyPI and it can be installed via pip by executing following command:

pip install groupdocs-conversion-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:

Document Conversion Python Cloud REST API

GroupDocs.Conversion Cloud SDK for Python offers a robust solution for seamless document conversion across 50+ file formats, including PDF, DOCX, XLSX, and PPTX, without the need for any third-party tools. Developers can easily integrate this API into their Python web apps, scripts, and automation workflows to convert entire documents or specific pages, auto-detect source formats, apply watermarks, replace missing fonts, and manage file encryption. Additional features include batch conversion, custom conversion logic, multi-format output, and the ability to track conversion progress. This versatile API also supports advanced customization options for managing fonts, spreadsheet sheet selection, and even Optical Character Recognition (OCR) for image-based text extraction. GroupDocs.Conversion Cloud SDK ensures smooth integration into your cloud-based Python apps, offering efficient, high-quality document handling.

Document Conversion

Convert Documents - Convert documents across many formats like PDF, DOCX, XLSX, PPTX.
Convert Specific Pages - Convert selected pages or ranges of a document.
Auto-detect Document Format - Detect source format automatically, no file extension needed.
Load Documents with Options - Load docs with options: passwords, custom fonts, sheet selection.
Font Replacement - Replace missing fonts with alternatives during conversion.
Watermarking - Add custom text or image watermarks to any page.
Page-by-Page Conversion - Convert documents page by page or via custom ranges.
Resolution and Quality Control - Adjust output resolution and quality for images and text.
Password Protection - Add password protection to output files when supported.
Batch Conversion - Convert multiple documents in one batch operation.
Custom Conversion - Apply custom logic and parameters with advanced options.
Multi-format Output - Convert one document into multiple formats at once.
Conversion Tracking - Track conversion status in real time within your app.
Advanced Watermarking - Customize watermark position, size, color, transparency.
Language Translation - Combine conversion with translation for multilingual docs.
Document Merge - Merge multiple documents into one output file.

Document Information Extraction

Basic Document Information - Get basic info such as file type and page count.
CAD Information - Extract CAD layers and layout details.
Email Information - Extract folder structure and metadata from email files.
PDF Information - Get PDF details like printing restrictions and metadata.
Project Management Information - Get project data like start/end dates from files.
Text Content Extraction - Extract raw or formatted text from documents.
Image Extraction - Extract images embedded in documents.
Metadata Extraction - Retrieve metadata like author, title, dates.
Table of Contents Extraction - Extract the table of contents from documents.
Field Data Extraction - Extract form field data from PDFs or HTML.
OCR Support - Use OCR to extract text from images or scans.

API and SDK Features

Supported Formats Info - Get full list of supported conversion formats.
Document Conversion Endpoint - Use core endpoint for document conversion.
File Management Endpoints - Upload, download, copy, move, delete files in cloud.
Folder Management Endpoints - Create, copy, move, delete folders in cloud storage.
Storage Information Endpoints - Get cloud storage usage and file details.
SDK Availability - SDKs for .NET, Java, PHP, Node.js, Python, Ruby with examples.
API Explorer - Test API endpoints via built‑in Swagger UI.
Cross-Platform SDKs - Cross‑platform SDKs for .NET, Java, PHP, Python, Ruby, Node.js.
Custom Callbacks - Implement callbacks to monitor conversion status in real time.
Advanced API Customization - Configure API for large files, timeouts, retries.
Localization Support - Support multiple languages and regional settings.
API Rate Limiting - Manage API rate limits for balanced usage.

Load Options

CAD Files Load Options - Set CAD options: layout name, background color, drawing type.
Spreadsheet Files Load Options - Configure fonts, gridlines, ranges, skip empty rows/cols.
CSV Files Load Options - Set custom separators, encoding, auto formula conversion.
Diagram Files Load Options - Set default fonts for diagram conversion.
Email Files Load Options - Preserve email metadata, display options, folder structure.
OneNote Files Load Options - Handle fonts, sections, and password protection for OneNote.
PDF Files Load Options - Control password, annotations, form flattening, embedded files.
Presentation Files Load Options - Manage hidden slides, password protection, default fonts.
Text Files Load Options - Control numbering detection and formatting for texts.
Word Processing Files Load Options - Handle track changes, comments, and passwords in Word docs.
Web Files Load Options - Convert web docs with/without page numbers and embedded resources.
Vector Image Support - Convert SVG, WMF, EMF vector images while retaining scalability.
Multi-page TIFF Support - Convert selected pages of multi‑page TIFFs with custom order.
Encoding Detection - Automatically detect text encoding for accurate conversion.
HTML Load Options - Convert HTML with control over embedded resources and media.
PDF Digital Signatures - Manage PDF digital signatures for authenticity during conversion.

Storage API Features

Check Storage Existence - Verify cloud storage availability for file management.
Check File/Folder Existence - Ensure files/folders exist in cloud storage before processing.
Retrieve Storage Space Usage - Monitor storage quotas and usage to avoid limits.
Retrieve File Versions - List stored file versions for effective version control.
File Upload with Overwrite - Upload files with option to overwrite existing versions.
Versioning Control - Manage file versions, restore previous ones, track changes.
File Metadata Retrieval - Access file metadata like size, format, creation date.
Folder Synchronization - Sync local and cloud folders for up‑to‑date versions.
Storage Quota Management - Monitor and manage storage quotas with real‑time alerts.

Docker and Self-Hosting

Self-hosting in Docker - Deploy GroupDocs.Conversion via Docker with custom config and storage.
Google Cloud Storage Integration - Connect Google Cloud storage for streamlined file management.
AWS S3 Cloud Storage Integration - Integrate AWS S3 storage with credentials and region settings.
Auto-scaling - Implement auto‑scaling to handle fluctuating workloads.
Persistent Storage - Use persistent volumes for Docker containers to retain data.
Container Health Monitoring - Set up health checks and auto‑recovery for Docker containers.
Customized Docker Images - Build custom Docker images with dependencies and optimizations.

Licensing and Authentication

Evaluation Mode - Convert first two pages with watermarks during trial.
Secure Authentication - Use ClientId and ClientSecret for secure API access.
Custom Licensing Models - Implement per‑user or per‑usage licensing models.
Multi-tenant Authentication - Support multi‑tenant authentication for multiple organizations.
Token Expiry Management - Manage token expiration and refresh JWTs for long‑term access.
Trial and Subscription Management - Automate trial-to-paid transitions with feature unlocks.

Supported Document Formats

• Text Formats: DOC, DOCX, TXT, RTF
• Spreadsheet Formats: XLS, XLSX, XLSB, XLSM, CSV, ODS, XLS2003
• Presentation Formats: PPT, PPTX, PPS, PPSX, ODP
• Image Formats: BMP, GIF, JPEG, JPG, PNG, TIF, TIFF, ICO
• Email Formats: MSG, EML, EMLX, MHT
• Web Formats: HTM, HTML
• PDF Format: PDF (includes password-protected PDFs)
• Diagram Formats: VSD, VSDX, VSS, VST, VDW, VSX, VTX
• Project Management Formats: MPP, MPT
• Other Formats: DWG, DXF, PSD, SVG, XPS

Quick Start

Get your API credentials

To use GroupDocs.Conversion 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.Conversion Cloud SDK for Python:

import groupdocs_conversion_cloud

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

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

# Create instance of the Convert API
convert_api = groupdocs_conversion_cloud.ConvertApi.from_config(configuration)

Convert a document (direct, no cloud storage)

Once initialized, use this basic example to convert a local document and receive the result directly:

import groupdocs_conversion_cloud

client_id = "YourClientId"
client_secret = "YourClientSecret"

# Create instance of the API
convert_api = groupdocs_conversion_cloud.ConvertApi.from_keys(client_id, client_secret)

# Prepare request: output format and local file path
request = groupdocs_conversion_cloud.ConvertDocumentDirectRequest("pdf", "input.docx")

# Convert and save the result
result = convert_api.convert_document_direct(request)

with open("output.pdf", "wb") as f:
    f.write(result)

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

Convert Documents Using Cloud Storage

This example uploads a file to GroupDocs Cloud storage, converts it, and downloads the result — ideal for server-side workflows that manage files in the cloud.

import groupdocs_conversion_cloud

client_id = "YourClientId"
client_secret = "YourClientSecret"

# Create instances of the APIs
file_api = groupdocs_conversion_cloud.FileApi.from_keys(client_id, client_secret)
convert_api = groupdocs_conversion_cloud.ConvertApi.from_keys(client_id, client_secret)

# Upload file to cloud storage
file_api.upload_file(
    groupdocs_conversion_cloud.UploadFileRequest("myFile.docx", "myFile.docx")
)

# Prepare convert settings
settings = groupdocs_conversion_cloud.ConvertSettings()
settings.file_path = "myFile.docx"
settings.format = "pdf"
settings.output_path = "converted"

# Convert the document
result = convert_api.convert_document(
    groupdocs_conversion_cloud.ConvertDocumentRequest(settings)
)

print("Document converted: " + result[0].url)

# Download the converted file
response = file_api.download_file(
    groupdocs_conversion_cloud.DownloadFileRequest("converted/myFile.pdf", None)
)

Convert Documents Between Various Formats Cloud API

This code allows developers to convert documents between various formats programmatically with advanced PDF output options, eliminating manual conversions. It supports over 50 file formats, making it ideal for application developers requiring multi-format support.

import groupdocs_conversion_cloud

configuration = groupdocs_conversion_cloud.Configuration("YourClientId", "YourClientSecret")
convert_api = groupdocs_conversion_cloud.ConvertApi.from_config(configuration)

# Prepare convert settings
settings = groupdocs_conversion_cloud.ConvertSettings()
settings.file_path = "WordProcessing/password-protected.docx"
settings.format = "pdf"
settings.output_path = "converted"

# Load options for password-protected source document
load_options = groupdocs_conversion_cloud.WordProcessingLoadOptions()
load_options.password = "password"

# PDF conversion options
convert_options = groupdocs_conversion_cloud.PdfConvertOptions()
convert_options.center_window = True
convert_options.compress_images = False
convert_options.display_doc_title = True
convert_options.dpi = 1024
convert_options.from_page = 1
convert_options.image_quality = 100
convert_options.password = "password"
convert_options.unembed_fonts = True

settings.load_options = load_options
settings.convert_options = convert_options

# Execute the conversion
result = convert_api.convert_document(
    groupdocs_conversion_cloud.ConvertDocumentRequest(settings)
)

print("Document converted: " + result[0].url)

Convert Specific Pages of a Document Cloud API

This example demonstrates how developers can convert only specific pages, saving processing time and reducing file sizes when only a part of the document is needed.

import groupdocs_conversion_cloud

convert_api = groupdocs_conversion_cloud.ConvertApi.from_keys("YourClientId", "YourClientSecret")

# Configure settings to convert specific pages (e.g., pages 1 and 3)
settings = groupdocs_conversion_cloud.ConvertSettings()
settings.file_path = "WordProcessing/four-pages.docx"
settings.format = "pdf"
settings.output_path = "converted/two-pages.pdf"

convert_options = groupdocs_conversion_cloud.PdfConvertOptions()
convert_options.pages = [1, 3]
settings.convert_options = convert_options

# Execute the conversion
result = convert_api.convert_document(
    groupdocs_conversion_cloud.ConvertDocumentRequest(settings)
)

print("Document converted: " + result[0].url)

Get Supported Conversion Formats

Retrieve the full list of supported source-to-target format conversions available through the API.

import groupdocs_conversion_cloud

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

result = info_api.get_supported_conversion_types(
    groupdocs_conversion_cloud.GetSupportedConversionTypesRequest()
)

print("Formats count: " + str(len(result)))

Sample Projects on GitHub

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

How to run the examples

1. Clone or download the samples repository
2. Edit Examples/Common.py and set your client_id and client_secret
3. Go to the Examples directory
4. Run pip install groupdocs-conversion-cloud -U
5. Execute python RunExamples.py

For more details, visit Getting Started.

Tags

Document Conversion API | Python Cloud API | GroupDocs.Conversion Cloud | REST API | Document Conversion | Auto-detect Formats | Watermarking API | Multi-Format Output | Batch Document Conversion | PDF Conversion | Custom Conversion Options | Page-by-Page Conversion | Font Replacement | OCR Support | Metadata Extraction | Document Merge | Storage API | Document Information API | Document Load Options | Multi-Language Support | Cloud Storage Integration | SDKs for .NET, Java, Python | Secure API Access | Docker Support | Scalable Document Conversion | API Rate Limiting