{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API - Full Page PNG, JPEG & PDF", "description": "Capture screenshots of any URL or raw HTML as PNG, JPEG, WebP or PDF. Full page, element or region, mobile and desktop presets, dark mode, cookie-banner hiding and lazy-load scrolling. Get a direct file link per page.", "version": "0.1", "x-build-id": "Spf84NUlA1u43lnP9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zenomastro~website-screenshot-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zenomastro-website-screenshot-pro", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/zenomastro~website-screenshot-pro/runs": { "post": { "operationId": "runs-sync-zenomastro-website-screenshot-pro", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/zenomastro~website-screenshot-pro/run-sync": { "post": { "operationId": "run-sync-zenomastro-website-screenshot-pro", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "urls": { "title": "Page URLs", "minItems": 0, "maxItems": 200, "type": "array", "description": "Public HTTP/HTTPS pages to capture. Can be combined with raw htmlDocuments.", "default": [ "https://example.com" ], "items": { "type": "string" } }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the entire scrollable page when no element selector is set.", "default": true }, "elementSelector": { "title": "CSS element selector", "type": "string", "description": "Optional CSS selector to capture one visible element instead of the full page.", "default": "" }, "viewportWidth": { "title": "Viewport width", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Browser viewport width in pixels.", "default": 1440 }, "viewportHeight": { "title": "Viewport height", "minimum": 240, "maximum": 2160, "type": "integer", "description": "Browser viewport height in pixels.", "default": 900 }, "format": { "title": "Image format", "enum": [ "png", "jpeg", "webp", "pdf" ], "type": "string", "description": "Screenshot output format.", "default": "png" }, "jpegQuality": { "title": "JPEG quality", "minimum": 20, "maximum": 100, "type": "integer", "description": "JPEG quality from 20 to 100; ignored for PNG.", "default": 85 }, "delayMs": { "title": "Delay after page load", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Extra milliseconds to wait after DOMContentLoaded before capture.", "default": 500 }, "navigationTimeoutSecs": { "title": "Navigation timeout", "minimum": 10, "maximum": 180, "type": "integer", "description": "Maximum seconds to wait for page navigation.", "default": 45 }, "skipErrorPages": { "title": "Skip error and bot-challenge pages", "type": "boolean", "description": "Do not save or bill pages that answer with HTTP 4xx/5xx or show an anti-bot challenge (for example 'Just a moment...'). They are returned as free error rows instead. Off by default: such pages are captured and flagged with isErrorPage.", "default": false }, "hideConsentBanners": { "title": "Hide common consent banners", "type": "boolean", "description": "Hide cookie/consent banners before capture: known consent platforms (OneTrust, Cookiebot, Didomi, Usercentrics, Quantcast and more) plus elements whose id/class contains cookie or consent. Page wrappers that hold the main content are never hidden. Untick to leave banners visible. For clicking Accept/Reject instead, use Consent banner handling.", "default": true }, "consentBannerMode": { "title": "Consent banner handling", "enum": [ "hide", "accept", "reject", "off" ], "type": "string", "description": "hide (default) = hide banners; accept / reject = click the banner's 'Accept all' or 'Reject all' button on 16 known consent platforms (OneTrust, Cookiebot, Didomi, Usercentrics, Quantcast, TrustArc, Sourcepoint, Google, Complianz, CookieYes, iubenda, Osano and more) or a clearly labelled button in a cookie banner, then capture the page as a visitor would see it (waits up to 2.5 s for a banner to appear); falls back to hiding when no button is found; off = leave banners as they are. Leave empty to follow 'Hide common consent banners'." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify or custom proxy configuration for pages that block direct cloud access.", "default": { "useApifyProxy": false } }, "userAgent": { "title": "User agent", "type": "string", "description": "Browser User-Agent string.", "default": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 Chrome/143.0.0.0 Safari/537.36" }, "devicePreset": { "title": "Device preset", "enum": [ "desktop", "desktop_hd", "desktop_retina", "laptop", "macbook_air", "iphone_se", "iphone_13", "iphone_15", "iphone_15_pro_max", "pixel_7", "pixel_8", "galaxy_s23", "ipad", "ipad_pro" ], "type": "string", "description": "Built-in viewport, DPR and mobile/touch behavior. Explicit width/height can override dimensions.", "default": "desktop" }, "devicePresets": { "title": "Capture on several devices (responsive)", "type": "array", "description": "Optional. Pick 2 or more devices to capture every URL on each of them in one run (one result per URL and device, joined by captureGroupId). Each device uses its own screen size; viewport width/height are ignored, a device pixel ratio override applies to all. Leave empty to use the single Device preset above. Each capture is billed as one screenshot.", "items": { "type": "string", "enum": [ "desktop", "desktop_hd", "desktop_retina", "laptop", "macbook_air", "iphone_se", "iphone_13", "iphone_15", "iphone_15_pro_max", "pixel_7", "pixel_8", "galaxy_s23", "ipad", "ipad_pro" ], "enumTitles": [ "Desktop 1440×900", "Desktop Full HD", "Desktop Retina", "Laptop 1366×768", "MacBook Air", "iPhone SE", "iPhone 13", "iPhone 15", "iPhone 15 Pro Max", "Pixel 7", "Pixel 8", "Galaxy S23", "iPad", "iPad Pro" ] }, "default": [] }, "deviceScaleFactor": { "title": "Device pixel ratio", "minimum": 1, "maximum": 4, "type": "number", "description": "Override preset deviceScaleFactor for retina/high-DPI captures." }, "colorScheme": { "title": "Color scheme", "enum": [ "no-preference", "light", "dark" ], "type": "string", "description": "Emulate prefers-color-scheme.", "default": "no-preference" }, "waitUntil": { "title": "Wait until", "enum": [ "domcontentloaded", "load", "networkidle" ], "type": "string", "description": "Navigation readiness strategy before optional delay.", "default": "domcontentloaded" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Optional selector that must become visible before capture.", "default": "" }, "hideAdsAndTrackers": { "title": "Block common ads & trackers", "type": "boolean", "description": "Abort requests to a conservative list of common analytics/ad hosts.", "default": false }, "hideSelectors": { "title": "Extra selectors to hide", "maxItems": 100, "type": "array", "description": "Custom CSS selectors hidden before capture.", "default": [], "items": { "type": "string" } }, "blockResourceTypes": { "title": "Block resource types", "type": "array", "description": "Optional Playwright resource types to block, e.g. font, media.", "default": [], "items": { "type": "string" } }, "extraHTTPHeaders": { "title": "Extra HTTP headers", "type": "object", "description": "Optional request headers such as Accept-Language or Authorization. Stored encrypted and hidden from logs." }, "cookies": { "title": "Cookies", "maxItems": 100, "type": "array", "description": "Optional Playwright cookie objects for pages you are authorized to access. Stored encrypted and hidden from logs." }, "captureConsole": { "title": "Capture console/page errors", "type": "boolean", "description": "Include bounded browser console messages and page JavaScript errors.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Stable name used to compare captures across scheduled runs.", "default": "" }, "comparePrevious": { "title": "Compare with previous capture", "type": "boolean", "description": "When monitorName is set, compare every capture with the previous capture of the same page (and device): exact hash change plus pixel-change percentage, changed regions and a change flag based on the threshold below. PNG, JPEG and WebP only.", "default": false }, "changeThresholdPercent": { "title": "Visual change threshold (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Share of changed pixels above which changedBeyondThreshold is true. Small values catch tiny edits, larger values ignore rotating ads and carousels. Used with monitorName and Compare with previous capture.", "default": 0.5 }, "saveDiffImage": { "title": "Save visual diff image", "type": "boolean", "description": "With Compare with previous capture: also save a PNG that highlights changed pixels in red (diffImageUrl). Only saved when something changed.", "default": false }, "pdfPageSize": { "title": "PDF page size", "enum": [ "A4", "Letter", "Legal" ], "type": "string", "description": "Used only for PDF output.", "default": "A4" }, "pdfPrintBackground": { "title": "PDF print backgrounds", "type": "boolean", "description": "Include CSS backgrounds in PDF.", "default": true }, "pdfLandscape": { "title": "PDF landscape", "type": "boolean", "description": "Landscape PDF orientation.", "default": false }, "pdfMarginTop": { "title": "PDF margin top", "type": "string", "description": "Used only for PDF output: top page margin with a unit, e.g. 0.4in, 10mm or 1cm. Empty = 0.4in." }, "pdfMarginRight": { "title": "PDF margin right", "type": "string", "description": "Used only for PDF output: right page margin with a unit, e.g. 0.4in, 10mm or 1cm. Empty = 0.4in." }, "pdfMarginBottom": { "title": "PDF margin bottom", "type": "string", "description": "Used only for PDF output: bottom page margin with a unit, e.g. 0.4in, 10mm or 1cm. Empty = 0.4in." }, "pdfMarginLeft": { "title": "PDF margin left", "type": "string", "description": "Used only for PDF output: left page margin with a unit, e.g. 0.4in, 10mm or 1cm. Empty = 0.4in." }, "webpQuality": { "title": "WebP quality", "minimum": 20, "maximum": 100, "type": "integer", "description": "WebP output quality from 20 to 100.", "default": 82 }, "clip": { "title": "Region clip", "type": "object", "description": "Optional region capture object with numeric x, y, width and height. Mutually exclusive with elementSelector and PDF.", "default": {} }, "geolocation": { "title": "Geolocation", "type": "object", "description": "Optional browser geolocation object: latitude, longitude and optional accuracy.", "default": {} }, "httpCredentials": { "title": "HTTP Basic credentials", "type": "object", "description": "Optional username/password for HTTP Basic authentication on pages you are authorized to access. Stored encrypted and hidden from logs." }, "locale": { "title": "Browser locale", "type": "string", "description": "Browser locale such as en-US, it-IT or de-DE.", "default": "en-US" }, "timezoneId": { "title": "Timezone", "type": "string", "description": "Optional IANA timezone such as Europe/Rome or America/New_York.", "default": "" }, "htmlDocuments": { "title": "Raw HTML documents", "maxItems": 100, "type": "array", "description": "Optional raw HTML objects with html, optional baseUrl and id. Useful for rendering generated HTML without hosting it.", "items": { "type": "object", "properties": { "html": { "title": "HTML", "type": "string", "description": "Raw HTML source to render.", "editor": "textarea" }, "baseUrl": { "title": "Base URL", "type": "string", "description": "Optional public HTTP/HTTPS base URL used to resolve relative resources.", "editor": "textfield" }, "id": { "title": "Document ID", "type": "string", "description": "Optional stable identifier copied into output.", "editor": "textfield" } }, "required": [ "html" ] }, "default": [] }, "waitForFonts": { "title": "Wait for web fonts", "type": "boolean", "description": "Wait for document.fonts.ready before capture so text layout is more stable.", "default": true }, "autoScroll": { "title": "Auto-scroll for lazy content", "type": "boolean", "description": "Scroll through the page before capture to trigger lazy-loaded images and sections, then return to the top.", "default": true }, "scrollStepPx": { "title": "Auto-scroll step (px)", "minimum": 100, "maximum": 3000, "type": "integer", "description": "Vertical distance per lazy-load scroll step.", "default": 700 }, "scrollDelayMs": { "title": "Auto-scroll delay (ms)", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Delay between lazy-load scroll steps.", "default": 80 }, "maxScrollSteps": { "title": "Maximum auto-scroll steps", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard cap on lazy-load scrolling for very long pages.", "default": 40 }, "hideStickyElements": { "title": "Hide sticky/fixed page chrome", "type": "boolean", "description": "Optionally hide wide fixed/sticky headers and footers before capture. Disabled by default to avoid changing intentional page content.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }