Conversion Input
url
The address of the image to convert.
- Constraint:
-
- 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.
-
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.
- Default:
attachment
- 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.
-
Image Operations
Settings used for operations with images.
resize
Resize the image.
- Default:
100%
- Examples:
-
-
Enlarge for high-res display:
200%
-
Standard XGA screen resolution:
1024x768
-
Enlarge for high-res display:
rotate
Rotate the image.
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:
-
-
Crop extends beyond left edge:
-1in
-
Skip narrow border area:
10mm
-
Crop extends beyond left edge:
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:
-
-
Crop extends beyond left edge:
-1in
-
Skip narrow border area:
10mm
-
Crop extends beyond left edge:
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:
-
-
Standard document crop width:
8in
-
Full A4 page width crop:
210mm
-
Standard document crop width:
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:
-
-
Standard document crop width:
8in
-
Full A4 page width crop:
210mm
-
Standard document crop width:
remove_borders
Remove borders of an image which does not change in color.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
Page Setup
page_size
Set the output page size.
- Allowed Values:
-
-
A0
-
A1
-
A2
-
A3
-
A4
-
A5
-
A6
-
Letter
-
page_width
Set the output page width.
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Examples:
-
-
A4 landscape / A3 portrait width:
297mm
-
US Letter/Legal standard width:
8.5in
-
A4 landscape / A3 portrait width:
page_height
Set the output page height.
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Examples:
-
-
A3 standard height for posters:
420mm
-
US Letter standard height:
11in
-
A3 standard height for posters:
orientation
Set the output page orientation.
- Default:
portrait
- Allowed Values:
-
-
landscape
-
portrait
-
position
Set the image position on the page.
- Default:
center
- Allowed Values:
-
-
center
-
top
-
bottom
-
left
-
right
-
top-left
-
top-right
-
bottom-left
-
bottom-right
-
print_page_mode
Set the mode to print the image on the content area of the page.
- Default:
default
- Allowed Values:
-
-
default
— No image scaling. -
fit
— Fit image to page with aspect ratio. -
stretch
— Stretch image to the page with no aspect ratio.
-
margin_top
Set the output page top margin.
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Examples:
-
-
Wide margin for framing:
1in
-
Narrow professional margin:
10mm
-
Wide margin for framing:
margin_right
Set the output page right margin.
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Examples:
-
-
Wide margin for framing:
1in
-
Narrow professional margin:
10mm
-
Wide margin for framing:
margin_bottom
Set the output page bottom margin.
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Examples:
-
-
Wide margin for framing:
1in
-
Narrow professional margin:
10mm
-
Wide margin for framing:
margin_left
Set the output page left margin.
- Constraint:
-
- The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
- Examples:
-
-
Wide margin for framing:
1in
-
Narrow professional margin:
10mm
-
Wide margin for framing:
page_background_color
The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins. If not page 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
-
red color:
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
-
The DPI used for printers. 1 inch contains 300 points:
Watermark & Background
page_watermark
Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
Multi-page PDF for watermarking:
/home/user/john/watermark.pdf
-
Transparent PNG overlay:
/home/user/john/watermark.png
-
Multi-page PDF for watermarking:
page_watermark_url
Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
- Constraint:
-
- Supported protocols are http:// and https://.
- Examples:
-
-
Download watermark from server:
http://myserver.com/watermark.pdf
-
Remote logo watermark:
http://myserver.com/watermark.png
-
Download watermark from server:
multipage_watermark
Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
Multi-page PDF for watermarking:
/home/user/john/watermark.pdf
-
Transparent PNG overlay:
/home/user/john/watermark.png
-
Multi-page PDF for watermarking:
multipage_watermark_url
Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
- Constraint:
-
- Supported protocols are http:// and https://.
- Examples:
-
-
Download watermark from server:
http://myserver.com/watermark.pdf
-
Remote logo watermark:
http://myserver.com/watermark.png
-
Download watermark from server:
page_background
Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
PDF template background:
/home/user/john/background.pdf
-
Image texture background:
/home/user/john/background.png
-
PDF template background:
page_background_url
Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
- Constraint:
-
- Supported protocols are http:// and https://.
- Examples:
-
-
Download template background:
http://myserver.com/background.pdf
-
Remote background pattern:
http://myserver.com/background.png
-
Download template background:
multipage_background
Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
- Constraint:
-
- The file must exist and not be empty.
- Examples:
-
-
PDF template background:
/home/user/john/background.pdf
-
Image texture background:
/home/user/john/background.png
-
PDF template background:
multipage_background_url
Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
- Constraint:
-
- Supported protocols are http:// and https://.
- Examples:
-
-
Download template background:
http://myserver.com/background.pdf
-
Remote background pattern:
http://myserver.com/background.png
-
Download template background:
PDF Format
Miscellaneous values for PDF output.
linearize
Create linearized PDF. This is also known as Fast Web View.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
encrypt
Encrypt the PDF. This prevents search engines from indexing the contents.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
user_password
Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.
- Example:
-
-
Simple document password:
123456
-
Simple document password:
owner_password
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
- Example:
-
-
Admin access password:
123456
-
Admin access password:
no_print
Disallow printing of the output PDF.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
no_modify
Disallow modification of the output PDF.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
no_copy
Disallow text and graphics extraction from the output PDF.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
title
Set the title of the PDF.
- Example:
-
-
Personal CV title:
My Resume
-
Personal CV title:
subject
Set the subject of the PDF.
- Example:
-
-
Technical position subject:
CV - Software Developer
-
Technical position subject:
keywords
Associate keywords with the document.
- Example:
-
-
Technical skills for searchability:
software developer, Unix, databases
-
Technical skills for searchability:
Viewer Preferences
These preferences specify how a PDF viewer should present the document. The preferences may be ignored by some PDF viewers.
page_layout
Specify the page layout to be used when the document is opened.
- Allowed Values:
-
-
single-page
— Display one page at a time. -
one-column
— Display the pages in one column. -
two-column-left
— Display the pages in two columns, with odd-numbered pages on the left. -
two-column-right
— Display the pages in two columns, with odd-numbered pages on the right.
-
page_mode
Specify how the document should be displayed when opened.
- Allowed Values:
-
-
full-screen
— Full-screen mode. -
thumbnails
— Thumbnail images are visible. -
outlines
— Document outline is visible.
-
initial_zoom_type
Specify how the page should be displayed when opened.
- Allowed Values:
-
-
fit-width
— The page content is magnified just enough to fit the entire width of the page within the window. -
fit-height
— The page content is magnified just enough to fit the entire height of the page within the window. -
fit-page
— The page content is magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.
-
initial_page
Display the specified page when the document is opened.
- Constraint:
-
- Must be a positive integer.
- Example:
-
-
Start at second page:
2
-
Start at second page:
initial_zoom
Specify the initial page zoom in percents when the document is opened.
- Constraint:
-
- Must be a positive integer.
- Example:
-
-
Half-size zoom level:
50
-
Half-size zoom level:
hide_toolbar
Specify whether to hide the viewer application's tool bars when the document is active.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
hide_window_ui
Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
fit_window
Specify whether to resize the document's window to fit the size of the first displayed page.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
center_window
Specify whether to position the document's window in the center of the screen.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
display_title
Specify whether the window's title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
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.
- Default:
false
- Allowed Values:
-
-
true, 1 or on
-
false, 0 or off
-
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:
-
-
Track job in analytics:
client-1234
-
Track job in analytics:
http_proxy
A proxy server used by the 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:
-
-
Corporate proxy server:
myproxy.com:8080
-
Direct IP proxy connection:
113.25.84.10:33333
-
Corporate proxy server:
https_proxy
A proxy server used by the 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:
-
-
Secure proxy for HTTPS:
myproxy.com:443
-
Direct secure proxy IP:
113.25.84.10:44333
-
Secure proxy for HTTPS: