{ "openapi": "3.0.1", "info": { "title": "Website Screenshot Generator: Full Page, Mobile & Bulk URLs", "description": "Take full-page or viewport screenshots of any list of URLs with a real Chrome browser: desktop, laptop, tablet and phone sizes, PNG or JPEG, cookie banners hidden, lazy images loaded, single-element capture, dark mode. Returns image links + status + title. $3 per 1,000 screenshots.", "version": "0.1", "x-build-id": "kxnaBY5iCOVbPSjDF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/larkmoor~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-larkmoor-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/larkmoor~website-screenshot/runs": { "post": { "operationId": "runs-sync-larkmoor-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/larkmoor~website-screenshot/run-sync": { "post": { "operationId": "run-sync-larkmoor-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": "Pages to screenshot. A bare domain (example.com) becomes https://example.com.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "devices": { "title": "Devices", "type": "array", "description": "One screenshot per URL per device.", "items": { "type": "string", "enum": [ "desktop", "desktop-hd", "laptop", "tablet", "phone", "custom" ], "enumTitles": [ "Desktop 1366×768", "Desktop HD 1920×1080", "Laptop 1280×800", "Tablet 820×1180 (2x)", "Phone 390×844 (2x, iPhone UA)", "Custom width/height" ] }, "default": [ "desktop" ] }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of only the first screen.", "default": true }, "format": { "title": "Image format", "enum": [ "png", "jpeg" ], "type": "string", "description": "PNG for crisp text, JPEG for small files.", "default": "png" }, "quality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1–100, JPEG only.", "default": 80 }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common cookie/consent pop-ups (OneTrust, Cookiebot, Didomi, Quantcast, Usercentrics and more).", "default": true }, "hideSelectors": { "title": "Hide elements (CSS selectors)", "type": "array", "description": "Extra elements to hide before the screenshot, e.g. '.newsletter-popup', '#chat-widget'.", "items": { "type": "string" } }, "selector": { "title": "Element only (CSS selector)", "type": "string", "description": "Screenshot just this element (e.g. 'header', '#pricing') instead of the page." }, "scrollToLoad": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scroll down the page first so lazy-loaded images appear in full-page shots.", "default": true }, "maxHeight": { "title": "Max page height (px)", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Full-page shots are cut at this height (CSS pixels) so endless pages and huge images don't fail. 0 = no limit.", "default": 10000 }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded. 'networkidle' waits for all requests to settle (slower, best for heavy apps).", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait this long after loading, e.g. for animations.", "default": 0 }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the page for its dark color scheme.", "default": false }, "retina": { "title": "Retina (2x) on desktop", "type": "boolean", "description": "Desktop shots at 2x pixel density (phones and tablets are always high-density).", "default": false }, "width": { "title": "Custom width", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Viewport width for the 'custom' device.", "default": 1366 }, "height": { "title": "Custom height", "minimum": 200, "maximum": 4000, "type": "integer", "description": "Viewport height for the 'custom' device.", "default": 768 }, "timeoutSecs": { "title": "Page timeout (s)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Give up on a page after this many seconds (one retry with a lighter wait).", "default": 45 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 8, "type": "integer", "description": "Pages loaded at the same time (1–8). Raise memory if you raise this.", "default": 2 }, "maxResults": { "title": "Max screenshots", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Upper limit for the run. Failed pages are listed with the error and not charged.", "default": 1000 } } }, "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 } } } } } } } } } }