{ "openapi": "3.0.1", "info": { "title": "Website Screenshot: Full Page, Mobile & PDF, No Cookie Banners", "description": "Bulk website screenshots as PNG, JPEG or PDF: full page, desktop/tablet/mobile devices, dark mode, element capture, with cookie banners hidden and ads blocked. Public image links in the output.", "version": "1.0", "x-build-id": "eiCx7uG3kkBAJT6He" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ksvan~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ksvan-website-screenshot", "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/ksvan~website-screenshot/runs": { "post": { "operationId": "runs-sync-ksvan-website-screenshot", "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/ksvan~website-screenshot/run-sync": { "post": { "operationId": "run-sync-ksvan-website-screenshot", "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": "URLs", "type": "array", "description": "Pages to capture.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "Image or PDF.", "default": "png" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page, not just the visible screen.", "default": true }, "maxHeight": { "title": "Max height (px)", "minimum": 0, "maximum": 16000, "type": "integer", "description": "Cut very long full-page captures at this height in CSS pixels. 0 = automatic (as tall as the browser can encode: about 16,000 device pixels, e.g. 5,333 px on mobile @3x). The output field `truncated` tells you when a page was cut.", "default": 0 }, "devices": { "title": "Devices", "type": "array", "description": "One screenshot per URL per device.", "items": { "type": "string", "enum": [ "desktop", "desktop_hd", "laptop_retina", "tablet", "mobile" ], "enumTitles": [ "Desktop 1366x768", "Desktop HD 1920x1080", "Laptop Retina 1440x900 @2x", "Tablet 820x1180 @2x", "Mobile 390x844 @3x" ] }, "default": [ "desktop" ] }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hides OneTrust, Cookiebot, Didomi, Quantcast, Usercentrics and other common consent pop-ups.", "default": true }, "blockAds": { "title": "Block ads and trackers", "type": "boolean", "description": "Blocks requests to major ad networks (Google Ads, Amazon, Criteo, Taboola, Outbrain...).", "default": true }, "hideSelectors": { "title": "CSS selectors to hide", "type": "array", "description": "Extra elements to hide, e.g. chat widgets: #intercom-container", "items": { "type": "string" } }, "elementSelector": { "title": "Capture one element", "type": "string", "description": "CSS selector; when set, only this element is captured." }, "colorScheme": { "title": "Color scheme", "enum": [ "light", "dark", "no-preference" ], "type": "string", "description": "Emulate light or dark mode.", "default": "light" }, "viewportWidth": { "title": "Custom viewport width", "minimum": 0, "type": "integer", "description": "Overrides the device width (pixels). 0 = device default.", "default": 0 }, "viewportHeight": { "title": "Custom viewport height", "minimum": 0, "type": "integer", "description": "Overrides the device height (pixels). 0 = device default.", "default": 0 }, "quality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1-100, JPEG only.", "default": 80 }, "locale": { "title": "Browser locale", "type": "string", "description": "e.g. en-US, de-DE. Empty = default." }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Page load event to wait for.", "default": "load" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Wait until this CSS selector appears before capturing." }, "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 }, "delaySecs": { "title": "Extra delay (seconds)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Wait this long before capturing.", "default": 1 }, "timeoutSecs": { "title": "Page timeout (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Maximum time to load one page.", "default": 45 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages captured in parallel.", "default": 4 }, "maxRetries": { "title": "Retries per page", "minimum": 0, "maximum": 5, "type": "integer", "description": "Extra attempts for a failed page, each on a new proxy IP.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy for page loads.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }