HTML to PDF / Golang Reference

Constructor for the PDFCrowd API client. Initialize a new instance of the conversion client with your PDFCrowd account credentials.

You must provide both your username and API key. This establishes the authenticated connection for all subsequent conversion operations.

Convert a web page from a URL.

Use this as the primary method for converting web content, online documents, or any publicly accessible URL to the desired output format. Returns the conversion result as a byte array for further processing or direct use.

Convert a web page from a URL and write the conversion result directly to an output stream.

Use this when you need to handle large conversion results, integrate with streaming pipelines, or build server applications that process conversions continuously.

Convert a web page from a URL and save the conversion result directly to a local file.

Use this for simple file-based workflows, batch processing, or when you need to persist conversion output to disk. The most straightforward method for URL-to-file conversions.

Convert a local file to the desired output format.

Use this for processing files already on your system, converting uploaded documents, or batch processing local content. Returns the conversion result as a byte array for in-memory processing.

Convert a local file and write the conversion result directly to an output stream.

Use this when working with large conversion results, integrating with streaming frameworks, or building applications that need direct stream-to-stream processing.

Convert a local file and save the conversion result to another local file.

Use this for file-based batch processing, document transformation workflows, or when both input and output are file-based. The simplest method for file-to-file conversions.

Convert a string containing source content to the desired output format.

Use this for converting dynamically generated content, templates, user input, or any text-based data held in memory. Ideal for real-time content generation and API integrations.

Convert a string containing source content and write the conversion result directly to an output stream.

Use this when processing dynamically generated content with large outputs, integrating with streaming APIs, or building high-throughput web applications.

Convert a string containing source content and save the conversion result to a local file.

Use this for persisting dynamically generated content, creating documents from templates, or saving user-generated conversions. Combines in-memory source with file-based output.

Convert content from an input stream to the desired output format.

Use this when integrating with I/O pipelines, processing data from network streams or file handles, or when the source data is provided as a stream by your application.

Convert content from an input stream and write the conversion result to an output stream.

Use this when both input and output need to be streams, integrating with streaming frameworks, or building conversion services that process data in stream form throughout.

Convert content from an input stream and save the conversion result to a local file.

Use this when processing streaming uploads that need to be saved, handling network data sources with file-based output, or building services that accept stream input and produce file output.

Set the file name of the main HTML document stored in the input archive. Use this when your ZIP/TAR archive contains multiple HTML files and you need to specify which one to convert.

If not specified, the first HTML file found in the archive is automatically used for conversion.

Set the output page size using standard formats (A4, Letter, A3, etc.). Use A4 for international documents, Letter for US-based content, or larger sizes like A3 for posters and presentations.

Set custom page dimensions when standard sizes don't fit your needs. Useful for banners, receipts, custom forms, or when matching specific printing equipment.

The safe maximum is 200in - larger sizes may fail to open in some PDF viewers. For standard sizes like A4 or Letter, use the predefined page size option instead.

Set custom page height for specific formats like receipts, banners, or legal documents. Set to "-1" for a single-page PDF that expands to fit all content vertically - ideal for web pages, infographics, or documents where page breaks are undesirable.

The safe maximum is 200in otherwise some viewers cannot open the PDF. For standard sizes, use the predefined page size option instead.

Set both page width and height simultaneously for custom page sizes. Use this when you need non-standard dimensions like banners, receipts, or custom forms that don't match A4, Letter, or other predefined sizes.

Provide width and height with units (e.g., "210mm", "8.5in"). Maximum safe value is 200in for each dimension - larger sizes may fail to open in some PDF viewers.

Set the output page orientation to portrait or landscape. Use landscape for wide content like spreadsheets, charts, or dashboards. Use portrait for standard documents and text-heavy content.

Control white space at the top of the page. Increase for header space, formal documents, or annotation room (e.g., 1in or more). Decrease to maximize content area or fit more content (e.g., 5mm to 10mm).

Default 0.4in balances readability with space efficiency. Set to 0 for full-bleed designs. Affects where content starts and where headers appear.

Control white space on the right edge of the page. Increase for binding/hole-punch clearance or note-taking space (e.g., 1in or more). Decrease to fit wider content (e.g., 5mm to 10mm).

Default 0.4in balances readability with space efficiency. Set to 0 for full-bleed designs. Affects where content wraps and text line length.

Control white space at the bottom of the page. Increase for footer space, page numbers, or formal documents (e.g., 1in or more). Decrease to fit more content per page (e.g., 5mm to 10mm).

Default 0.4in balances readability with space efficiency. Set to 0 for full-bleed designs. Affects where content ends and where footers appear.

Control white space on the left edge of the page. Increase for binding/hole-punch clearance or note-taking space (e.g., 1in or more). Decrease to fit wider content (e.g., 5mm to 10mm).

Default 0.4in balances readability with space efficiency. Set to 0 for full-bleed designs. Affects where content starts horizontally and text line length.

Disable all page margins to use the entire page area. Use this for full-bleed designs where content should extend to the page edges, such as posters, certificates, or branded materials.

Combine with custom CSS to ensure your content fills the page properly.

Set all four page margins (top, right, bottom, left) simultaneously for consistent spacing. Use this when you need uniform margins for binding, formal documents, or when applying the same spacing to all edges at once.

Provide margin values with units (e.g., "1in", "25mm"). Use larger values (1in+) for binding clearance or annotations, smaller values (5-10mm) to maximize content area. Set to "0" for full-bleed designs.

Set the page range to print when you only need specific pages from the conversion. Use this to extract individual pages (e.g., "2"), specific ranges (e.g., "3-7"), or combinations (e.g., "1,4-6,last"). Ideal for creating excerpts from long documents or excluding cover pages from batch processing.

Set the viewport width for formatting the HTML content when generating a PDF. Use this to control how responsive designs render - prevent mobile styles from applying when you want desktop layout, or ensure content appears at the right width.

Specify a viewport width to control content rendering, ensuring it mimics the appearance on various devices or matches specific design requirements.

Set the viewport height for formatting the HTML content when generating a PDF. Specify a viewport height to enforce loading of lazy-loaded images and affect vertical positioning of absolutely positioned elements within the content.

Specify the mode for fitting the HTML content to the print area by upscaling or downscaling it. Use this to prevent content from being cut off at page edges or to enable smart scaling of oversized content.

Specify which blank pages to exclude from the output document to create cleaner PDFs. Use "trailing" to remove empty pages at the end caused by page break issues. Use "all" to remove blank pages throughout the document when converting content with formatting quirks. Helps eliminate unwanted white pages from the final output.

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
  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>

Set the HTML header content with custom styling and dynamic page numbers. Use this to add page numbers, document titles, author names, dates, or company branding to the top of every page. Supports full HTML/CSS for complete design control. Use special CSS classes like pdfcrowd-page-number and pdfcrowd-page-count for dynamic content. Ideal for reports, invoices, and professional documents. 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
  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>

Set the header height to allocate space for header content and prevent overlap with main content. Increase this if your header text is getting cut off or overlapping with page content. Must be large enough to accommodate your header HTML including any multi-line text or images.

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.

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
  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>

Set the HTML footer content with custom styling and dynamic page numbers. Use this to add page numbers, copyright notices, document dates, or company information to the bottom of every page. Supports full HTML/CSS for complete design control. Use special CSS classes like pdfcrowd-page-number and pdfcrowd-page-count for dynamic content. Ideal for contracts, reports, and official documents. 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
  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>

Set the footer height to allocate space for footer content and prevent overlap with main content. Increase this if your footer text is getting cut off or overlapping with page content. Must be large enough to accommodate your footer HTML including any multi-line text or images.

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.

Disable horizontal page margins for header and footer. The header/footer contents width will be equal to the physical page width.

The page header content is not printed on the specified pages. To remove the entire header area, use the conversion config.

The page footer content is not printed on the specified pages. To remove the entire footer area, use the conversion config.

Set the scaling factor (zoom) for the header and footer.

Set the numbering offset for page numbers in header/footer HTML to continue page numbering from a previous document. Use this when generating document sections separately - for example, if you have already generated pages 1-10, set offset to 10. The next section will then start numbering at page 11.

Essential for multi-part reports or book chapters.

Apply the first page of a watermark PDF to every page of the output PDF. Use this to add transparent overlays like "DRAFT" stamps, security markings, or branding elements that appear on top of content. Ideal for confidential document marking or adding protective overlays.

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.

Apply each page of a watermark PDF to the corresponding page of the output PDF. Use this for page-specific watermarks where different pages need different overlays - for example, different approval stamps per department.

If the watermark has fewer pages than the output, the last watermark page is repeated for remaining pages.

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.

Apply the first page of a background PDF to every page of the output PDF. Use this to add letterheads, branded templates, or decorative backgrounds that appear behind your content. Backgrounds appear beneath content, while watermarks layer on top.

Perfect for adding company letterheads to reports or applying branded templates to dynamically generated content.

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.

Apply each page of a background PDF to the corresponding page of the output PDF. Use this for page-specific backgrounds where each page needs a different template - for example, different letterheads for front and back pages.

If the background has fewer pages than the output, the last background page is repeated for remaining pages.

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.

Set a solid background color for all pages, filling the entire page area including margins. Useful for creating branded PDFs with corporate colors, highlighting draft documents, or improving readability with off-white backgrounds.

Supports transparency with RGBA format - use semi-transparent colors for subtle effects without obscuring content. Format as RGB (FF0000) or RGBA (FF000080) hexadecimal.

Use the print version of the page if available via @media print CSS rules. Enable this when converting websites that have print-optimized styles. Many sites hide navigation, ads, and sidebars in print mode.

Produces cleaner PDFs by using the design the website creator intended for printing.

Do not print the background graphics to create printer-friendly PDFs. Use this when documents will be physically printed to save ink costs and improve readability.

Removes background colors, images, and patterns while preserving text and foreground content. Particularly useful for documents with dark backgrounds or decorative elements.

Do not execute JavaScript during conversion. Use this to improve conversion speed when JavaScript is not needed, prevent dynamic content changes, or avoid security risks from untrusted scripts.

Note that disabling JavaScript means lazy-loaded images and AJAX content will not load.

Do not load images during conversion to create text-only PDFs. Use this to significantly speed up conversion, reduce file size, or create accessible text-focused documents.

Ideal for converting documentation where images are not needed, reducing bandwidth usage, or creating lightweight PDFs for email distribution.

Disable loading fonts from remote sources. Use this to speed up conversion by avoiding font download delays, ensure consistent rendering with system fonts, or work around font loading failures.

Note that text will fall back to system fonts, which may change the document's appearance.

Use a mobile user agent when making requests to the source URL.

Specifies how iframes are handled during conversion. Use "all" to include all embedded content (videos, maps, widgets). Use "same-origin" to include only content from the same domain for security purposes. Use "none" to exclude all iframes for faster conversion and to avoid third-party content issues.

Disabling iframes can significantly improve performance and reliability.

Automatically block common advertising networks and tracking scripts during conversion, producing cleaner PDFs with faster conversion times. Filters out third-party ad content, analytics beacons, and ad network resources.

Ideal for converting news sites, blogs, or any ad-heavy content where ads distract from the main message. May occasionally block legitimate third-party content - disable if critical third-party resources are missing.

Specify the character encoding when the HTML lacks proper charset declaration or has incorrect encoding. Prevents garbled text for non-English content, especially legacy pages without UTF-8 encoding.

Set to "utf-8" for modern content, "iso-8859-1" for Western European legacy pages, or other encodings for specific regional content. Only needed when auto-detection fails and you see corrupted characters in the output.

Set the locale for the conversion to control regional formatting of dates, times, and numbers. Use this when converting content for specific regions - for example, set to "en-US" for MM/DD/YYYY dates and comma thousand separators, or "de-DE" for DD.MM.YYYY dates and period thousand separators.

Essential for financial reports, invoices, or localized content.

Set credentials to access HTTP basic authentication protected websites. Use this when converting content behind HTTP authentication, such as development servers, staging environments, or password-protected documentation.

Provide both username and password to authenticate requests. Essential for converting internal resources or protected content.

Set HTTP cookies to be included in all requests made by the converter to access authenticated or session-based content. Use this when converting pages that require login, maintain user sessions, or personalize content based on cookies.

Essential for converting member-only areas, dashboards, or any content behind cookie-based authentication. Format as semicolon-separated name=value pairs.

Enforce SSL certificate validation for secure connections, preventing conversions from sites with invalid certificates. Enable when converting from production sites with valid certificates to ensure security.

When disabled, allows conversion from any HTTPS site regardless of certificate validity - including development servers with self-signed certificates, internal corporate sites with expired certificates, or local testing environments.

Abort the conversion if the HTTP status code of the main URL is greater than or equal to 400 (client/server errors). Use this in automated workflows to catch broken URLs or authentication failures early rather than producing invalid PDFs. Ensures your system does not silently generate error page PDFs when source content is unavailable.

Abort the conversion if any sub-request (images, stylesheets, scripts) fails with HTTP 400+ errors. Use this for strict quality control when all assets must load successfully.

Do not send the X-Pdfcrowd HTTP header in HTTP requests made by the converter. Use this if your target server blocks or logs requests with this header, or for privacy when you do not want sites to know you are using PDFCrowd. Some security systems may block requests with non-standard headers.

Specifies behavior in the presence of CSS @page rules to control which settings take precedence. Use "default" to prioritize API settings over CSS rules, ensuring consistent output regardless of input HTML. Use "mode2" to respect CSS @page rules for print-optimized HTML.

This solves conflicts when CSS tries to override your API page setup.

Apply custom CSS to the input HTML document to modify the visual appearance and layout of your content dynamically. Use this to override default styles, adjust spacing, change fonts, or fix layout issues without modifying the source HTML.

Use !important in your CSS rules to prioritize and override conflicting styles.

Run a custom JavaScript after the document is loaded and ready to print. Use this to modify page content before conversion, remove unwanted elements, or trigger specific page states. 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.

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.

Set a custom HTTP header to be included in all requests made by the converter. Use this to pass authentication tokens to protected sites, add tracking headers for analytics, or provide API keys for accessing private content.

Essential when converting content from APIs or internal systems that require special headers for access control.

Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Use this to ensure lazy-loaded images, AJAX content, or animations complete before conversion. Your license defines the maximum wait time by "Max Delay" parameter.

Convert only the specified element from the main document and its children. Use this to extract specific portions of a page (like article content) while excluding navigation, headers, footers, or sidebars. 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.

Control how CSS styles are applied when converting only part of a page. The "cut-out" option extracts the element into a new document root, which may break CSS selectors like "body > div". The "remove-siblings" option keeps the element in its original DOM position but deletes other elements, preserving descendant selectors. The "hide-siblings" option keeps all elements but hides non-selected ones with display:none, preserving all CSS context.

Wait for the specified element in a source document. Use this when specific dynamic content must be ready before conversion, avoiding unnecessary delays from a fixed JavaScript delay. 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 license defines the maximum wait time by the "Max Delay" parameter.

The main HTML element for conversion is detected automatically. Use this when you want to extract article or main content without knowing the exact CSS selector, automatically excluding navigation and sidebars.

Automatically enhance the input HTML to improve readability by removing clutter and reformatting content. Use this when converting web pages with excessive navigation, ads, or sidebars that distract from the main content.

Different versions (v1-v4) use progressively aggressive algorithms - start with "v1" and increase if more cleanup is needed. Ideal for converting blog posts, articles, or documentation into clean PDFs.

Set the viewport width in pixels.

Set the viewport height in pixels.

Set the viewport size. Use to control responsive design rendering. Deprecated - use content_viewport_width and content_viewport_height instead.

Set the rendering mode of the page, allowing control over how content is displayed.

Specify the scaling mode used for fitting the HTML contents to the print area.

Disable the intelligent shrinking strategy that tries to optimally fit the HTML contents to a PDF page.

Set the scaling factor (zoom) for the main page area to fit content better. Use values below 100% to shrink oversized content that is getting cut off at page edges. Use values above 100% to enlarge small content for better readability.

Common use cases include shrinking wide tables to fit (70-80%), or enlarging mobile-optimized layouts for desktop PDFs (120-150%).

Set the quality of embedded JPEG images to balance file size and visual quality. Use 100% for archival documents or when image quality is critical. Use 70-85% for web distribution to significantly reduce file size with minimal visible quality loss.

Use lower values (50-60%) only when file size is more important than image clarity.

Common artifacts below 60% include blockiness and color banding.

Specify which image types will be converted to JPEG to reduce PDF file size. Use "opaque" to convert only non-transparent images (safe for most documents). Use "all" to convert everything including transparent images (transparent areas become white).

Use "none" to preserve original image formats.

Ideal for reducing file size when distributing large image-heavy PDFs via email or web.

Set the DPI of images in PDF to control resolution and file size. Use 300 DPI for professional printing, 150 DPI for everyday documents, 96 DPI for screen-only viewing, or 72 DPI for web distribution.

Lower DPI creates smaller files but reduces image quality. Use 0 to preserve original image resolution.

Note that this only downscales - it will not upscale low-resolution images.

Convert HTML forms to fillable PDF forms that users can complete in PDF readers. Use this to create interactive PDFs from HTML forms.

Ideal for creating fillable applications, surveys, or order forms that work offline. Details can be found in the blog post.

Create linearized PDF. This is also known as Fast Web View. Use this to optimize PDFs for progressive download, allowing users to start viewing the first page while the rest downloads.

Encrypt the PDF to prevent search engines from indexing the contents and add an extra layer of security. Use this for confidential documents, internal reports, or any content you do not want appearing in search results.

Combine with a password to require authentication for viewing, or just use encryption alone to prevent indexing while keeping the PDF publicly readable.

Protect the PDF with a user password to restrict who can open and view the document. Recipients must enter this password to view the PDF. Use this for confidential documents, sensitive data, or content distribution where you want to control access.

Combine with permission flags to restrict what users can do after opening.

Protect the PDF with an owner password for administrative control. This password allows changing permissions, passwords, and document restrictions - like a master key. Use different user and owner passwords to give recipients restricted access while retaining full control.

The owner password should be kept confidential and different from the user password.

Disallow printing of the output PDF to protect sensitive content. Use this for confidential documents, copyrighted materials, or preview versions you want to restrict.

Disallow modification of the output PDF to maintain document integrity. Use this for official documents, contracts, or records that should not be altered after creation. Prevents recipients from editing content, adding annotations, or extracting pages.

Disallow text and graphics extraction from the output PDF to protect copyrighted content. Use this for ebooks, proprietary documents, or materials where you want to prevent easy copying and redistribution.

Set the title of the PDF that appears in PDF reader title bars and document properties. Use descriptive titles for better organization and searchability in document management systems.

This metadata helps users identify documents when multiple PDFs are open and improves accessibility for screen readers.

Set the subject of the PDF to categorize or summarize the document content. Use this to add searchable metadata for document management systems, improve organization in large PDF libraries, or provide context about the document's purpose.

Appears in PDF properties dialog.

Set the author of the PDF for attribution and document tracking. Use this to identify who created the document, important for official documents, reports, or publications.

This metadata appears in PDF properties and helps with document management and version control.

Associate keywords with the document to improve searchability in document management systems. Use relevant terms that describe the content, making it easier to find documents later.

Separate multiple keywords with commas. Particularly useful for large document repositories or DAM systems.

Extract meta tags (author, keywords and description) from the input HTML and automatically populate PDF metadata. Use this when converting web pages that already have proper HTML meta tags, saving you from manually setting title, author, and keywords.

Ideal for automated conversion workflows where source HTML is well-structured.

Control how pages appear when the PDF opens in viewers that respect these preferences. "single-page" for focused reading one page at a time. "one-column" for continuous scrolling like a web page. "two-column-left" for book-like layouts with odd pages on left (international standard). "two-column-right" for magazines with odd pages on right.

Control the initial display mode when the PDF opens. "full-screen" for presentations and kiosk displays where you want an immersive experience. "thumbnails" for long documents where visual page navigation is helpful. "outlines" for structured documents with bookmarks/table of contents.

Control how the PDF is initially zoomed when opened.

Display the specified page when the document is opened.

Specify the initial page zoom in percents when the document is opened.

Hide the viewer's toolbar when the PDF is opened to provide a cleaner, more focused reading experience. Use this for presentations, kiosk displays, or immersive reading where you want minimal UI distractions.

Hide the viewer's menu bar when the PDF is opened for a cleaner interface. Use this for kiosk mode, presentations, or embedded PDFs where you want to minimize UI elements.

Hide user interface elements like scroll bars and navigation controls when the PDF opens. Use this for presentation mode, digital signage, or embedded PDFs where you want the most minimal interface possible.

Combines with other UI hiding options for full-screen immersive viewing.

Resize the PDF viewer window to fit the size of the first displayed page when opened. Use this to ensure the PDF opens at an appropriate size rather than filling the entire screen.

Particularly useful for small documents, forms, or certificates that look better at actual size.

Position the PDF viewer window in the center of the screen when opened. Use this with window resizing to create a professional, centered display for forms, certificates, or small documents.

Improves the initial viewing experience by avoiding corner-positioned windows.

Display the title of the HTML document in the PDF viewer's title bar instead of the filename. Use this to show more descriptive titles when PDFs are opened - particularly useful when the filename is cryptic or auto-generated.

Improves user experience by showing meaningful document names.

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.

Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.

Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.

Specify the input data format. Use "auto" for automatic detection or explicitly set to JSON, XML, YAML, or CSV when format is known.

Set the encoding of the data file set by setDataFile.

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.

Auto escape HTML symbols in the input data before placing them into the output.

Auto trim whitespace around each template command block.

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.

Turn on debug logging to troubleshoot conversion issues. Details about the conversion process, including resource loading, rendering steps, and error messages are stored in the debug log. Use this when conversions fail or produce unexpected results. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.

Get the URL of the debug log for the last conversion.

Get the number of conversion credits available in your account. Use this to monitor your credit usage and implement alerts before running out of credits.
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.

Get the number of credits consumed by the last conversion. Use this to track costs per conversion, especially for complex documents or operations that may consume multiple credits.

Get the unique job ID for the conversion. Use this to track conversions in your logs, correlate with debug logs, or reference specific conversions when contacting support.

Get the number of pages in the output document. Use this to validate conversion results, calculate pagination for user interfaces, or track document complexity metrics.

Get the total number of pages in the original output document, including the pages excluded by setPrintPageRange().

Get the size of the output document in bytes. Use this to check file sizes before delivery, implement size-based quotas, or optimize storage allocation.

Get the version details including API version, converter version, and client library version. Use this for debugging, logging, or ensuring compatibility when reporting issues.

Tag the conversion with a custom value for tracking and analytics. Use this to categorize conversions by customer ID, document type, or business unit. The tag appears in conversion statistics. A value longer than 32 characters is cut off.

A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. This can help circumvent regional restrictions or provide limited access to your intranet.

A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. This can help circumvent regional restrictions or provide limited access to your intranet.

A client certificate to authenticate the converter on your web server. The certificate is used for two-way SSL/TLS authentication (mutual TLS) and adds extra security. Use this when converting content from servers that require client certificate authentication for access.

A password for the PKCS12 file with a client certificate if the certificate file is password-protected.

Set the internal DPI resolution used for positioning of PDF contents. It can help in situations where there are small inaccuracies in the PDF. It is recommended to use values that are a multiple of 72, such as 288 or 360.

Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.

Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.

Set the width of the content area. It should be at least 1 inch.

Set the height of the content area. It should be at least 1 inch.

Set the content area position and size. The content area enables you to specify a web page area to be converted.

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.

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.

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.

Disable automatic height adjustment that compensates for pixel to point rounding errors.

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

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

Set the maximum time for loading 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.

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).
  • backgroundColor: Page background color in RRGGBB or RRGGBBAA hexadecimal format (optional).

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

Configure the conversion process via JSON file. See details of the JSON string.

Specify the User-Agent HTTP header that will be used by the converter when a request is made to the converted web page.

Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.

Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.

Specify the User-Agent HTTP header that the client library will use when interacting with the API.

Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.

Specify an HTTP proxy that the API client library will use to connect to the internet.

Specify the number of automatic retries when a 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.