{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API: Bulk Full Page PNG and JPEG", "description": "Take full page screenshots of a list of URLs in one run. PNG or JPEG, desktop, laptop, tablet or mobile, dark mode, cookie banners hidden, lazy images loaded. Each screenshot gets a download link, status code and page title. Pay per screenshot.", "version": "1.0", "x-build-id": "4o1wUOUGAegj543rn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pistachio_implementation~website-screenshot-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pistachio_implementation-website-screenshot-api", "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/pistachio_implementation~website-screenshot-api/runs": { "post": { "operationId": "runs-sync-pistachio_implementation-website-screenshot-api", "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/pistachio_implementation~website-screenshot-api/run-sync": { "post": { "operationId": "run-sync-pistachio_implementation-website-screenshot-api", "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": "One page per line, for example https://apify.com. A missing https:// is added.", "items": { "type": "string" } }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "type": "string", "description": "Screen size preset. Desktop 1280 by 800, laptop 1440 by 900, tablet 820 by 1180 (2x), mobile 390 by 844 (3x, iPhone user agent).", "default": "desktop" }, "viewportWidth": { "title": "Custom viewport width", "minimum": 0, "maximum": 3840, "type": "integer", "description": "Overrides the preset width in CSS pixels. 0 keeps the preset.", "default": 0 }, "viewportHeight": { "title": "Custom viewport height", "minimum": 0, "maximum": 2160, "type": "integer", "description": "Overrides the preset height in CSS pixels. 0 keeps the preset.", "default": 0 }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of only the first screen.", "default": true }, "maxPageHeight": { "title": "Maximum page height", "minimum": 500, "maximum": 30000, "type": "integer", "description": "Very long pages are cut at this height in CSS pixels, and the row is marked truncated.", "default": 10000 }, "format": { "title": "Image format", "enum": [ "png", "jpeg" ], "type": "string", "description": "PNG is lossless; JPEG files are much smaller.", "default": "png" }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Used only for JPEG, from 1 to 100.", "default": 80 }, "waitUntil": { "title": "Wait until", "enum": [ "domcontentloaded", "load", "networkidle" ], "type": "string", "description": "When the page counts as loaded. Once the page is ready, the actor waits up to 12 seconds for the load event (15 for network idle), then captures anyway. Network idle waits longest and suits heavy single page apps.", "default": "load" }, "delayMs": { "title": "Extra wait before capture (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Time for animations and late content after the page loads.", "default": 1000 }, "scrollToBottom": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scrolls through the page before a full page capture so lazy loaded images appear.", "default": true }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hides common consent popups (OneTrust, Cookiebot, Usercentrics, Didomi, Quantcast and others) without clicking anything.", "default": true }, "hideSelectors": { "title": "Also hide these elements", "type": "array", "description": "CSS selectors to hide before capture, for example .popup or #newsletter.", "default": [], "items": { "type": "string" } }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Asks the page for its dark color scheme, when it has one.", "default": false }, "timeoutSecs": { "title": "Page timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "A page that is not ready (DOM loaded) in this time is reported as failed and not charged. Timeouts are not retried; a page caught by a browser restart or a dropped connection is retried once.", "default": 30 }, "maxConcurrency": { "title": "Pages at once", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many pages are captured in parallel. More is faster but needs more memory; above 2, raise the run memory to 2 GB or more.", "default": 2 }, "maxUrls": { "title": "Maximum URLs", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Only the first N URLs are captured.", "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 } } } } } } } } } }