Screenshot (Alpha)

Screenshot (Alpha)

Capture a public HTTP(S) page as a PNG. Returns JSON with screenshot_url; full_page=false captures the viewport, full_page=true captures the full page. Images are retained for 7 days and require bearer authentication to download. Supports cookies, viewport, scripts and page readiness controls in an isolated browser. Uses a separate Screenshot call in the existing balance and concurrency allowance. Unavailable for keys with ZDR enabled. Alpha contract may change.

post/api/web/screenshot

Request

  • Base URL: https://api.litescrape.com
  • URL: https://api.litescrape.com/api/web/screenshot
  • Auth: HTTP bearer

Query parameters

timeoutnumber

Optional budget for the entire request in seconds, measured from gateway receipt until the response is ready to send. Includes admission, queueing and settlement. Must be greater than 0 and at most 90. On expiry, the call is not billed and returns 503 request_deadline_exceeded with retryable=true and a request ID. Omit to retain the standard server deadline.

Request body

urlstring required

Public HTTP(S) URL to capture, 1-8,192 characters. Include http:// or https://; bare domains are rejected. The host must be public, on port 80 or 443, without embedded credentials.

remove_overlayboolean nullable

Remove modal and cookie-banner overlays from the page.

detach_invisiblesboolean nullable

Drop display:none elements from the page.

set_cookiesstring[] nullable

POST only. 1-100 cookies in Set-Cookie syntax (name=value; Path=/; Domain=...), one line each, up to 4,096 characters.

user_agentstring nullable

User-Agent for the page request, 1-1,024 characters without control characters. Defaults to the browser's own.

inject_page_scriptstring[] nullable

POST only. 1-8 scripts (source, or a URL to a script), up to 8,192 characters each, run in the main frame.

inject_frame_scriptstring[] nullable

POST only. 1-8 scripts (source, or a URL to a script), up to 8,192 characters each, run in every frame.

page_timeoutinteger nullable

Seconds from 1 through 180 for page loading and browser operations. Cannot extend the total request budget set by timeout.

localestring nullable

Browser locale as a language tag, 2-64 characters. Defaults to the browser's own.

refererstring nullable

HTTP(S) URL sent as the Referer.

assert_status_codeinteger nullable

Expected origin HTTP status, 100-599. A different status is rejected; otherwise a rendered error page is a successful capture.

robots_txtstring nullable

User agent, 1-256 characters, to check against the site's robots.txt; disallowed URLs are rejected.

respond_timing'html' | 'visible-content' | 'mutation-idle' | 'resource-idle' | 'media-idle' | 'network-idle' nullable

Page readiness condition to reach before responding.

full_pageboolean

Capture the full page when true. The default, false, captures the viewport.

Example request

{
  "url": "https://example.com",
  "set_cookies": [
    "session=YOUR_SESSION; Path=/; Secure; HttpOnly"
  ],
  "page_timeout": 30,
  "locale": "en-US",
  "referer": "https://example.com",
  "assert_status_code": 200,
  "viewport": {
    "height": 900,
    "width": 1440
  },
  "robots_txt": "MyBot",
  "respond_timing": "network-idle",
  "full_page": true
}

Response

Successful capture; one call consumed even for a rendered origin error page.

urlstring required
titlestring required
descriptionstring required
screenshot_urlstring required

PNG artifact; download with the same bearer key. Retained for 7 days.

full_pageboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.