{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API: Full Page, PDF, Mobile, No Banners", "description": "Website Screenshot API: capture full-page or element screenshots (PNG, JPEG, WebP) and PDFs of any public URL. Desktop, tablet, mobile and OG-image sizes, dark mode, cookie-banner hiding, ad blocking. $0.004 per screenshot, $0.006 per PDF; failures are free.", "version": "0.1", "x-build-id": "QzFzfayfp31nk3vx3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ucchiii~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ucchiii-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/ucchiii~website-screenshot/runs": { "post": { "operationId": "runs-sync-ucchiii-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/ucchiii~website-screenshot/run-sync": { "post": { "operationId": "run-sync-ucchiii-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": "Public http(s) URLs to capture, up to 100 per run. Leave empty for a free demo (example.com, not charged). Social networks and login-wall sites (Facebook, Instagram, X/Twitter, TikTok, LinkedIn, Threads) and internal addresses are refused.", "items": { "type": "string" } }, "format": { "title": "Format", "enum": [ "png", "jpeg", "webp", "pdf" ], "type": "string", "description": "Output file type: 'png' (default), 'jpeg', 'webp' or 'pdf'. PDF is billed as the PDF event, the others as a screenshot.", "default": "png" }, "quality": { "title": "Quality (JPEG/WebP)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Compression quality for JPEG and WebP, 1 to 100 (default 80). Ignored for PNG and PDF.", "default": 80 }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile", "og", "custom" ], "type": "string", "description": "Viewport preset: 'desktop' 1440x900 (default), 'laptop' 1366x768, 'tablet' 768x1024, 'mobile' 390x844 with mobile user agent, 'og' 1200x630 (Open Graph image), or 'custom' to use the width, height and deviceScaleFactor below.", "default": "desktop" }, "width": { "title": "Custom width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Viewport width, 200 to 3840. Used only when Device is Custom.", "default": 1440 }, "height": { "title": "Custom height (px)", "minimum": 200, "maximum": 4000, "type": "integer", "description": "Viewport height, 200 to 4000. Used only when Device is Custom.", "default": 900 }, "deviceScaleFactor": { "title": "Custom device scale factor", "minimum": 1, "maximum": 4, "type": "integer", "description": "Pixel density, 1 to 4 (2 = retina). Used only when Device is Custom.", "default": 1 }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the page for its dark color scheme (prefers-color-scheme: dark). Only sites that support it change.", "default": false }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of only the first screen. Height is capped at 20,000 px.", "default": false }, "selector": { "title": "CSS selector (element only)", "type": "string", "description": "Optional. Capture only the first element matching this CSS selector, for example #pricing or main article. If nothing matches, the row gets error selector_not_found (not charged)." }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded: 'load' (default), 'domcontentloaded' (fastest) or 'networkidle' (slowest, for late content). Each page has a 45 second limit.", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Wait this long after loading before capturing, 0 to 10000 ms. Useful for animations.", "default": 0 }, "scrollToLazyLoad": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scroll down the page before capturing so lazy-loaded images appear. Recommended together with Full page.", "default": false }, "blockAds": { "title": "Block ads and trackers", "type": "boolean", "description": "Block requests to a small built-in list of common ad and tracking domains. Not a complete filter.", "default": false }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common consent pop-ups (OneTrust, Cookiebot, Didomi, Quantcast, TrustArc, Usercentrics, CookieYes, Osano and generic cookie banners) with CSS. Nothing is clicked or accepted.", "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 } } } } } } } } } }