Screenshot a web page

post/v1/screenshot

Request

  • Base URL: https://shotkiln.com
  • URL: https://shotkiln.com/v1/screenshot
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • none

Request body

urlstring uri required

Public http(s) URL (ports 80/443/8080/8443)

widthinteger
heightinteger
full_pageboolean

Capture the full scrollable page (max 16384 px tall)

scrollboolean

With full_page: scroll through the page in steps first, then back to the top, so lazy-loaded images appear. Bounded by the render timeout. Set false to capture without scrolling. Ignored for viewport captures.

format'png' | 'jpeg' | 'webp'
qualityinteger

jpeg/webp only

delayinteger

Extra wait after load (ms)

device_scale_factornumber
dark_modeboolean

Emulate prefers-color-scheme: dark

cache_ttlinteger

Seconds to cache; 0 = always render fresh. Cache hits do not use quota.

Response

Rendered file

Changes

No recorded changes to this operation across all 2 revisions of this API.