{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API: Full Page, No Cookie Banners", "description": "Full-page screenshots for a list of URLs, without cookie banners. Lazy images load, sticky headers show once, a height cap stops runaway pages, and a hard time limit per URL keeps runs from sticking. PNG, JPEG or WebP; desktop, tablet or mobile. Pay per screenshot, failed pages are free.", "version": "1.0", "x-build-id": "P3ZETsElZzqtenBQO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-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/accountable_eel~website-screenshot/runs": { "post": { "operationId": "runs-sync-accountable_eel-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/accountable_eel~website-screenshot/run-sync": { "post": { "operationId": "run-sync-accountable_eel-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": "Web pages to screenshot", "type": "array", "description": "One URL per line. \"example.com\" works too (https:// is added). You're charged only for a page that was captured — a page that fails to load, times out or answers with an HTTP error is free.", "items": { "type": "string" } }, "viewport": { "title": "Screen size", "enum": [ "desktop", "tablet", "mobile", "custom" ], "type": "string", "description": "Desktop is 1440x900, tablet 768x1024, mobile 390x844 (with a phone browser identity, so sites serve their mobile layout). Pick \"Custom\" to set your own width and height below.", "default": "desktop" }, "viewportWidth": { "title": "Custom width (px)", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Used only when Screen size is Custom. 320 to 3840.", "default": 1440 }, "viewportHeight": { "title": "Custom height (px)", "minimum": 320, "maximum": 2400, "type": "integer", "description": "Used only when Screen size is Custom. This is the window height; with Full page on, the image is as tall as the page. 320 to 2400.", "default": 900 }, "fullPage": { "title": "Full page", "type": "boolean", "description": "On: capture the whole page from top to bottom (up to the height limit below). Off: capture only what fits in the window.", "default": true }, "maxHeight": { "title": "Height limit (px)", "minimum": 500, "maximum": 16384, "type": "integer", "description": "A full-page capture stops at this height, so an endless feed can't produce a giant image. The row says when a page was cut (truncated). Browsers can't paint a single image taller than 16384 px, so that is the ceiling.", "default": 15000 }, "format": { "title": "Image format", "enum": [ "png", "jpeg", "webp" ], "type": "string", "description": "PNG is sharp and lossless. JPEG and WebP are 3 to 10 times smaller (WebP images can't be taller than 16383 px).", "default": "png" }, "quality": { "title": "JPEG / WebP quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1 to 100. Ignored for PNG.", "default": 80 }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hides consent pop-ups from OneTrust, Cookiebot, Didomi, Usercentrics, TrustArc, Quantcast, Sourcepoint and 20+ other consent tools, plus home-made cookie bars. It only hides them: nothing is clicked, so no consent is ever given for you.", "default": true }, "hideSelectors": { "title": "Also hide these elements (CSS selectors)", "type": "array", "description": "Optional. One CSS selector per line, e.g. \".newsletter-popup\" or \"#chat-widget\". Matching elements are hidden before the capture.", "items": { "type": "string" } }, "scrollToLoadLazy": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scrolls down the page before the capture so images and sections that load on scroll are in the screenshot, instead of grey boxes.", "default": true }, "delaySeconds": { "title": "Extra wait before capture (seconds)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Waits this long after the page has loaded, for animations or slow widgets. 0 to 30.", "default": 0 }, "perUrlTimeoutSecs": { "title": "Time limit per page (seconds)", "minimum": 10, "maximum": 300, "type": "integer", "description": "Hard stop for each page, so one slow site can't hold up the run. A page that doesn't finish loading in time comes back with whatever had rendered, free of charge. 10 to 300.", "default": 45 }, "maxConcurrency": { "title": "Pages at once", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many pages to capture in parallel. More is faster but needs more memory per run.", "default": 2 } } }, "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 } } } } } } } } } }