Raw schema
{
"type": "object",
"properties": {
"url": {
"type": "string",
"minLength": 1,
"maxLength": 2048,
"description": "Public page to capture, a full http:// or https:// address (a public domain name; IP addresses, internal hosts and credentials are refused)."
},
"format": {
"description": "Image format (default jpeg). webp is limited to 16350 px per side after scale_factor.",
"type": "string",
"enum": [
"jpeg",
"png",
"webp"
]
},
"width": {
"description": "Viewport width in pixels (default 1920). width x height must not exceed 33,177,600.",
"type": "integer",
"minimum": 1,
"maximum": 16350
},
"height": {
"description": "Viewport height in pixels (default 1080). Ignored with full_page.",
"type": "integer",
"minimum": 1,
"maximum": 16350
},
"full_page": {
"description": "Capture the entire page, not just the viewport (default false).",
"type": "boolean"
},
"scroll_page": {
"description": "Scroll the whole page first to trigger lazy-loaded images and animations (default false).",
"type": "boolean"
},
"wait_until": {
"description": "When the page counts as loaded: dom_loaded, page_loaded or network_idle (default).",
"type": "string",
"enum": [
"dom_loaded",
"page_loaded",
"network_idle"
]
},
"wait_until_timeout": {
"description": "Seconds to wait for wait_until before capturing anyway (default 30, max 30).",
"type": "integer",
"minimum": 1,
"maximum": 30
},
"wait_for": {
"description": "CSS selector to wait for before capturing (the capture fails after 15 s if it never appears).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"delay": {
"description": "Extra seconds to wait after load, 0 to 10. Prefer wait_for or wait_until.",
"type": "integer",
"minimum": 0,
"maximum": 10
},
"element": {
"description": "CSS selector: capture only the first matching element (ignored with full_page).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"crop": {
"description": "Capture an area: left,top,width,height in pixels, e.g. 10,20,50,100.",
"type": "string",
"pattern": "^\\d{1,5},\\d{1,5},\\d{1,5},\\d{1,5}$"
},
"quality": {
"description": "Image quality 0-100 for jpeg and webp (default 80).",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"transparent": {
"description": "Transparent background; png only, and the page body must be transparent.",
"type": "boolean"
},
"scale_factor": {
"description": "Device scale factor: 1 (default) or 2 (retina, larger file).",
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
},
"thumbnail_width": {
"description": "Also resize to this width in pixels, keeping the aspect ratio (ignored with full_page).",
"type": "integer",
"minimum": 1,
"maximum": 16350
},
"no_ads": {
"description": "Block ads.",
"type": "boolean"
},
"no_tracking": {
"description": "Block tracking scripts so the capture does not count as a page view.",
"type": "boolean"
},
"no_cookie_banners": {
"description": "Hide cookie banners and popups.",
"type": "boolean"
},
"accept_language": {
"description": "Accept-Language header for the page, e.g. fr-FR.",
"type": "string",
"pattern": "^[A-Za-z0-9,;=.* -]{1,100}$"
},
"user_agent": {
"description": "User-Agent header to emulate a device.",
"type": "string",
"minLength": 1,
"maxLength": 300
},
"time_zone": {
"description": "Time zone, a tz database name such as Europe/Paris.",
"type": "string",
"pattern": "^[A-Za-z0-9_+/-]{1,64}$"
},
"fail_on_status": {
"description": "HTTP status codes of the page (comma list, ranges with -, e.g. 400,404,500-511) that make the call fail instead of capturing an error page.",
"type": "string",
"maxLength": 100,
"pattern": "^\\d{3}(-\\d{3})?(,\\d{3}(-\\d{3})?)*$"
},
"ttl": {
"description": "Seconds the screenshot stays cached (default 86400, max 30 days). Identical calls within ttl are free.",
"type": "integer",
"minimum": 0,
"maximum": 2592000
},
"fresh": {
"description": "Force a new capture instead of the cached one (always uses quota).",
"type": "boolean"
},
"extract_html": {
"description": "Also extract the page HTML; the reply gets an extracted_html_url link.",
"type": "boolean"
},
"extract_text": {
"description": "Also extract the page text; the reply gets an extracted_text_url link.",
"type": "boolean"
}
},
"required": [
"url"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}