{ "openapi": "3.0.1", "info": { "title": "Website Screenshot - Full Page, Mobile & Batch", "description": "Full-page or viewport screenshots of any list of URLs, as PNG or JPEG, on desktop, mobile or tablet. Hides cookie banners and loads lazy images. Pay only for successful screenshots.", "version": "0.0", "x-build-id": "qcdgMfnybBclk2uzc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sturdyscrape~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sturdyscrape-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/sturdyscrape~website-screenshot/runs": { "post": { "operationId": "runs-sync-sturdyscrape-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/sturdyscrape~website-screenshot/run-sync": { "post": { "operationId": "run-sync-sturdyscrape-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", "required": [ "urls" ], "properties": { "urls": { "title": "URLs", "type": "array", "description": "Pages to screenshot. One screenshot per URL. Only http:// and https:// URLs are accepted.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of only the visible viewport.", "default": true }, "device": { "title": "Device", "enum": [ "desktop", "mobile", "tablet" ], "type": "string", "description": "Desktop uses the viewport size below. Mobile emulates an iPhone 13 and tablet an iPad (7th gen), including user agent and pixel ratio.", "default": "desktop" }, "viewportWidth": { "title": "Viewport width (px)", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Browser window width for the desktop device.", "default": 1280 }, "viewportHeight": { "title": "Viewport height (px)", "minimum": 240, "maximum": 2160, "type": "integer", "description": "Browser window height for the desktop device. With Full page on, it only affects how the page lays out.", "default": 800 }, "format": { "title": "Image format", "enum": [ "png", "jpeg" ], "type": "string", "description": "PNG is lossless; JPEG files are much smaller.", "default": "png" }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "From 1 to 100. Used only when the format is JPEG.", "default": 80 }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide the consent banners of common cookie frameworks (OneTrust, Cookiebot, Didomi, Usercentrics and others) with CSS. Nothing is clicked or accepted.", "default": true }, "hideSelectors": { "title": "Extra CSS selectors to hide", "type": "array", "description": "Any other elements to hide before the screenshot, such as chat widgets or popups.", "default": [], "items": { "type": "string" } }, "scrollToBottom": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Before a full-page screenshot, scroll through the page so lazy-loaded images appear.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "How long to wait for the page before the capture. The DOM is always awaited; 'Page load' and 'Network idle' get up to 30 extra seconds, and pages that never finish loading (common on ad-heavy sites) are captured as they are instead of failing.", "default": "load" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Optional CSS selector that must appear before the screenshot is taken." }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Extra time to wait right before the screenshot, for animations.", "default": 0 }, "timeoutSecs": { "title": "Page timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Maximum time to load each page. Pages that take longer are reported as failed and are not charged.", "default": 60 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages to screenshot in parallel.", "default": 2 } } }, "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 } } } } } } } } } }