This page serves as a guide for using the PDFCrowd API to capture web pages and HTML content to image screenshots. You can call the API by sending an HTTP request to the API server address with options passed as POST data.
Below are examples to help you quickly get started with the API. Explore our additional examples for more insights.
To access the API, you will need to use your PDFCrowd username and API key. For initial testing, you may use the following demo credentials without registering:
demo
ce544b6ea52a5621fb9d55f8b542d14d
To obtain your personal API credentials, start a free trial or purchase the API license.
The authentication method is HTTP Basic authentication.
The server address:
https://api.pdfcrowd.com/convert/24.04/
The content type for POST requests must
be `multipart/form-data`
if the request uploads any local files. Otherwise,
`application/x-www-form-urlencoded`
can also be used.
Show older API versions.
The table below highlights the most common customizations you might find useful. Refer to the Option Reference for a detailed description of all available options. For an interactive experience, explore these options in the API Playground.
For additional customization options and Troubleshooting, please visit the FAQ section of our website where you can find answers and help related to frequent queries and common issues.
Image size | Customize the dimensions of the captured images using the screenshot_width and screenshot_height. |
Image format | Change the ouput image format using output_format. |
Hide or Remove Contents |
Use the following classes in your HTML code to hide or remove
elements from the output:
|
Custom CSS Styling |
To customize CSS styling specifically for the conversion, use
custom_css to inject additional styles.
Alternatively, you can directly incorporate conversion-specific styling into your main stylesheet. Just prefix your CSS selectors with `.pdfcrowd-body` to ensure
the styles apply only during the conversion process. For
example:.pdfcrowd-body h1 { font-size: 48px; } .pdfcrowd-body footer { display: none; }
|
Use `@media print` |
Activate the print version of a webpage (if
available) using use_print_media.
This function instructs the API
to apply the CSS rules defined within the `@media print`
stylesheet, ensuring the output mirrors the print-optimized version of the webpage.
|
Inject Custom JavaScript | Use custom_javascript or on_load_javascript to modify HTML content using custom JavaScript scripts. These scripts run when the page loads, allowing you to dynamically alter elements, styles, or behavior. In addition to the standard browser JavaScript APIs, your scripts can leverage helper functions provided by our JavaScript library. |
HTML Templates | Add data to your HTML templates for dynamic generation tailored to specific content needs. For details, refer to HTML Template to Image. |
The HTTP response contains the following headers.
Name | Description |
---|---|
x-pdfcrowd-debug-log | URL of the debug log |
x-pdfcrowd-remaining-credits | The number of conversion credits remaining in your account |
x-pdfcrowd-consumed-credits | The number of credits used for the conversion |
x-pdfcrowd-job-id | The unique identifier for the conversion |
x-pdfcrowd-output-size | Size of the output data in bytes |
Refer to the HTML to Image POST Reference for a description of all options.