Screenshots

Use GET or POST /render/screenshot. Requests cost one credit before optional add-ons.

Try the Playground

Open the signed-in Playground, enter a page URL, choose your capture options, and press Render screenshot. Device switches do not capture automatically. Use Code for the equivalent request and Details for the returned JSON. Playground previews use stored screenshots.

Playground in Capture mode with viewport and region options beside a saved Tailwind CSS screenshot.

Current Playground UI shown with a previously captured Tailwind CSS page in an isolated documentation session.

Binary responses

Without storage, synchronous requests return raw image/jpeg or image/png bytes.

curl --get "https://api.scrinly.com/render/screenshot" \
  --header "Authorization: Bearer $SCRINLY_API_KEY" \
  --data-urlencode "url=https://example.com" \
  --data-urlencode "fullPage=true" \
  --data-urlencode "format=jpg" \
  --output page.jpg

const response = await fetch("https://api.scrinly.com/render/screenshot", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SCRINLY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://example.com", fullPage: true }),
});
const bytes = await response.arrayBuffer();

import os, requests

response = requests.post(
    "https://api.scrinly.com/render/screenshot",
    headers={"Authorization": f"Bearer {os.environ['SCRINLY_API_KEY']}"},
    json={"url": "https://example.com", "fullPage": True},
)
response.raise_for_status()
open("page.jpg", "wb").write(response.content)

Stored JSON responses

Set store:true and a storage_path to receive metadata and a direct provider URL instead of binary bytes. Async, regions, and Visual Style Guide requests imply storage.

{
  "success": true,
  "type": "screenshot",
  "media": {
    "stored": true,
    "key": "screenshots/2f7a...jpg",
    "url": "https://storage.example.com/screenshots/2f7a...jpg",
    "contentType": "image/jpeg",
    "width": 1280,
    "height": 720,
    "sha256": "2f7a..."
  }
}

The response header X-Scrinly-Storage-URL points to the same complete screenshot. Generated keys are content-addressed, so changed captures of the same target and prefix cannot overwrite earlier evidence.

Capture controls

Option	Default	Notes
`format`	`jpg`	`jpg` or `png`
`quality`	`80`	JPEG only, 1–100
`width`, `height`	`1280 × 720`	Custom viewport, maximum 3840 × 2160
`device`	—	Preset that overrides width and height
`fullPage`	`false`	Bounded progressive scrolling and verified complete bitmap
`theme`	`light`	`light` or `dark` color-scheme emulation
`timeout`	`30`	10–60 seconds
`waitUntil`	`load`	`load`, `domcontentloaded`, `networkidle0`, or `networkidle2`; network-idle modes are opt-in for pages that eventually become quiet
`hideSelectors`	—	Hide matching elements
`clickSelectors`	—	Click selectors in order
`scrollToElement`	—	Bring one element into view
`headers`, `cookies`	—	Authorized-page credentials; POST recommended

Cleanup controls include blockCookieBanners, blockAds, blockChatWidgets, blockPopups, and blockAccessibilityWidgets. Set them deliberately when the authored page should remain untouched. Full-page preparation progressively scrolls through finite content, waits for lazy images and fonts, returns to the top, and verifies the encoded image dimensions. An unbounded page or incomplete bitmap fails with a typed capture_error and refunds the screenshot credit rather than returning a silent crop. If page navigation exceeds timeout, Scrinly returns the retryable navigation_timeout capture error and refunds the complete charge. Increasing the timeout or explicitly selecting a stricter wait strategy is useful only when the target genuinely needs it.

Raw design evidence

design:true adds an advanced raw evidence object from the same page session. It describes observed palette, typography, spacing, motion, breakpoints, tokens, and library signals. It is optional evidence for customers that need the raw data; the Visual Style Guide enables its own private bounded projection automatically.

Getting started

AI agents

Capture

Compare and monitor

Scale and delivery

Reliability

Try the Playground

Binary responses

Stored JSON responses

Capture controls

Raw design evidence

​Try the Playground

​Binary responses

​Stored JSON responses

​Capture controls

​Raw design evidence

Try the Playground

Binary responses

Stored JSON responses

Capture controls

Raw design evidence