{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API — Full-Page, Mobile & PDF Captures", "description": "Take full-page website screenshots in bulk with real Chrome: desktop, laptop, tablet and mobile in one run, PNG/JPEG/PDF, element screenshots, dark mode, auto-hidden cookie banners and lazy-load scrolling. Public image URLs, pay per screenshot.", "version": "1.0", "x-build-id": "Akx548oROtGtmQLnS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reverend_sal~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reverend_sal-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/reverend_sal~website-screenshot/runs": { "post": { "operationId": "runs-sync-reverend_sal-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/reverend_sal~website-screenshot/run-sync": { "post": { "operationId": "run-sync-reverend_sal-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": "Website URLs", "type": "array", "description": "Pages to capture. Each URL is screenshotted once per selected device.", "default": [ { "url": "https://apify.com" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "devices": { "title": "Devices", "type": "array", "description": "Capture each URL on these devices (each device is a separate screenshot). Desktop 1920×1080, laptop 1366×768, tablet 820×1180 (iPad, 2× pixels), mobile 390×844 (iPhone, 2× pixels).", "items": { "type": "string", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "enumTitles": [ "Desktop (1920×1080)", "Laptop (1366×768)", "Tablet (iPad)", "Mobile (iPhone)" ] }, "default": [ "desktop" ] }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page, not just the visible viewport.", "default": true }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG (lossless), JPEG (smaller files) or PDF (printable A4 document of the page).", "default": "png" }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1–100. Only used for JPEG.", "default": 80 }, "selector": { "title": "Element selector", "type": "string", "description": "Optional CSS selector: capture only this element (e.g. `#pricing`, `.hero`). The first match is used.", "default": "" }, "viewportWidth": { "title": "Custom viewport width (px)", "minimum": 0, "maximum": 3840, "type": "integer", "description": "Override the device width. 0 = device default.", "default": 0 }, "viewportHeight": { "title": "Custom viewport height (px)", "minimum": 0, "maximum": 2160, "type": "integer", "description": "Override the device height. 0 = device default.", "default": 0 }, "deviceScaleFactor": { "title": "Pixel density (device scale factor)", "minimum": 0, "maximum": 3, "type": "integer", "description": "1 = normal, 2 = retina, 3 = high-DPI phones. 0 = device default.", "default": 0 }, "maxHeight": { "title": "Max page height (px)", "minimum": 500, "maximum": 20000, "type": "integer", "description": "Very long pages are cut at this height (CSS pixels) to keep images usable.", "default": 10000 }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Emulate prefers-color-scheme: dark.", "default": false }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common consent pop-ups (OneTrust, Cookiebot, Quantcast, Didomi, Usercentrics and more).", "default": true }, "hideSelectors": { "title": "Hide elements", "type": "array", "description": "CSS selectors to hide before capturing (chat widgets, popups, ads), e.g. `#intercom-container`.", "default": [], "items": { "type": "string" } }, "scrollPage": { "title": "Scroll to load lazy content", "type": "boolean", "description": "Scroll through 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": "When navigation counts as finished.", "default": "load" }, "waitForSelector": { "title": "Wait for element", "type": "string", "description": "Optional CSS selector to wait for before capturing (e.g. a chart that renders late).", "default": "" }, "delaySecs": { "title": "Extra delay (seconds)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Wait this long after loading, before capturing.", "default": 1 }, "timeoutSecs": { "title": "Page timeout (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Give up on a page after this long.", "default": 60 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "Screenshots taken at the same time. More needs more memory (about 500 MB per page).", "default": 3 } } }, "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 } } } } } } } } } }