{ "openapi": "3.0.1", "info": { "title": "Website Screenshot Pro", "description": "Take clean website screenshots in bulk: auto-closes cookie banners, blocks ads, desktop/tablet/mobile presets, full-page or element capture, PDF export and visual change detection between runs.", "version": "0.1", "x-build-id": "tXAK9tmJqcJebhGfv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pinkish_gallop~website-screenshot-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pinkish_gallop-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/pinkish_gallop~website-screenshot-pro/runs": { "post": { "operationId": "runs-sync-pinkish_gallop-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/pinkish_gallop~website-screenshot-pro/run-sync": { "post": { "operationId": "run-sync-pinkish_gallop-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", "required": [ "urls" ], "properties": { "urls": { "title": "URLs", "type": "array", "description": "Pages to capture, one per line. Domains without https:// are accepted.", "items": { "type": "string" } }, "devices": { "title": "Devices", "type": "array", "description": "One screenshot per URL per device (each is billed).", "items": { "type": "string", "enum": [ "desktop", "desktop-hd", "laptop", "tablet", "mobile", "custom" ], "enumTitles": [ "Desktop 1366×768", "Desktop HD 1920×1080", "Laptop 1280×800", "Tablet 820×1180 @2x", "Mobile 390×844 @3x (iPhone-like)", "Custom (see Custom viewport)" ] }, "default": [ "desktop" ] }, "customViewport": { "title": "Custom viewport", "type": "object", "description": "Used when devices contains \"custom\": {\"width\":1440,\"height\":900,\"deviceScaleFactor\":1,\"isMobile\":false}" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page (capped by maxFullPageHeight).", "default": true }, "selector": { "title": "Element selector", "type": "string", "description": "Capture only this CSS selector (e.g. #pricing). Overrides full page." }, "format": { "title": "Format", "enum": [ "png", "jpeg" ], "type": "string", "description": "PNG is lossless (required for change detection). JPEG is smaller.", "default": "png" }, "quality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Only used for JPEG.", "default": 80 }, "dismissCookieBanners": { "title": "Dismiss cookie banners", "type": "boolean", "description": "Clicks 'Accept' on OneTrust, Cookiebot, Didomi, Quantcast, TrustArc, Usercentrics, Osano and generic banners (incl. iframes).", "default": true }, "hideSelectors": { "title": "Hide selectors", "type": "array", "description": "CSS selectors to hide before capture (chat widgets, popups).", "default": [], "items": { "type": "string" } }, "hideFloatingElements": { "title": "Fix sticky headers & floating bars", "type": "boolean", "description": "Full-page only: keeps top bars at the top once and hides floating overlays (chat bubbles, promo bars) that otherwise repeat or cover content.", "default": true }, "blockAds": { "title": "Block ads & trackers", "type": "boolean", "description": "Blocks common ad, analytics and tracker requests so pages load faster and look cleaner.", "default": true }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Emulate prefers-color-scheme: dark.", "default": false }, "scrollToBottom": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scrolls the page before a full-page capture so lazy-loaded images appear.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Navigation event to wait for. Use networkidle for single-page apps.", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Extra wait before capturing, in milliseconds (animations, fonts).", "default": 500 }, "savePdf": { "title": "Also save PDF (desktop devices)", "type": "boolean", "description": "Billed as a separate 'pdf' event.", "default": false }, "changeDetection": { "title": "Visual change detection", "type": "boolean", "description": "Compares each screenshot with the previous run's (same URL+device) and reports diffPercent, changed and a diff image. Billed as 'visual-diff' when a baseline exists.", "default": false }, "changeStoreName": { "title": "Baseline store name", "type": "string", "description": "Named key-value store that keeps the previous screenshots. Use different names to keep separate monitors.", "default": "screenshot-pro-baselines" }, "changeThresholdPercent": { "title": "Changed if diff ≥ (%)", "type": "string", "description": "Percent of pixels.", "default": "0.5" }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skips URLs disallowed for this bot / * (skipped URLs are not billed).", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages captured in parallel. 4 fits the default 2 GB memory.", "default": 4 }, "navigationTimeoutSecs": { "title": "Navigation timeout (s)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Page load timeout. Failed pages are not charged.", "default": 45 }, "maxFullPageHeight": { "title": "Max full-page height (px)", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "Very long pages are cut at this height (CSS pixels).", "default": 16000 }, "maxScreenshots": { "title": "Max screenshots per run", "minimum": 1, "type": "integer", "description": "Hard cap on screenshots in one run (URLs × devices).", "default": 1000 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional proxy, e.g. Apify Proxy for geo-specific pages." } } }, "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 } } } } } } } } } }