{ "openapi": "3.0.1", "info": { "title": "Website Screenshot — Full-Page, Mobile & PDF, No Cookie Banners", "description": "Capture full-page, viewport, element or fixed-height screenshots and PDFs of any website in bulk. Desktop, tablet & mobile, cookie banners hidden, lazy images loaded, stealth Chrome for blocked sites. Flat price per screenshot; failures are free.", "version": "0.1", "x-build-id": "0lgn7YhsU1A6oOKY6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/adorable_partial~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-adorable_partial-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/adorable_partial~website-screenshot/runs": { "post": { "operationId": "runs-sync-adorable_partial-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/adorable_partial~website-screenshot/run-sync": { "post": { "operationId": "run-sync-adorable_partial-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": "Page URLs", "type": "array", "description": "Pages to capture. 'https://' is added if missing. Hundreds per run are fine.", "items": { "type": "string" } }, "mode": { "title": "What to capture", "enum": [ "fullPage", "viewport", "fixedHeight", "element", "pdf" ], "type": "string", "description": "Full page captures everything down to 'Max height'. Fixed height lets you choose exactly how many pixels from the top.", "default": "fullPage" }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "type": "string", "description": "Screen size and type. Tablet and mobile get a mobile user agent and touch, so you see the real mobile layout.", "default": "desktop" }, "format": { "title": "Image format", "enum": [ "png", "jpeg", "webp" ], "type": "string", "description": "Ignored for PDF.", "default": "png" }, "hideCookieBanners": { "title": "Hide cookie banners and consent pop-ups", "type": "boolean", "description": "Hides consent dialogs of the common platforms (OneTrust, Cookiebot, Didomi, Quantcast, Sourcepoint, Usercentrics...) and generic cookie bars, and unlocks scrolling. Nothing is accepted on your behalf.", "default": true }, "blockAds": { "title": "Block ads and chat widgets", "type": "boolean", "description": "Blocks the main ad networks and chat bubbles for cleaner, faster pages.", "default": true }, "engine": { "title": "Browser engine", "enum": [ "auto", "fast", "stealth" ], "type": "string", "description": "Stealth mode uses undetected-chromedriver with real Google Chrome for sites that block automated browsers. CAPTCHAs are never solved: pages that still demand one are reported and not billed.", "default": "auto" }, "clipHeight": { "title": "Height for 'Fixed height' (px)", "minimum": 100, "maximum": 30000, "type": "integer", "description": "How many CSS pixels from the top to capture in Fixed height mode.", "default": 1080 }, "maxHeight": { "title": "Max height for full page (px)", "minimum": 500, "maximum": 60000, "type": "integer", "description": "Very long pages (infinite scroll) are cut at this height.", "default": 16000 }, "selector": { "title": "CSS selector (element mode)", "type": "string", "description": "For example '#pricing', '.product-card' or 'article'. The first match is captured." }, "hideSelectors": { "title": "Also hide these elements", "type": "array", "description": "CSS selectors to hide before capturing (headers, chat bubbles, promo bars...).", "items": { "type": "string" } }, "delaySeconds": { "title": "Extra wait (seconds)", "minimum": 0, "maximum": 60, "type": "integer", "description": "Wait after the page is loaded, for animations or slow widgets.", "default": 0 }, "scrollToLoad": { "title": "Scroll to load lazy content", "type": "boolean", "description": "Scroll through the page before a full-page capture so lazy images load.", "default": true }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the page for its dark theme (prefers-color-scheme: dark).", "default": false }, "viewportWidth": { "title": "Custom width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Overrides the device width." }, "viewportHeight": { "title": "Custom height (px)", "minimum": 200, "maximum": 2160, "type": "integer", "description": "Overrides the device height." }, "scaleFactor": { "title": "Pixel density (1-3)", "minimum": 1, "maximum": 3, "type": "integer", "description": "1 = normal, 2 = retina. Default depends on the device." }, "quality": { "title": "JPEG/WebP quality", "minimum": 30, "maximum": 100, "type": "integer", "description": "30-100.", "default": 85 }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter" ], "type": "string", "description": "For PDF mode.", "default": "A4" }, "locale": { "title": "Browser language", "type": "string", "description": "Language the browser reports, e.g. en-US, pt-BR, de-DE. Sites may show content in this language.", "default": "en-US" }, "timeoutSeconds": { "title": "Page timeout (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Maximum time to load one page.", "default": 45 }, "captureErrorPages": { "title": "Capture error pages too", "type": "boolean", "description": "By default pages answering 4xx/5xx or showing a bot check are reported as errors and not billed. Turn on to capture them anyway (billed).", "default": false }, "maxConcurrency": { "title": "Max parallel pages", "minimum": 1, "maximum": 16, "type": "integer", "description": "Upper limit of pages processed in parallel (also limited by memory: 2 per GB).", "default": 8 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Use Apify Proxy (e.g. residential or a specific country) for sites that block data-center IPs or show country-specific content." } } }, "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 } } } } } } } } } }