{ "openapi": "3.0.1", "info": { "title": "Website Screenshot", "description": "Website screenshot API: bulk full-page or viewport screenshots of any URL as PNG/JPEG, or URL to PDF. Desktop, tablet, mobile; cookie banners removed, lazy images loaded. $2.50 per 1,000 screenshots; failed pages are free.", "version": "1.0", "x-build-id": "PpzuL3EKGUOlFOVg3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jcwilk~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jcwilk-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/jcwilk~website-screenshot/runs": { "post": { "operationId": "runs-sync-jcwilk-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/jcwilk~website-screenshot/run-sync": { "post": { "operationId": "run-sync-jcwilk-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": "Web pages to capture (full http:// or https:// URLs).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile", "android", "custom" ], "type": "string", "description": "Viewport preset. desktop 1920×1080, laptop 1366×768, tablet (iPad 820×1180 @2x), mobile (iPhone 390×844 @3x), android (Pixel 412×915), or custom (set width/height).", "default": "desktop" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page. Off = only the visible viewport.", "default": true }, "formats": { "title": "Output formats", "type": "array", "description": "One or more of png, jpeg, pdf. Each format is a separate charged event.", "items": { "type": "string", "enum": [ "png", "jpeg", "pdf" ], "enumTitles": [ "PNG", "JPEG", "PDF (URL to PDF)" ] }, "default": [ "png" ] }, "dismissCookieBanners": { "title": "Hide cookie banners & popups", "type": "boolean", "description": "Auto-accept or hide cookie/consent banners (OneTrust, Cookiebot, Didomi, Usercentrics, Quantcast and generic ones).", "default": true }, "scrollToBottom": { "title": "Load lazy images", "type": "boolean", "description": "Scroll through the page before capturing so lazy-loaded images and sections render.", "default": true }, "delayMs": { "title": "Extra wait (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait this long after the page loads, e.g. for animations.", "default": 1000 }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Navigation event to wait for. networkidle is slower but safer for single-page apps.", "default": "load" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Optional CSS selector that must appear before capturing." }, "selector": { "title": "Element selector", "type": "string", "description": "Optional CSS selector: capture only this element instead of the page." }, "hideSelectors": { "title": "Hide elements", "type": "array", "description": "CSS selectors to hide before capturing (chat widgets, ads, sticky headers).", "items": { "type": "string" } }, "width": { "title": "Custom width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Viewport width; used with device=custom or to override a preset." }, "height": { "title": "Custom height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Viewport height; used with device=custom or to override a preset." }, "deviceScaleFactor": { "title": "Device scale factor", "minimum": 0.5, "maximum": 4, "type": "number", "description": "Pixel density (1 = normal, 2 = retina). Defaults to the preset value." }, "blockTrackers": { "title": "Block trackers, ads & video", "type": "boolean", "description": "Block analytics, ad and chat-widget scripts and video downloads. Faster and cleaner screenshots.", "default": true }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Emulate prefers-color-scheme: dark.", "default": false }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1–100, JPEG only.", "default": 80 }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3", "Tabloid" ], "type": "string", "description": "Paper size for PDF output.", "default": "A4" }, "maxFullPageHeight": { "title": "Max full-page height (px)", "minimum": 500, "maximum": 32000, "type": "integer", "description": "Very long pages are cut at this height.", "default": 16384 }, "timeoutSecs": { "title": "Page timeout (s)", "minimum": 5, "maximum": 300, "type": "integer", "description": "Navigation timeout per page. On timeout, whatever has loaded is captured.", "default": 45 }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Retries per page after a browser error.", "default": 1 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 16, "type": "integer", "description": "Max pages in parallel. Automatically capped at 1 page per GB of run memory.", "default": 4 }, "userAgent": { "title": "User agent", "type": "string", "description": "Optional custom User-Agent string." }, "includeHtml": { "title": "Include HTML", "type": "boolean", "description": "Also return the rendered HTML in the dataset item.", "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 } } } } } } } } } }