Document Conversion 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-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:

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

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:

Category	Examples
Convert	PDF, HTML, image, presentation, spreadsheet, word processing; direct conversion; async conversion
Common Options	Watermarks, specific pages, consecutive pages, custom fonts
Load Options	CAD, CSV, email, HTML, OneNote, PDF, presentation, spreadsheet, text, word processing
Info	Supported conversions, document information

How to run the examples

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

For more details, visit Getting Started.