Documentation Guide

Capture a full webpage safely

Request the complete document while keeping output height, runtime, and artifact size bounded.

HTTPS API api-screenshot.com/v1 Bearer auth · JSON requests · private artifacts
Private development preview The contract is documented for integration planning. Production API routes currently return HTTP 503 and no live keys are being issued. OpenAPI 3.1 →
full_page

Enable full-page capture

Set full_page to true. The worker measures the document and captures beyond the initial viewport, up to the configured maximum page height.

Full-page WebP request bash
curl https://api-screenshot.com/v1/screenshots \
  -H "Authorization: Bearer $SCREENSHOT_API_KEY" \
  -H "Idempotency-Key: docs-full-page-001" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/long-page",
    "preset": "desktop",
    "full_page": true,
    "format": "webp",
    "quality": 82,
    "block_cookie_banners": true
  }'
Resource limits

Expect bounded output

The initial renderer contract caps full-page height at 30,000 pixels. A page may also stop earlier because of render timeout, memory pressure, redirect limits, or oversized responses.

  • Prefer WebP or JPEG for large photographic pages.
  • Use PNG when lossless text and interface edges matter.
  • Do not assume infinite-scroll pages have a stable bottom.
  • Read artifact width and height from the completed resource.
Readiness

Handle client-rendered pages deliberately

Start with wait_until set to load. For sites that paint important content later, use networkidle or a small delay_ms after measuring the target behavior. Avoid arbitrary long waits.