Python Library

ConvertAPI Python Client

PyPI version Build Status

Convert your files with our online file conversion API

The ConvertAPI helps converting various file formats. Creating PDF and Images from various sources like Word, Excel, Powerpoint, images, web pages or raw HTML codes. Merge, Encrypt, Split, Repair and Decrypt PDF files. And many others files manipulations. In just few minutes you can integrate it into your application and use it easily.


Install with pip:

pip install --upgrade convertapi

Install from source with:

python install


  • Python 2.7+ or Python 3.3+



You can get your secret at

import convertapi

convertapi.api_secret = 'your-api-secret'

Proxy configuration

If you need to use proxy, you specify it using HTTPS_PROXY environment variable when running your script.


CONVERT_API_SECRET=secret HTTPS_PROXY=https://user:[email protected]:9000/ python

File conversion

Example to convert file to PDF. All supported formats and options can be found here.

result = convertapi.convert('pdf', { 'File': '/path/to/my_file.docx' })

# save to file'/path/to/save/file.pdf')

Other result operations:

# save all result files to folder

# get conversion cost
conversion_cost = result.conversion_cost

Convert file url

result = convertapi.convert('pdf', { 'File': 'https://website/my_file.docx' })

Specifying from format

result = convertapi.convert(
    { 'File': '/path/to/my_file' },
    from_format = 'docx'

Additional conversion parameters

ConvertAPI accepts extra conversion parameters depending on converted formats. All conversion parameters and explanations can be found here.

result = convertapi.convert(
        'File': '/path/to/my_file.docx',
        'PageRange': '1-10',
        'PdfResolution': '150',

User information

You can always check remaining seconds amount by fetching user information.

user_info = convertapi.user()


More examples

You can find more advanced examples in the /examples folder.


Execute CONVERT_API_SECRET=your_secret nosetests --nocapture to run the tests.


Bug reports and pull requests are welcome on GitHub at This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.


The gem is available as open source under the terms of the MIT License.