Link Search Menu Expand Document

Parameters Reference

Detailed information on all the available parameters for the API.

Parameters

The create image endpoint accepts the following parameters. Accepted as either json or formdata.

Name Type Description
html† String This is the HTML you want to render. You can send an HTML snippet (<div>Your content</div>) or an entire webpage.
css String The CSS for your image. When using with url it will be injected into the page.
url† String The fully qualified URL to a public webpage. Such as https://htmlcsstoimage.com. When passed this will override the html param and will generate a screenshot of the url.

Required params

† Either url OR html is required, but not both. css is optional.

Additional parameters

Optional parameters for greater control over your image.

Name Type Description
additional_header_origins Array Allow custom headers on requests to specific additional HTTP or HTTPS origins.
block_consent_banners Boolean When set to true, automatically blocks cookie consent banners and popups on websites. Most useful for URL screenshots.
color_scheme String Set Chrome to render in light or dark mode. Affects websites using prefers-color-scheme.
device_scale Double Controls the image resolution by adjusting the pixel ratio. Minimum: 0.1, Maximum: 3. Higher values increase image quality and file size. For example, 2 will double the resolution.
disable_twemoji Boolean Twemoji is used by default to render emoji consistently. Set to true to use native emoji fonts instead.
full_screen Boolean When set to true, the API will generate an image of the entire height of the page.
google_fonts String Google fonts to be loaded. Example: Roboto. Multiple fonts can be loaded like this: Roboto|Open Sans
headers Object Add custom HTTP headers when screenshotting a URL. Headers are restricted to the requested URL’s origin and any additional_header_origins.
identify_as_hcti Boolean Add X-HCTI-SCREENSHOT: 1 to the top-level request when screenshotting a URL.
include_headers_on_subrequests Boolean Also add custom headers to same-origin subrequests and subrequests matching additional_header_origins.
jumbo_max_height Integer Maximum output height when rendering a jumbo image (up to 80,000px). Must be set together with jumbo_max_width. Consumes extra renders.
jumbo_max_width Integer Maximum output width when rendering a jumbo image (up to 80,000px). Must be set together with jumbo_max_height. Consumes extra renders.
max_wait_ms Integer Sets a maximum time limit (500-10000ms) for waiting before taking the screenshot. Unlike ms_delay, this is a cap rather than a fixed delay. Useful when pages load extra irrelevant content.
media_type String Set Chrome to render using screen or print CSS media styles.
ms_delay Integer The number of milliseconds the API should delay before generating the image. This is useful when waiting for JavaScript. We recommend starting with 500. Large values slow down the initial render time.
pdf_options Object Customize PDF output with page size, margins, scale, and background printing. Use this when you plan to request the generated URL with a .pdf extension.
proxy_id String Route the render’s outbound traffic through one of your HTTP proxies configured in the dashboard. Available on the 10k images/month plan or higher.
render_when_ready Boolean Set to true to control when the image is generated. Call ScreenshotReady() from JavaScript to generate the image.
selector String A CSS selector for an element on the webpage. We’ll crop the image to this specific element. For example: section#complete-toolkit.container-lg
storage_destination_id String Save rendered files to one of your organization’s storage destinations. Available on the 10,000 images/month plan or higher.
timezone String Render your image with Chrome set to a specified timezone. Use IANA timezone identifiers like America/New_York.
transparent_background Boolean Set to true to render with a transparent background. The existing CSS-based method remains supported.
viewport_height Integer Set the height of Chrome’s viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.
viewport_landscape Boolean Set Chrome’s viewport to landscape mode.
viewport_mobile Boolean Set Chrome’s viewport to emulate a mobile device.
viewport_touch Boolean Set Chrome’s viewport to support touch events.
viewport_width Integer Set the width of Chrome’s viewport. This will disable automatic cropping. Both height and width parameters must be set if using either.

Live demo Get an API Key

Table of contents

Back to top

Built with extensive integration tests and serious care for developer happiness.
© 2018-2026 Code Happy, LLC.

Page last modified: Jul 31 2026 at 01:29 PM.

Edit this page on GitHub.