Important: This document is for the beta version of the new Pdfcrowd API. Use this documentation for the stable API version.

Image to Image - Command Line Tool


You can install the application from PyPI
 $ pip install pdfcrowd

You can learn more install options here.

The package installs tools for all Pdfcrowd converters.


Authentication is needed in order to use the Pdfcrowd API. The credentials used for accessing the API are your Pdfcrowd username and the API key. You can find the API key in your account page.

Getting Started

Convert a local PNG file to a JPEG file

image2image -user-name "username" -api-key "apikey" \
    -output-format "jpg" \
    "/path/to/logo.png" > logo.jpg

Convert url with PNG file to a JPEG file

image2image -user-name "username" -api-key "apikey" \
    -output-format "jpg" \
    "" > logo.jpg

image2image Manual

Conversion from one image format to another image format.

usage: image2image [options] source

Conversion from one image format to another image format.

positional arguments:
  source                Source to be converted. It can be URL, path to a local
                        file or '-' to use stdin as an input text.

optional arguments:
  -user-name USER_NAME  Your user name at
  -api-key API_KEY      Your API key at
  -output-format OUTPUT_FORMAT
                        The format of the output file. Allowed values are png,
                        jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb,
                        pct, ras, tga, sgi, sun, webp.
  -resize RESIZE        Resize the image. The resize percentage or new image
  -rotate ROTATE        Rotate the image. The rotation specified in degrees.
  -debug-log            Turn on the debug logging.
  -use-http             Specifies if the client communicates over HTTP or
                        HTTPS with Pdfcrowd API.
  -user-agent USER_AGENT
                        Set a custom user agent HTTP header. It can be usefull
                        if you are behind some proxy or firewall. The user
                        agent string.
  -proxy PROXY          Specifies an HTTP proxy that the API client library
                        will use to connect to the internet. PROXY must
                        contain 4 values separated by a semicolon. The proxy
                        hostname. The proxy port. The username. The password.
  -retry-count RETRY_COUNT
                        Specifies the number of retries when the 502 HTTP
                        status code is received. The 502 status code indicates
                        a temporary network issue. This feature can be
                        disabled by setting to 0. Number of retries wanted.

produced by: