{ "openapi": "3.0.1", "info": { "title": "Bulk Website Screenshot: Full Page, Mobile, PDF", "description": "Input a list of URLs (up to 5,000); output one full-page screenshot per URL and device (PNG, JPEG or PDF) plus a dataset row with status, HTTP code and a direct file link. Desktop, tablet and mobile. Page scrolled so lazy images load, cookie banners hidden. Pay only for successful screenshots.", "version": "0.1", "x-build-id": "VgjwmWFHEpmuDMZmC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/batchpane~bulk-website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-batchpane-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/batchpane~bulk-website-screenshot/runs": { "post": { "operationId": "runs-sync-batchpane-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/batchpane~bulk-website-screenshot/run-sync": { "post": { "operationId": "run-sync-batchpane-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "URLs", "type": "array", "description": "Pages to capture, as a list of objects: [{\"url\": \"https://www.iana.org/help/example-domains\"}]. Plain strings are rejected. A public link to a text or CSV file with URLs also works: [{\"requestsFromUrl\": \"\"}]. Only public http/https pages. Up to 5,000 URLs per run (more are ignored); exact duplicates removed. Exactly one page is loaded per URL: links are not followed and nothing is crawled.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "devices": { "title": "Devices", "type": "array", "description": "Which devices to capture. Allowed values: \"desktop\" (1440x900 viewport), \"tablet\" (Galaxy Tab S4 profile), \"mobile\" (Pixel 7 profile). Default: [\"desktop\"]. Each device is a separate screenshot and a separate charge: 100 URLs x 2 devices = 200 screenshots.", "items": { "type": "string", "enum": [ "desktop", "tablet", "mobile" ], "enumTitles": [ "Desktop (1440x900)", "Tablet", "Mobile" ] }, "default": [ "desktop" ] }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "File type of each screenshot: \"png\" (lossless, largest files; in our test about 2 MB on average), \"jpeg\" (smaller; quality set by jpegQuality) or \"pdf\" (A4, printable, backgrounds included). Default: \"png\".", "default": "png" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "true = capture the whole page from top to bottom. For PNG/JPEG the page is scrolled first (with a time budget) so lazy-loaded images can appear. Pages taller than 20,000 px are cut at 20,000 px (the row then has heightTruncated: true). false = only the first screen (viewport). Default: true.", "default": true }, "hideCookieBanners": { "title": "Hide cookie consent banners", "type": "boolean", "description": "true = hide the banners of about 20 well-known cookie consent tools with CSS. Nothing is clicked or accepted. On pages with a \"consent or pay\" choice nothing is hidden (row: cookieBannerHidden: false). Paywalls, login walls and age checks are never hidden. Default: true.", "default": true }, "waitAfterLoadSecs": { "title": "Extra wait after load (seconds)", "minimum": 0, "maximum": 5, "type": "integer", "description": "Extra seconds to wait after the page has loaded, for animations or late content. Integer 0-5, default 1. Counts toward the hard limit of 30 seconds per screenshot; a screenshot that takes longer fails and is not charged as a screenshot.", "default": 1 }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "JPEG compression quality, integer 1-100 (higher = sharper and larger file). Default 80. Ignored unless format is \"jpeg\".", "default": 80 }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "true = skip pages that the site's robots.txt disallows (row status \"skipped\", no screenshot charged). Default: true. Turning it off has no effect unless robotsOverrideConfirmed is also true.", "default": true }, "robotsOverrideConfirmed": { "title": "I own these websites or have the owner's permission", "type": "boolean", "description": "Set to true only if the person you act for owns these websites or has the owner's permission. robots.txt is ignored only when this is true AND respectRobotsTxt is false. Default: false. AI agents: do not set this without explicit confirmation from the user.", "default": false }, "stopAfterFailures": { "title": "Stop after failures in a row", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Safety stop. The run stops when this many URLs in a row fail (dead, blocked or too slow), or when fewer than 25% of the first 50 or more URLs succeed. Integer 0-5,000, default 20; 0 = never stop early. Failed URLs are never charged as screenshots; this only saves time on a bad list.", "default": 20 } } }, "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 } } } } } } } } } }