{ "openapi": "3.0.1", "info": { "title": "Website Screenshot Generator — Full Page, Pay Only If Usable", "description": "Blank, blocked, bot-checked and 404 pages are reported with the reason and never charged — you pay only for images you can use. Full-page captures that reach the bottom: lazy content loaded, cookie banners removed, sticky headers stopped from repeating. Batch many URLs per run.", "version": "0.1", "x-build-id": "kduUs5eUgsrhD1abW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wheaten_steelpan~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wheaten_steelpan-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/wheaten_steelpan~website-screenshot/runs": { "post": { "operationId": "runs-sync-wheaten_steelpan-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/wheaten_steelpan~website-screenshot/run-sync": { "post": { "operationId": "run-sync-wheaten_steelpan-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": "URLs to capture", "type": "array", "description": "One URL per line. http:// or https:// only. A URL that cannot be read becomes its own row and does not stop the rest of the batch.", "default": [], "items": { "type": "string" } }, "fullPage": { "title": "Capture the whole page", "type": "boolean", "description": "On: the entire page, top to bottom, with lazy content loaded first. Off: just the visible area, exactly as a visitor sees it above the fold.", "default": true }, "format": { "title": "Image format", "enum": [ "png", "jpeg", "webp" ], "type": "string", "description": "PNG is lossless and the safest default. JPEG and WebP are much smaller on long pages.", "default": "png" }, "blockConsent": { "title": "Remove cookie and consent banners", "type": "boolean", "description": "Removes the banner rather than clicking it, so nothing consents to tracking on your behalf, and it works in any language. If a site refuses to render anything until consent is given, you get the reason and are not charged.", "default": true }, "lazyLoad": { "title": "Load lazy content before capturing", "type": "boolean", "description": "Scrolls the page to trigger images and sections that only load when they come into view, waits for them to settle, then scrolls back to the top. Full-page captures only.", "default": true }, "hideStickyElements": { "title": "Stop sticky headers repeating", "type": "boolean", "description": "Pins a fixed header at the top so it appears once instead of riding down the image, and hides floating chat bubbles, back-to-top buttons and sticky footers. Full-page captures only — on a viewport capture these are what a visitor actually sees, so they are left alone.", "default": true }, "blockAds": { "title": "Block ad networks", "type": "boolean", "description": "Off by default. A cookie banner is an artefact of our visit, so removing it makes the image more faithful; an ad is part of the page as published. Turn this on for a cleaner marketing shot.", "default": false }, "width": { "title": "Viewport width", "minimum": 1, "maximum": 4096, "type": "integer", "description": "Browser width in pixels. 1280 is a typical desktop; 390 gives a mobile-width layout.", "default": 1280 }, "height": { "title": "Viewport height", "minimum": 1, "maximum": 4096, "type": "integer", "description": "Browser height in pixels. On a full-page capture this only sets the window; the image is as tall as the page.", "default": 800 }, "deviceScaleFactor": { "title": "Pixel density", "minimum": 1, "maximum": 3, "type": "integer", "description": "1 is normal. 2 produces a retina-resolution image at roughly four times the file size.", "default": 1 }, "quality": { "title": "JPEG / WebP quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1 to 100. Ignored for PNG, which has no lossy quality setting.", "default": 80 }, "maxFullPageHeight": { "title": "Maximum page height", "minimum": 800, "maximum": 30000, "type": "integer", "description": "Pages taller than this are clipped to it and the row is marked as clipped — never silently truncated. Browsers cannot reliably capture beyond about 16,000 pixels.", "default": 12000 }, "omitBackground": { "title": "Transparent background", "type": "boolean", "description": "Leaves the page background transparent where the site does not paint one. PNG and WebP only.", "default": false }, "selector": { "title": "Capture one element (CSS selector)", "type": "string", "description": "Capture just this element, for example \"main\" or \"#pricing\". The run fails for that URL, without charge, if the selector is not on the page.", "default": "" }, "clip": { "title": "Capture a fixed region", "type": "object", "description": "A region in page coordinates, for example {\"x\":0,\"y\":0,\"width\":1200,\"height\":630} for a social preview. Works below the fold too.", "default": {} }, "waitUntil": { "title": "Wait for", "enum": [ "load", "domcontentloaded", "networkidle", "commit" ], "type": "string", "description": "When to consider the page loaded. \"load\" suits almost everything. \"networkidle\" waits for traffic to stop, which is slower but better for heavy apps.", "default": "load" }, "waitForSelector": { "title": "Wait for an element to appear", "type": "string", "description": "A CSS selector to wait for before capturing, for example \".product-grid\". Leave blank to skip.", "default": "" }, "delayMs": { "title": "Extra wait (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "A fixed pause after loading, before capturing. Useful for an animation that has to finish.", "default": 0 }, "timeoutMs": { "title": "Time limit per URL (ms)", "minimum": 1000, "maximum": 120000, "type": "integer", "description": "A URL that takes longer than this is abandoned, reported as a timeout, and not charged. 60 seconds suits Apify's data centre, where ad-heavy pages reach load more slowly than they do on a home connection.", "default": 60000 }, "ignoreHTTPSErrors": { "title": "Ignore certificate errors", "type": "boolean", "description": "Captures sites with an expired or self-signed certificate, which otherwise fail to load.", "default": false }, "concurrency": { "title": "URLs at a time", "minimum": 1, "maximum": 10, "type": "integer", "description": "2 is sized for the default 2 GB of memory and measured to fit it. Raise it only if you also raise the actor's memory — 3 needs more than 2 GB.", "default": 2 }, "runBudgetMs": { "title": "Run budget (ms)", "minimum": 5000, "maximum": 3600000, "type": "integer", "description": "The whole run stops starting new URLs once this is spent, rather than overrunning. Anything not started is reported and not charged.", "default": 240000 }, "maxRetries": { "title": "Retries per URL", "minimum": 0, "maximum": 3, "type": "integer", "description": "Retries a timeout or a dropped connection. A domain that does not exist is never retried, because that only burns the run budget.", "default": 1 }, "colorScheme": { "title": "Colour scheme", "enum": [ "light", "dark", "no-preference" ], "type": "string", "description": "Which theme the site is asked to render in, for sites that offer both.", "default": "light" }, "locale": { "title": "Locale", "type": "string", "description": "Browser language, for example en-US or de-DE. Affects which language a multilingual site serves.", "default": "en-US" }, "timezoneId": { "title": "Time zone", "type": "string", "description": "IANA time zone, for example Europe/Berlin. Leave blank for the server's own.", "default": "" }, "userAgent": { "title": "User agent", "type": "string", "description": "Override the browser's user agent string. Leave blank for the default.", "default": "" }, "prepareTimeoutMs": { "title": "Page preparation budget (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "How long consent removal, lazy-load scrolling and sticky handling may take before the capture goes ahead with whatever is ready. Lowering it speeds up heavy pages.", "default": 10000 } } }, "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 } } }, "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 } } } } } } } } } }