Image to Image API - HTTP

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.
Sign up for a Free Trial

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.

Examples

curl -f -u "your_username:your_apikey" \
    -o logo.jpg  \
    -F "input_format=image"  \
    -F "output_format=jpg"  \
    -F "file=@/path/to/logo.png" \
    https://api.pdfcrowd.com/convert/
curl -f -u "your_username:your_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/

Tips & Tricks

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

Troubleshooting

  • Check API Status Codes in case of the error code is returned.
  • You can use debug_log to get detailed info about the conversion, such as conversion errors, time, console output.
  • Take a look at the FAQ section.

Image to Image API Reference

Conversion Input

url
The address of the image to convert.
Constraints:
  • 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).
Constraints:
  • The file must exist and not be empty.
data
The raw content to be converted.

Conversion Format

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

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.
Default:
  • attachment

Image operations

Settings used for operations with images.

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

Miscellaneous

debug_log
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log is returned in the X-Pdfcrowd-Debug-Log response header or available in conversion statistics.
Allowed values:
  • true, 1 or on
  • false, 0 or off
Default:
  • false
tag
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
http_proxy
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
Constraints:
  • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • myproxy.com:8080
  • 113.25.84.10:33333
https_proxy
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
Constraints:
  • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • myproxy.com:443
  • 113.25.84.10:44333