Image to Image / HTTP API Reference

Conversion Input

url
The address of the image to convert.
Constraint:
  • The supported protocols are http:// and https://.
file
The path to a local file to convert.
Constraint:
  • The file must exist and not be empty.
data
Convert raw data.

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
Default: png

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
crop_area_x
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
Constraint:
  • The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0px
Examples:
  • -1in
  • 2.5cm
crop_area_y
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
Constraint:
  • The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0px
Examples:
  • -1in
  • 2.5cm
crop_area_width
Set the width of the content area. It should be at least 1 inch.
Constraint:
  • The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: The width of the print area.
Examples:
  • 8in
  • 25cm
crop_area_height
Set the height of the content area. It should be at least 1 inch.
Constraint:
  • The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: The height of the print area.
Examples:
  • 8in
  • 25cm
remove_borders
Remove borders of an image which does not change in color.
Allowed values:
  • true, 1 or on
  • false, 0 or off
Default: false

Canvas Setup

canvas_size
Set the output canvas size.
Allowed values:
  • A0
  • A1
  • A2
  • A3
  • A4
  • A5
  • A6
  • Letter
canvas_width
Set the output canvas width.
Constraint:
  • The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • 300mm
  • 9.5in
canvas_height
Set the output canvas height.
Constraint:
  • The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • 15.25in
  • 350mm
orientation
Set the output canvas orientation.
Allowed values:
  • landscape
  • portrait
Default: portrait
position
Set the image position on the canvas.
Allowed values:
  • center
  • top
  • bottom
  • left
  • right
  • top-left
  • top-right
  • bottom-left
  • bottom-right
Default: center
Set the mode to print the image on the canvas.
Allowed values:
  • default
    No image scaling.
  • fit
    Fit the image to the canvas with aspect ratio.
  • stretch
    Stretch the image to the canvas with no aspect ratio.
Default: default
margin_top
Set the output canvas top margin.
Constraint:
  • The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • 1in
  • 2.5cm
margin_right
Set the output canvas right margin.
Constraint:
  • The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • 1in
  • 2.5cm
margin_bottom
Set the output canvas bottom margin.
Constraint:
  • The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • 1in
  • 2.5cm
margin_left
Set the output canvas left margin.
Constraint:
  • The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • 1in
  • 2.5cm
canvas_background_color
The canvas background color in RGB or RGBA hexadecimal format. The color fills the entire canvas regardless of margins. If no canvas size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.
Constraint:
  • The value must be in RRGGBB or RRGGBBAA hexadecimal format.
Examples:
  • red color
    FF0000
  • green color
    00ff00
  • green color with 50% opacity
    00ff0080
dpi
Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).
Default: 96
Example:
  • The DPI used for printers. 1 inch contains 300 points.
    300

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.
Example:
  • client-1234
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.
Constraint:
  • 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.
Constraint:
  • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • myproxy.com:443
  • 113.25.84.10:44333