{ "openapi": "3.0.1", "info": { "title": "Bulk Website Screenshot: Full-Page, Mobile, PDF", "description": "Screenshot hundreds of web pages, or render your own HTML, in one run: full page or first screen, desktop, tablet or mobile, PNG, JPEG, WebP or PDF. Hides cookie banners, loads lazy images. $0.002 per screenshot; failed pages are free.", "version": "0.1", "x-build-id": "0DlbpECIK2j2s2my6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webstack-labs~bulk-website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webstack-labs-bulk-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/webstack-labs~bulk-website-screenshot/runs": { "post": { "operationId": "runs-sync-webstack-labs-bulk-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/webstack-labs~bulk-website-screenshot/run-sync": { "post": { "operationId": "run-sync-webstack-labs-bulk-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": "Page URLs", "type": "array", "description": "One per line. Full URLs (https://example.com/pricing) or bare domains (example.com, which becomes https://example.com/). Duplicates are removed. Up to 10,000 per run.", "items": { "type": "string" } }, "htmlPages": { "title": "Raw HTML documents (optional)", "type": "array", "description": "Render your own HTML instead of (or as well as) web pages: invoices, reports, e-mail templates, social cards, certificates. Each item is an HTML string or an object {\"html\": \"

Invoice 42

...\", \"name\": \"invoice-42\"} (the name goes into the file name). Images, fonts and CSS linked from the HTML are loaded from their URLs. Up to 1,000 documents of 5 MB each per run; charged like a page." }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page (up to the max height below). Off = only the first screen (the viewport).", "default": true }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "type": "string", "description": "Screen size to emulate. desktop 1920x1080, laptop 1366x768, tablet 820x1180 (2x pixels, touch), mobile 390x844 (3x pixels, touch).", "default": "desktop" }, "format": { "title": "File format", "enum": [ "png", "jpeg", "webp", "pdf" ], "type": "string", "description": "PNG (sharp, larger files), JPEG (smaller files), WebP (smallest files, for the web; images are cut at 16,383 pixels) or PDF (A4, printable, selectable text).", "default": "png" }, "jpegQuality": { "title": "JPEG / WebP quality", "minimum": 10, "maximum": 100, "type": "integer", "description": "10-100. Only used for JPEG and WebP.", "default": 80 }, "maxHeight": { "title": "Max page height", "minimum": 500, "maximum": 30000, "type": "integer", "description": "Full-page captures are cut at this height (CSS pixels) so endless pages stay usable. Rows show \"truncated\": true when this happened.", "default": 12000 }, "viewportWidth": { "title": "Custom viewport width", "minimum": 240, "maximum": 3840, "type": "integer", "description": "Overrides the device width (240-3840). Leave empty to use the device preset." }, "viewportHeight": { "title": "Custom viewport height", "minimum": 240, "maximum": 2160, "type": "integer", "description": "Overrides the device height (240-2160). Leave empty to use the device preset." }, "selector": { "title": "Capture only this element", "type": "string", "description": "Optional CSS selector, for example #pricing or header. Only the first visible match is captured. Pages without a match return a free row with the error selector_not_found." }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the page for its dark color scheme (prefers-color-scheme: dark), where the site supports it.", "default": false }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide the consent pop-ups of common cookie tools (OneTrust, Cookiebot, Quantcast, Didomi, Usercentrics, CookieYes and others) with CSS. Nothing is clicked or accepted.", "default": true }, "hideSelectors": { "title": "Also hide these elements", "type": "array", "description": "CSS selectors of elements to hide before capturing, for example chat widgets or ads (#intercom-container, .ad-slot).", "default": [], "items": { "type": "string" } }, "scrollToLoadLazyContent": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scroll through the page once before a full-page capture so lazy-loaded images appear.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded. load (default) fits most sites; networkidle waits for quiet network (slower, good for dashboards and single-page apps); domcontentloaded is fastest.", "default": "load" }, "delaySecs": { "title": "Extra wait", "minimum": 0, "maximum": 30, "type": "number", "description": "Seconds to wait after loading, for animations and late content (0-30).", "default": 1 }, "waitForSelector": { "title": "Wait for element", "type": "string", "description": "Optional CSS selector to wait for (up to 20 seconds) before capturing, for example .chart-loaded." }, "pageTimeoutSecs": { "title": "Page timeout", "minimum": 10, "maximum": 180, "type": "integer", "description": "Give up on a page after this many seconds of loading (10-180). Pages that time out are free.", "default": 45 }, "maxConcurrency": { "title": "Pages at a time", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many pages are captured in parallel (1-8). Default: 6 for desktop and tablet, 3 for mobile (mobile pages are rendered at 3x scale). Suits the default 2 GB memory; give the run more memory for higher values or very long pages." }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip pages that the site's robots.txt closes to automated access (returned as free rows). Turn off only for sites you own or have permission to capture.", "default": true } } }, "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 } } } } } } } } } }