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

Image to Image API - HTTP Documentation

Overview

The Pdfcrowd API is HTTP-based, the communication is made through normal HTTP requests. You can call the API by sending an HTTP request to the API server address with options passed as POST data.

The POST request's content type must be multipart/form-data if the request includes any local files. Otherwise it can be application/x-www-form-urlencoded too.

You can also check out our API client libraries if you want to implement the API in your favorite programming language.

Authentication

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.

The authentication method for user credentials is HTTP Basic Access Authentication. You provide your credentials every time you make a request.

Server Address

The server address is https://api.pdfcrowd.com/convert/

Both HTTP and HTTPS protocols are supported.

Getting Started

Convert a local PNG file to a JPEG file

curl -f -u 'username:apikey' \
    -o logo.jpg  \
    -F 'input_format=image'  \
    -F 'output_format=jpg'  \
    -F 'file=@/path/to/logo.png' \
    https://api.pdfcrowd.com/convert/

Convert url with PNG file to a JPEG file

curl -f -u 'username:apikey' \
    -o logo.jpg  \
    -F 'input_format=image'  \
    -F 'output_format=jpg'  \
    -F 'url=http://pdfcrowd.com/static/images/logo.png' \
    https://api.pdfcrowd.com/convert/

Image to Image API Reference

Conversion Input

Parameter Description Default
url
The address of the image to convert.
The supported protocols are http:// and https://.
file
The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
The file must exist and not be empty.
data
The raw content to be converted.

 

Conversion Format

Parameter Description Default
input_format
The format of input file.
Allowed values:
  • image
    Image format is recognized automatically.
output_format
The format of the output file.
Allowed values:
  • png
  • jpg
  • gif
  • tiff
  • bmp
  • ico
  • ppm
  • pgm
  • pbm
  • pnm
  • psb
  • pct
  • ras
  • tga
  • sgi
  • sun
  • webp

 

Response

Parameter Description Default
output_name
The file name of the created file (max 180 chars). If not specified then the name is auto-generated.
content_disposition
The value of the Content-Disposition HTTP header sent in the response.
Allowed values:
  • attachment
    Forces the browser to pop up a Save As dialog.
  • inline
    The browser will open the result file in the browser window.
attachment

 

Image operations

Settings used for operations with images.

Parameter Description Default
resize
Resize the image.
Examples:
  • 200%
  • 1024x768
100%
rotate
Rotate the image.
0

 

Miscellaneous

Parameter Description Default
debug_log
Turn on the debug logging. The URL of the log is returned in the X-Pdfcrowd-Debug-Log response header.
Allowed values:
  • true, 1 or on
  • false, 0 or off
false

 

Response Headers

HTTP response can contain the following headers.
You can find details about each conversion in your conversion log.

Name Description
X-Pdfcrowd-Debug-Log URL to the debug log
X-Pdfcrowd-Remaining-Credits the number of available conversion credits in your account
X-Pdfcrowd-Consumed-Credits the number of credits consumed by the conversion
X-Pdfcrowd-Job-Id the unique ID of the conversion
X-Pdfcrowd-Pages the total number of pages in the output document
X-Pdfcrowd-Output-Size the size of the output in bytes