API Method Index

This page lists all available API methods, which can be filtered by converter type. The "API Clients" column includes links to method-specific documentation for individual programming languages. Additionally, "HTTP" links correspond to the POST parameters, while "WP" links direct to the relevant WordPress plugin settings.

Method Name Converter API Clients
addPdfFile() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Add a PDF file to the list of the input PDFs.
addPdfRawData() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Add in-memory raw PDF data to the list of the input PDFs.
Typical usage is for adding PDF created by another Pdfcrowd converter.
convert() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Perform an action on the input files.
convertFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP
Convert a local file.
convertFile() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP
Convert a local file.
convertFile() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP
Convert a local file.
convertFile() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP
Convert a local file.
convertFile() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP
Convert a local file.
convertFile() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP
Convert a local file.
convertFile() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP
Convert a local file.
convertFileToFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToFile() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToFile() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToFile() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToFile() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToFile() PDF to Text PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToFile() PDF to Image PHP Java .NET Python Node.js Ruby Go
Convert a local file and write the result to a local file.
convertFileToStream() HTML to PDF PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertFileToStream() HTML to Image PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertFileToStream() Image to Image PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertFileToStream() Image to PDF PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertFileToStream() PDF to HTML PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertFileToStream() PDF to Text PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertFileToStream() PDF to Image PHP Java .NET Python Ruby Go
Convert a local file and write the result to an output stream.
convertRawData() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP
Convert raw data.
convertRawData() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP
Convert raw data.
convertRawData() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP
Convert raw data.
convertRawData() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP
Convert raw data.
convertRawData() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP
Convert raw data.
convertRawDataToFile() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert raw data to a file.
convertRawDataToFile() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert raw data to a file.
convertRawDataToFile() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Convert raw data to a file.
convertRawDataToFile() PDF to Text PHP Java .NET Python Node.js Ruby Go
Convert raw data to a file.
convertRawDataToFile() PDF to Image PHP Java .NET Python Node.js Ruby Go
Convert raw data to a file.
convertRawDataToStream() Image to Image PHP Java .NET Python Ruby Go
Convert raw data and write the result to an output stream.
convertRawDataToStream() Image to PDF PHP Java .NET Python Ruby Go
Convert raw data and write the result to an output stream.
convertRawDataToStream() PDF to HTML PHP Java .NET Python Ruby Go
Convert raw data and write the result to an output stream.
convertRawDataToStream() PDF to Text PHP Java .NET Python Ruby Go
Convert raw data and write the result to an output stream.
convertRawDataToStream() PDF to Image PHP Java .NET Python Ruby Go
Convert raw data and write the result to an output stream.
convertStream() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStream() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStream() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStream() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStream() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStream() PDF to Text PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStream() PDF to Image PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream.
convertStreamToFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToFile() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToFile() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToFile() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToFile() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToFile() PDF to Text PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToFile() PDF to Image PHP Java .NET Python Node.js Ruby Go
Convert the contents of an input stream and write the result to a local file.
convertStreamToStream() HTML to PDF PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertStreamToStream() HTML to Image PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertStreamToStream() Image to Image PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertStreamToStream() Image to PDF PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertStreamToStream() PDF to HTML PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertStreamToStream() PDF to Text PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertStreamToStream() PDF to Image PHP Java .NET Python Ruby Go
Convert the contents of an input stream and write the result to an output stream.
convertString() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP
Convert a string.
convertString() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP
Convert a string.
convertStringToFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert a string and write the output to a file.
convertStringToFile() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert a string and write the output to a file.
convertStringToStream() HTML to PDF PHP Java .NET Python Ruby Go
Convert a string and write the output to an output stream.
convertStringToStream() HTML to Image PHP Java .NET Python Ruby Go
Convert a string and write the output to an output stream.
convertToFile() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Perform an action on the input files and write the output PDF to a file.
convertToStream() PDF to PDF PHP Java .NET Python Ruby Go
Perform an action on the input files and write the output PDF to an output stream.
convertUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP
Convert a web page.
convertUrl() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP
Convert a web page.
convertUrl() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP
Convert an image.
convertUrl() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP
Convert an image.
convertUrl() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP
Convert a PDF.
convertUrl() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP
Convert a PDF.
convertUrl() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP
Convert an image.
convertUrlToFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Convert a web page and write the result to a local file.
convertUrlToFile() HTML to Image PHP Java .NET Python Node.js Ruby Go
Convert a web page and write the result to a local file.
convertUrlToFile() Image to Image PHP Java .NET Python Node.js Ruby Go
Convert an image and write the result to a local file.
convertUrlToFile() Image to PDF PHP Java .NET Python Node.js Ruby Go
Convert an image and write the result to a local file.
convertUrlToFile() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Convert a PDF and write the result to a local file.
convertUrlToFile() PDF to Text PHP Java .NET Python Node.js Ruby Go
Convert a PDF and write the result to a local file.
convertUrlToFile() PDF to Image PHP Java .NET Python Node.js Ruby Go
Convert an image and write the result to a local file.
convertUrlToStream() HTML to PDF PHP Java .NET Python Ruby Go
Convert a web page and write the result to an output stream.
convertUrlToStream() HTML to Image PHP Java .NET Python Ruby Go
Convert a web page and write the result to an output stream.
convertUrlToStream() Image to Image PHP Java .NET Python Ruby Go
Convert an image and write the result to an output stream.
convertUrlToStream() Image to PDF PHP Java .NET Python Ruby Go
Convert an image and write the result to an output stream.
convertUrlToStream() PDF to HTML PHP Java .NET Python Ruby Go
Convert a PDF and write the result to an output stream.
convertUrlToStream() PDF to Text PHP Java .NET Python Ruby Go
Convert a PDF and write the result to an output stream.
convertUrlToStream() PDF to Image PHP Java .NET Python Ruby Go
Convert an image and write the result to an output stream.
getConsumedCreditCount() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() PDF to Text PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getConsumedCreditCount() PDF to Image PHP Java .NET Python Node.js Ruby Go
Get the number of credits consumed by the last conversion.
getDebugLogUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() PDF to Text PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getDebugLogUrl() PDF to Image PHP Java .NET Python Node.js Ruby Go
Get the URL of the debug log for the last conversion.
getJobId() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() PDF to Text PHP Java .NET Python Node.js Ruby Go
Get the job id.
getJobId() PDF to Image PHP Java .NET Python Node.js Ruby Go
Get the job id.
getOutputSize() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() PDF to Text PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getOutputSize() PDF to Image PHP Java .NET Python Node.js Ruby Go
Get the size of the output in bytes.
getPageCount() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of pages in the output document.
getPageCount() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of pages in the output document.
getPageCount() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Get the number of pages in the output document.
getPageCount() PDF to Text PHP Java .NET Python Node.js Ruby Go
Get the number of pages in the output document.
getPageCount() PDF to Image PHP Java .NET Python Node.js Ruby Go
Get the number of pages in the output document.
getRemainingCreditCount() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() PDF to Text PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getRemainingCreditCount() PDF to Image PHP Java .NET Python Node.js Ruby Go
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
getTotalPageCount() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the total number of pages in the original output document, including the pages excluded by setPrintPageRange().
getVersion() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() HTML to Image PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() Image to Image PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() Image to PDF PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() PDF to Text PHP Java .NET Python Node.js Ruby Go
Get the version details.
getVersion() PDF to Image PHP Java .NET Python Node.js Ruby Go
Get the version details.
isZippedOutput() PDF to HTML PHP Java .NET Python Node.js Ruby Go
A helper method to determine if the output file is a zip archive. The output of the conversion may be either an HTML file or a zip file containing the HTML and its external assets.
isZippedOutput() PDF to Image PHP Java .NET Python Node.js Ruby Go
A helper method to determine if the output file from a conversion process is a zip archive. The conversion output can be either a single image file or a zip file containing one or more image files. This method should be called after the conversion has been successfully completed.
setAction() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specifies the action to be performed on the input PDFs.
setAuthor() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the author of the PDF.
setAuthor() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the author of the PDF.
setAuthor() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the author of the PDF.
setAuthor() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the HTML author. The author from the input PDF is used by default.
setAutoDetectElementToConvert() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
The main HTML element for conversion is detected automatically.
setAutoDetectElementToConvert() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
The main HTML element for conversion is detected automatically.
setBackgroundColor() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
The output image background color.
setBlockAds() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Try to block ads. Enabling this option can produce smaller output and speed up the conversion.
setBlockAds() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Try to block ads. Enabling this option can produce smaller output and speed up the conversion.
setCanvasBackgroundColor() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setCanvasDimensions() Image to Image PHP Java .NET Python Node.js Ruby Go
Set the output canvas dimensions. If no canvas size is specified, margins are applied as a border around the image.
setCanvasHeight() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output canvas height.
setCanvasSize() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output canvas size.
setCanvasWidth() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output canvas width.
setCenterWindow() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify whether to position the document's window in the center of the screen.
setCenterWindow() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify whether to position the document's window in the center of the screen.
setCenterWindow() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify whether to position the document's window in the center of the screen.
setClientCertificate() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security.
setClientCertificate() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security.
setClientCertificatePassword() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
A password for PKCS12 file with a client certificate if it is needed.
setClientCertificatePassword() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
A password for PKCS12 file with a client certificate if it is needed.
setContentArea() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the content area position and size. The content area enables to specify a web page area to be converted.
setContentAreaHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the height of the content area. It should be at least 1 inch.
setContentAreaWidth() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the width of the content area. It should be at least 1 inch.
setContentAreaX() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
setContentAreaY() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
setContentFitMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specifies the mode for fitting the HTML content to the print area by upscaling or downscaling it.
setContentViewportHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the viewport height for formatting the HTML content when generating a PDF. By specifying a viewport height, you can enforce loading of lazy-loaded images and also affect vertical positioning of absolutely positioned elements within the content.
setContentViewportWidth() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the viewport width for formatting the HTML content when generating a PDF. By specifying a viewport width, you can control how the content is rendered, ensuring it mimics the appearance on various devices or matches specific design requirements.
setContentsMatrix() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
A 2D transformation matrix applied to the main contents on each page. The origin [0,0] is located at the top-left corner of the contents. The resolution is 72 dpi.
setConversionConfig() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP

Allows to configure conversion via JSON. The configuration defines various page settings for individual PDF pages or ranges of pages. It provides flexibility in designing each page of the PDF, giving control over each page's size, header, footer etc. If a page or parameter is not explicitly specified, the system will use the default settings for that page or attribute. If a JSON configuration is provided, the settings in the JSON will take precedence over the global options.

The structure of the JSON must be:

  • pageSetup: An array of objects where each object defines the configuration for a specific page or range of pages. The following properties can be set for each page object:
    • pages: A comma-separated list of page numbers or ranges. Special strings may be used, such as `odd`, `even` and `last`. For example:
      • 1-: from page 1 to the end of the document
      • 2: only the 2nd page
      • 2,4,6: pages 2, 4, and 6
      • 2-5: pages 2 through 5
      • odd,2: the 2nd page and all odd pages
    • pageSize: The page size (optional). Possible values: A0, A1, A2, A3, A4, A5, A6, Letter.
    • pageWidth: The width of the page (optional).
    • pageHeight: The height of the page (optional).
    • marginLeft: Left margin (optional).
    • marginRight: Right margin (optional).
    • marginTop: Top margin (optional).
    • marginBottom: Bottom margin (optional).
    • displayHeader: Header appearance (optional). Possible values:
      • none: completely excluded
      • space: only the content is excluded, the space is used
      • content: the content is printed (default)
    • displayFooter: Footer appearance (optional). Possible values:
      • none: completely excluded
      • space: only the content is excluded, the space is used
      • content: the content is printed (default)
    • headerHeight: Height of the header (optional).
    • footerHeight: Height of the footer (optional).
    • orientation: Page orientation, such as "portrait" or "landscape" (optional).

Dimensions may be empty, 0 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".

setConversionConfigFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Allows to configure the conversion process via JSON file. See details of the JSON string.
setConvertImagesToJpeg() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify which image types will be converted to JPEG. Converting lossless compression image formats (PNG, GIF, ...) to JPEG may result in a smaller PDF file.
setConverterVersion() HTML to PDF PHP Java .NET Python Node.js Ruby Go WP
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
setConverterVersion() HTML to Image PHP Java .NET Python Node.js Ruby Go WP
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
setConverterVersion() Image to Image PHP Java .NET Python Node.js Ruby Go
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
setConverterVersion() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
setConverterVersion() Image to PDF PHP Java .NET Python Node.js Ruby Go
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
setCookies() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set cookies that are sent in Pdfcrowd HTTP requests.
setCookies() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set cookies that are sent in Pdfcrowd HTTP requests.
setCropArea() Image to Image PHP Java .NET Python Node.js Ruby Go
Set the content area position and size. The content area enables to specify the part to be converted.
setCropArea() Image to PDF PHP Java .NET Python Node.js Ruby Go
Set the content area position and size. The content area enables to specify the part to be converted.
setCropArea() PDF to Text PHP Java .NET Python Node.js Ruby Go
Set the crop area. It allows to extract just a part of a PDF page.
setCropArea() PDF to Image PHP Java .NET Python Node.js Ruby Go
Set the crop area. It allows to extract just a part of a PDF page.
setCropAreaHeight() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the height of the content area. It should be at least 1 inch.
setCropAreaHeight() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the height of the content area. It should be at least 1 inch.
setCropAreaHeight() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the height of the crop area in points.
setCropAreaHeight() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the height of the crop area in points.
setCropAreaWidth() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the width of the content area. It should be at least 1 inch.
setCropAreaWidth() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the width of the content area. It should be at least 1 inch.
setCropAreaWidth() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the width of the crop area in points.
setCropAreaWidth() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the width of the crop area in points.
setCropAreaX() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
setCropAreaX() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
setCropAreaX() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the top left X coordinate of the crop area in points.
setCropAreaX() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the top left X coordinate of the crop area in points.
setCropAreaY() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
setCropAreaY() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
setCropAreaY() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the top left Y coordinate of the crop area in points.
setCropAreaY() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the top left Y coordinate of the crop area in points.
setCssMode() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specifies where the style sheets are stored.
setCssPageRuleMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specifies behavior in presence of CSS @page rules. It may affect the page size, margins and orientation.
setCustomCss() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.
setCustomCss() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.
setCustomCss() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Apply custom CSS to the output HTML document. It allows you to modify the visual appearance and layout. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.
setCustomHttpHeader() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.
setCustomHttpHeader() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.
setCustomJavascript() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
setCustomJavascript() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
setCustomPageBreak() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify the custom page break.
setDataAutoEscape() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Auto escape HTML symbols in the input data before placing them into the output.
setDataAutoEscape() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Auto escape HTML symbols in the input data before placing them into the output.
setDataEncoding() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the encoding of the data file set by setDataFile.
setDataEncoding() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the encoding of the data file set by setDataFile.
setDataFile() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
setDataFile() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
setDataFormat() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify the input data format.
setDataFormat() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify the input data format.
setDataIgnoreUndefined() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
setDataIgnoreUndefined() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
setDataOptions() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the advanced data options:
  • csv_delimiter - The CSV data delimiter, the default is ,.
  • xml_remove_root - Remove the root XML element from the input data.
  • data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.
setDataOptions() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the advanced data options:
  • csv_delimiter - The CSV data delimiter, the default is ,.
  • xml_remove_root - Remove the root XML element from the input data.
  • data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.
setDataString() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
setDataString() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
setDataTrimBlocks() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Auto trim whitespace around each template command block.
setDataTrimBlocks() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Auto trim whitespace around each template command block.
setDebugLog() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
setDebugLog() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
setDebugLog() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
setDebugLog() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
setDebugLog() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
setDebugLog() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
setDebugLog() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
setDebugLog() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
setDefaultEncoding() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the default HTML content text encoding.
setDefaultEncoding() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the default HTML content text encoding.
setDisableImageLoading() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Do not load images.
setDisableImageLoading() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Do not load images.
setDisableJavascript() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Do not execute JavaScript.
setDisableJavascript() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Do not execute JavaScript.
setDisablePageHeightOptimization() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Disable automatic height adjustment that compensates for pixel to point rounding errors.
setDisableRemoteFonts() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Disable loading fonts from remote sources.
setDisableRemoteFonts() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Disable loading fonts from remote sources.
setDisableSmartShrinking() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Disable the intelligent shrinking strategy that tries to optimally fit the HTML contents to a PDF page.
setDisplayTitle() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setDisplayTitle() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setDisplayTitle() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setDpi() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
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).
setDpi() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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).
setDpi() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output graphics DPI.
setDpi() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output graphics DPI.
setElementToConvert() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Convert only the specified element from the main document and its children. The element is specified by one or more CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used.
setElementToConvert() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Convert only the specified element from the main document and its children. The element is specified by one or more CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used.
setElementToConvertMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
setElementToConvertMode() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
setEnablePdfForms() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Convert HTML forms to fillable PDF forms. Details can be found in the blog post.
setEncrypt() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Encrypt the PDF. This prevents search engines from indexing the contents.
setEncrypt() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Encrypt the PDF. This prevents search engines from indexing the contents.
setEncrypt() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Encrypt the PDF. This prevents search engines from indexing the contents.
setEol() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
The end-of-line convention for the text output.
setExcludeFooterOnPages() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
The page footer content is not printed on the specified pages. To remove the entire footer area, use the conversion config.
setExcludeHeaderOnPages() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
The page header content is not printed on the specified pages. To remove the entire header area, use the conversion config.
setExtractMetaTags() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Extract meta tags (author, keywords and description) from the input HTML and use them in the output PDF.
setFailOnAnyUrlError() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.
setFailOnAnyUrlError() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.
setFailOnMainUrlError() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
setFailOnMainUrlError() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
setFitWindow() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify whether to resize the document's window to fit the size of the first displayed page.
setFitWindow() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify whether to resize the document's window to fit the size of the first displayed page.
setFitWindow() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify whether to resize the document's window to fit the size of the first displayed page.
setFontMode() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specifies where the fonts are stored.
setFooterHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the footer height.
setFooterHtml() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Use the specified HTML as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows:
  • pdfcrowd-page-count - the total page count of printed pages
  • pdfcrowd-page-number - the current page number
  • pdfcrowd-source-url - the source URL of the converted document
  • pdfcrowd-source-title - the title of the converted document
The following attributes can be used:
  • data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values:
    • arabic - Arabic numerals, they are used by default
    • roman - Roman numerals
    • eastern-arabic - Eastern Arabic numerals
    • bengali - Bengali numerals
    • devanagari - Devanagari numerals
    • thai - Thai numerals
    • east-asia - Chinese, Vietnamese, Japanese and Korean numerals
    • chinese-formal - Chinese formal numerals
    Please contact us if you need another type of numerals.
    Example:
    <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span>
  • data-pdfcrowd-placement - specifies where to place the source URL. Allowed values:
    • The URL is inserted to the content
      • Example: <span class='pdfcrowd-source-url'></span>
        will produce <span>http://example.com</span>
    • href - the URL is set to the href attribute
      • Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a>
        will produce <a href='http://example.com'>Link to source</a>
    • href-and-content - the URL is set to the href attribute and to the content
      • Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a>
        will produce <a href='http://example.com'>http://example.com</a>
setFooterMatrix() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
A 2D transformation matrix applied to the page footer contents. The origin [0,0] is located at the top-left corner of the footer. The resolution is 72 dpi.
setFooterUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Load an HTML code from the specified URL and use it as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows:
  • pdfcrowd-page-count - the total page count of printed pages
  • pdfcrowd-page-number - the current page number
  • pdfcrowd-source-url - the source URL of the converted document
  • pdfcrowd-source-title - the title of the converted document
The following attributes can be used:
  • data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values:
    • arabic - Arabic numerals, they are used by default
    • roman - Roman numerals
    • eastern-arabic - Eastern Arabic numerals
    • bengali - Bengali numerals
    • devanagari - Devanagari numerals
    • thai - Thai numerals
    • east-asia - Chinese, Vietnamese, Japanese and Korean numerals
    • chinese-formal - Chinese formal numerals
    Please contact us if you need another type of numerals.
    Example:
    <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span>
  • data-pdfcrowd-placement - specifies where to place the source URL. Allowed values:
    • The URL is inserted to the content
      • Example: <span class='pdfcrowd-source-url'></span>
        will produce <span>http://example.com</span>
    • href - the URL is set to the href attribute
      • Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a>
        will produce <a href='http://example.com'>Link to source</a>
    • href-and-content - the URL is set to the href attribute and to the content
      • Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a>
        will produce <a href='http://example.com'>http://example.com</a>
setForceZip() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Enforces the zip output format.
setForceZip() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Enforces the zip output format.
setHeaderFooterCssAnnotation() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Add special CSS classes to the header/footer's body element. This allows applying custom styling based on these classes:
  • pdfcrowd-page-X - where X is the current page number
  • pdfcrowd-page-count-X - where X is the total page count
  • pdfcrowd-page-first - the first page
  • pdfcrowd-page-last - the last page
  • pdfcrowd-page-odd - odd page
  • pdfcrowd-page-even - even page
setHeaderFooterScaleFactor() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the scaling factor (zoom) for the header and footer.
setHeaderHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the header height.
setHeaderHtml() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Use the specified HTML code as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows:
  • pdfcrowd-page-count - the total page count of printed pages
  • pdfcrowd-page-number - the current page number
  • pdfcrowd-source-url - the source URL of the converted document
  • pdfcrowd-source-title - the title of the converted document
The following attributes can be used:
  • data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values:
    • arabic - Arabic numerals, they are used by default
    • roman - Roman numerals
    • eastern-arabic - Eastern Arabic numerals
    • bengali - Bengali numerals
    • devanagari - Devanagari numerals
    • thai - Thai numerals
    • east-asia - Chinese, Vietnamese, Japanese and Korean numerals
    • chinese-formal - Chinese formal numerals
    Please contact us if you need another type of numerals.
    Example:
    <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span>
  • data-pdfcrowd-placement - specifies where to place the source URL. Allowed values:
    • The URL is inserted to the content
      • Example: <span class='pdfcrowd-source-url'></span>
        will produce <span>http://example.com</span>
    • href - the URL is set to the href attribute
      • Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a>
        will produce <a href='http://example.com'>Link to source</a>
    • href-and-content - the URL is set to the href attribute and to the content
      • Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a>
        will produce <a href='http://example.com'>http://example.com</a>
setHeaderMatrix() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
A 2D transformation matrix applied to the page header contents. The origin [0,0] is located at the top-left corner of the header. The resolution is 72 dpi.
setHeaderUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Load an HTML code from the specified URL and use it as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows:
  • pdfcrowd-page-count - the total page count of printed pages
  • pdfcrowd-page-number - the current page number
  • pdfcrowd-source-url - the source URL of the converted document
  • pdfcrowd-source-title - the title of the converted document
The following attributes can be used:
  • data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values:
    • arabic - Arabic numerals, they are used by default
    • roman - Roman numerals
    • eastern-arabic - Eastern Arabic numerals
    • bengali - Bengali numerals
    • devanagari - Devanagari numerals
    • thai - Thai numerals
    • east-asia - Chinese, Vietnamese, Japanese and Korean numerals
    • chinese-formal - Chinese formal numerals
    Please contact us if you need another type of numerals.
    Example:
    <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span>
  • data-pdfcrowd-placement - specifies where to place the source URL. Allowed values:
    • The URL is inserted to the content
      • Example: <span class='pdfcrowd-source-url'></span>
        will produce <span>http://example.com</span>
    • href - the URL is set to the href attribute
      • Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a>
        will produce <a href='http://example.com'>Link to source</a>
    • href-and-content - the URL is set to the href attribute and to the content
      • Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a>
        will produce <a href='http://example.com'>http://example.com</a>
setHideMenubar() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify whether to hide the viewer application's menu bar when the document is active.
setHideMenubar() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify whether to hide the viewer application's menu bar when the document is active.
setHideMenubar() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify whether to hide the viewer application's menu bar when the document is active.
setHideToolbar() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify whether to hide the viewer application's tool bars when the document is active.
setHideToolbar() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify whether to hide the viewer application's tool bars when the document is active.
setHideToolbar() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify whether to hide the viewer application's tool bars when the document is active.
setHideWindowUi() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setHideWindowUi() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHideWindowUi() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHttpAuth() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set credentials to access HTTP base authentication protected websites.
setHttpAuth() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set credentials to access HTTP base authentication protected websites.
setHttpAuthPassword() HTML to PDF HTTP CLI WP
Set the HTTP authentication password.
setHttpAuthPassword() HTML to Image HTTP CLI WP
Set the HTTP authentication password.
setHttpAuthUserName() HTML to PDF HTTP CLI WP
Set the HTTP authentication user name.
setHttpAuthUserName() HTML to Image HTTP CLI WP
Set the HTTP authentication user name.
setHttpProxy() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setHttpProxy() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setHttpProxy() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHttpProxy() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHttpProxy() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHttpProxy() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHttpProxy() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHttpsProxy() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setHttpsProxy() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setHttpsProxy() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHttpsProxy() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHttpsProxy() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHttpsProxy() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setHttpsProxy() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setImageDpi() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the DPI of images in PDF. A lower DPI may result in a smaller PDF file. If the specified DPI is higher than the actual image DPI, the original image DPI is retained (no upscaling is performed). Use 0 to leave the images unaltered.
setImageFormat() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specifies the format for the output images.
setImageMode() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specifies where the images are stored.
setInitialPage() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Display the specified page when the document is opened.
setInitialPage() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Display the specified page when the document is opened.
setInitialPage() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Display the specified page when the document is opened.
setInitialZoom() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify the initial page zoom in percents when the document is opened.
setInitialZoom() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify the initial page zoom in percents when the document is opened.
setInitialZoom() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify the initial page zoom in percents when the document is opened.
setInitialZoomType() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify how the page should be displayed when opened.
setInitialZoomType() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify how the page should be displayed when opened.
setInitialZoomType() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify how the page should be displayed when opened.
setInputPdfPassword() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Password to open the encrypted PDF file.
setJavascriptDelay() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter.
setJavascriptDelay() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter.
setJpegQuality() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the quality of embedded JPEG images. A lower quality results in a smaller PDF file but can lead to compression artifacts.
setKeywords() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Associate keywords with the document.
setKeywords() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Associate keywords with the document.
setKeywords() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Associate keywords with the document.
setKeywords() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Associate keywords with the HTML document. Keywords from the input PDF are used by default.
setLayoutDpi() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the internal DPI resolution used for positioning of PDF contents. It can help in situations when there are small inaccuracies in the PDF. It is recommended to use values that are a multiple of 72, such as 288 or 360.
setLineSpacingThreshold() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the maximum line spacing when the paragraph detection mode is enabled.
setLinearize() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Create linearized PDF. This is also known as Fast Web View.
setLinearize() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Create linearized PDF. This is also known as Fast Web View.
setLinearize() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Create linearized PDF. This is also known as Fast Web View.
setLoadIframes() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specifies how iframes are handled.
setLoadIframes() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specifies how iframes are handled.
setLocale() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the locale for the conversion. This may affect the output format of dates, times and numbers.
setLocale() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the locale for the conversion. This may affect the output format of dates, times and numbers.
setMainDocumentCssAnnotation() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Add special CSS classes to the main document's body element. This allows applying custom styling based on these classes:
  • pdfcrowd-page-X - where X is the current page number
  • pdfcrowd-page-odd - odd page
  • pdfcrowd-page-even - even page
setMarginBottom() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the output page bottom margin.
setMarginBottom() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output canvas bottom margin.
setMarginBottom() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output page bottom margin.
setMarginLeft() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the output page left margin.
setMarginLeft() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output canvas left margin.
setMarginLeft() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output page left margin.
setMarginRight() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the output page right margin.
setMarginRight() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output canvas right margin.
setMarginRight() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output page right margin.
setMarginTop() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the output page top margin.
setMarginTop() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output canvas top margin.
setMarginTop() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output page top margin.
setMargins() Image to Image PHP Java .NET Python Node.js Ruby Go
Set the output canvas margins.
setMaxLoadingTime() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.
setMaxLoadingTime() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.
setMultipageBackground() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
setMultipageBackground() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
setMultipageBackground() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
setMultipageBackgroundUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setMultipageBackgroundUrl() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setMultipageBackgroundUrl() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setMultipageWatermark() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
setMultipageWatermark() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
setMultipageWatermark() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
setMultipageWatermarkUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setMultipageWatermarkUrl() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setMultipageWatermarkUrl() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setNoBackground() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Do not print the background graphics.
setNoBackground() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Do not print the background graphics.
setNoCopy() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Disallow text and graphics extraction from the output PDF.
setNoCopy() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Disallow text and graphics extraction from the output PDF.
setNoCopy() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Disallow text and graphics extraction from the output PDF.
setNoHeaderFooterHorizontalMargins() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Disable horizontal page margins for header and footer. The header/footer contents width will be equal to the physical page width.
setNoLayout() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Ignore the original PDF layout.
setNoMargins() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Disable page margins.
setNoModify() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Disallow modification of the output PDF.
setNoModify() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Disallow modification of the output PDF.
setNoModify() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Disallow modification of the output PDF.
setNoPrint() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Disallow printing of the output PDF.
setNoPrint() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Disallow printing of the output PDF.
setNoPrint() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Disallow printing of the output PDF.
setNoXpdfcrowdHeader() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.
setNoXpdfcrowdHeader() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.
setOnLoadJavascript() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
setOnLoadJavascript() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
setOrientation() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the output page orientation.
setOrientation() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output canvas orientation.
setOrientation() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output page orientation.
setOutputFormat() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
The format of the output file.
setOutputFormat() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
The format of the output file.
setOutputFormat() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
The format of the output file.
setOwnerPassword() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
setOwnerPassword() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
setOwnerPassword() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
setPageBackground() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setPageBackground() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setPageBackground() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setPageBackgroundColor() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins.
setPageBackgroundColor() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setPageBackgroundUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setPageBackgroundUrl() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setPageBackgroundUrl() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setPageBreakMode() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify the page break mode for the text output.
setPageDimensions() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page dimensions.
setPageDimensions() Image to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page dimensions. If no page size is specified, margins are applied as a border around the image.
setPageHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the output page height. Use -1 for a single page PDF. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF.
setPageHeight() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output page height.
setPageLayout() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify the page layout to be used when the document is opened.
setPageLayout() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify the page layout to be used when the document is opened.
setPageLayout() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify the page layout to be used when the document is opened.
setPageMargins() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page margins.
setPageMargins() Image to PDF PHP Java .NET Python Node.js Ruby Go
Set the output page margins.
setPageMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specify how the document should be displayed when opened.
setPageMode() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify how the document should be displayed when opened.
setPageMode() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify how the document should be displayed when opened.
setPageNumberingOffset() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set an offset between physical and logical page numbers.
setPageRange() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the page range for extract or delete action.
setPageSize() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the output page size.
setPageSize() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output page size.
setPageWatermark() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setPageWatermark() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setPageWatermark() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setPageWatermarkUrl() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setPageWatermarkUrl() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setPageWatermarkUrl() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setPageWidth() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the output page width. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF.
setPageWidth() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the output page width.
setParagraphMode() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Specify the paragraph detection mode.
setPdfPassword() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Password to open the encrypted PDF file.
setPdfPassword() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
The password to open the encrypted PDF file.
setPdfPassword() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Password to open the encrypted PDF file.
setPosition() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the image position on the canvas.
setPosition() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the image position on the page.
setPrintCanvasMode() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the mode to print the image on the canvas.
setPrintPageMode() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the mode to print the image on the content area of the page.
setPrintPageRange() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the page range to print.
setPrintPageRange() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the page range to print.
setPrintPageRange() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the page range to print.
setPrintPageRange() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the page range to print.
setProxy() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() HTML to Image PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() Image to Image PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() Image to PDF PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() PDF to Text PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setProxy() PDF to Image PHP Java .NET Python Node.js Ruby Go
Specifies an HTTP proxy that the API client library will use to connect to the internet.
setReadabilityEnhancements() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
The input HTML is automatically enhanced to improve the readability.
setReadabilityEnhancements() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
The input HTML is automatically enhanced to improve the readability.
setRemoveBlankPages() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specifies which blank pages to exclude from the output document.
setRemoveBorders() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Remove borders of an image which does not change in color.
setRemoveBorders() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Remove borders of an image which does not change in color.
setRemoveEmptyLines() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Remove empty lines from the text output.
setRemoveHyphenation() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Remove the hyphen character from the end of lines.
setRenderingMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the rendering mode of the page, allowing control over how content is displayed.
setResize() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Resize the image.
setResize() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Resize the image.
setRetryCount() HTML to PDF PHP Java .NET Python Node.js Ruby Go WP
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() HTML to Image PHP Java .NET Python Node.js Ruby Go WP
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() Image to Image PHP Java .NET Python Node.js Ruby Go
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() Image to PDF PHP Java .NET Python Node.js Ruby Go
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() PDF to Text PHP Java .NET Python Node.js Ruby Go
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRetryCount() PDF to Image PHP Java .NET Python Node.js Ruby Go
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
setRightToLeft() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up
setRightToLeft() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up
setRotate() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Rotate the image.
setRotate() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Rotate the image.
setScaleFactor() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the scaling factor (zoom) for the main page area.
setScaleFactor() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the scaling factor (zoom) for the output image.
setScaleFactor() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the scaling factor (zoom) for the main page area.
setScreenshotHeight() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the output image height in pixels. If it is not specified, actual document height is used.
setScreenshotWidth() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the output image width in pixels.
setSmartScalingMode() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Specifies the scaling mode used for fitting the HTML contents to the print area.
setSplitLigatures() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Converts ligatures, two or more letters combined into a single glyph, back into their individual ASCII characters.
setSubject() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the subject of the PDF.
setSubject() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the subject of the PDF.
setSubject() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the subject of the PDF.
setSubject() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the HTML subject. The subject from the input PDF is used by default.
setTag() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() Image to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() PDF to Text PHP Java .NET Python Node.js Ruby Go HTTP CLI
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTag() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
setTitle() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the title of the PDF.
setTitle() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the title of the PDF.
setTitle() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the title of the PDF.
setTitle() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the HTML title. The title from the input PDF is used by default.
setType3Mode() PDF to HTML PHP Java .NET Python Node.js Ruby Go HTTP CLI
Sets the processing mode for handling Type 3 fonts.
setUseCropbox() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Use the crop box rather than media box.
setUseCurl() HTML to PDF PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() HTML to Image PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() Image to Image PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() PDF to PDF PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() Image to PDF PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() PDF to HTML PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() PDF to Text PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseCurl() PDF to Image PHP
Use cURL for the conversion request instead of the file_get_contents() PHP function.
setUseGrayscale() PDF to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI
Generate a grayscale image.
setUseHttp() HTML to PDF PHP Java .NET Python Node.js Ruby Go WP
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() HTML to Image PHP Java .NET Python Node.js Ruby Go WP
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() Image to Image PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() Image to PDF PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() PDF to Text PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseHttp() PDF to Image PHP Java .NET Python Node.js Ruby Go
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
setUseMetadataFrom() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Use metadata (title, subject, author and keywords) from the n-th input PDF.
setUseMobileUserAgent() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Use a mobile user agent.
setUseMobileUserAgent() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Use a mobile user agent.
setUsePrintMedia() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Use the print version of the page if available (@media print).
setUsePrintMedia() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Use the print version of the page if available (@media print).
setUserAgent() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
setUserAgent() HTML to Image PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
setUserAgent() Image to Image PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
setUserAgent() PDF to PDF PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
setUserAgent() Image to PDF PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
setUserAgent() PDF to HTML PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
setUserAgent() PDF to Text PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
setUserAgent() PDF to Image PHP Java .NET Python Node.js Ruby Go
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
setUserPassword() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
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.
setUserPassword() PDF to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setUserPassword() Image to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
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.
setVerifySslCertificates() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Do not allow insecure HTTPS connections.
setVerifySslCertificates() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Do not allow insecure HTTPS connections.
setViewport() HTML to PDF PHP Java .NET Python Node.js Ruby Go
Set the viewport size. The viewport is the user's visible area of the page.
setViewportHeight() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the viewport height in pixels. The viewport is the user's visible area of the page. If the input HTML uses lazily loaded images, try using a large value that covers the entire height of the HTML, e.g. 100000.
setViewportWidth() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Set the viewport width in pixels. The viewport is the user's visible area of the page.
setWaitForElement() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Wait for the specified element in a source document. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your API license defines the maximum wait time by "Max Delay" parameter.
setWaitForElement() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP CLI WP
Wait for the specified element in a source document. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your API license defines the maximum wait time by "Max Delay" parameter.
setZipFooterFilename() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the file name of the footer HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents.
setZipHeaderFilename() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP CLI
Set the file name of the header HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents.
setZipMainFilename() HTML to PDF PHP Java .NET Python Node.js Ruby Go HTTP
Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.
setZipMainFilename() HTML to Image PHP Java .NET Python Node.js Ruby Go HTTP
Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.