Sign in

Generate a screenshot or PDF of a website, render HTML, or Markdown

Generate a screenshot or PDF by specifying a website URL, render HTML, or Markdown.

post/take

Request body

access_keystring
urlstring uri
htmlstring
markdownstring
selectorstring
error_on_selector_not_foundboolean
response_type'by_format' | 'empty'
format'png' | 'jpeg' | 'jpg' | 'webp' | 'gif' | 'jp2' | 'tiff' | 'avif' | 'heif' | 'html'
clip_xinteger
clip_yinteger
clip_widthinteger
clip_heightinteger
dark_modeboolean
reduced_motionboolean
media_type'screen' | 'print'
scriptsstring
scripts_wait_until'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
stylesstring
hide_selectorsstring[]
hoverstring
error_on_hover_selector_not_foundboolean
clickstring
image_qualityinteger
image_widthinteger
image_heightinteger
omit_backgroundboolean
viewport_devicestring
viewport_widthinteger
viewport_heightinteger
device_scale_factorinteger
viewport_mobileboolean
viewport_has_touchboolean
viewport_landscapeboolean
full_pageboolean
full_page_scrollboolean
full_page_scroll_delayinteger
full_page_scroll_byinteger
geolocation_latitudeinteger
geolocation_longitudeinteger
geolocation_accuracyinteger
block_cookie_bannersboolean
block_banners_by_heuristicsboolean
block_chatsboolean
block_adsboolean
block_socialsboolean
block_trackersboolean
block_requestsstring[]
block_resourcesstring[]
cacheboolean
cache_ttlinteger
cache_keystring
user_agentstring
authorizationstring
headersstring[]
cookiesstring[]
proxystring uri
proxy_bypass_hostsstring[]
time_zone'America/Santiago' | 'Asia/Shanghai' | 'Europe/Berlin' | 'America/Guayaquil' | 'Europe/Madrid' | 'Pacific/Majuro' | 'Asia/Kuala_Lumpur' | 'Pacific/Auckland' | 'Europe/Lisbon' | 'Europe/Kiev' | 'Asia/Tashkent' | 'Europe/London'
delayinteger
timeoutinteger
wait_untilstring[]
wait_for_selectorstring
storeboolean
storage_bucketstring
storage_pathstring
storage_class'standard' | 'reduced_redundancy' | 'standard_ia' | 'onezone_ia' | 'intelligent_tiering' | 'glacier' | 'deep_archive' | 'outposts' | 'glacier_ir'

Response

A successful rendering result of website, HTML, or Markdown.

Changes

Changed in 2 of the 3 revisions of this API.3

  • 5a976deb0c8a1See the full diff
    • ○

      added the new optional request property allOf[ScreenshotOptions]/proxy_bypass_hosts

      new-optional-request-property

  • d71408f2b0712See the full diff
    • ○

      added the new optional request property allOf[ScreenshotOptions]/error_on_hover_selector_not_found

      new-optional-request-property

    • ○

      added the new optional request property allOf[ScreenshotOptions]/hover

      new-optional-request-property