{ "openapi": "3.0.1", "info": { "title": "Website Screenshot Studio", "description": "Capture websites as PNG, JPEG, or PDF on desktop, tablet, and mobile. Automatically dismiss consent dialogs and popups, with bounded lazy loading, explicit errors, and an HTML gallery.", "version": "0.1", "x-build-id": "QetF7VsP6FbNFsZEK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aster_data~website-screenshot-studio/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aster_data-website-screenshot-studio", "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/aster_data~website-screenshot-studio/runs": { "post": { "operationId": "runs-sync-aster_data-website-screenshot-studio", "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/aster_data~website-screenshot-studio/run-sync": { "post": { "operationId": "run-sync-aster_data-website-screenshot-studio", "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": "Website URLs", "minItems": 1, "maxItems": 1000, "type": "array", "description": "Explicit HTTP(S) URLs, as strings or objects with a url property. URL-list files and crawling are not supported." }, "devices": { "title": "Devices", "minItems": 1, "maxItems": 3, "type": "array", "description": "Each selected device produces a separate capture. All images use one image pixel per CSS pixel.", "items": { "type": "string", "enum": [ "desktop", "tablet", "mobile" ] }, "default": [ "desktop" ] }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG for lossless images, JPEG for smaller files, PDF for the complete document on A4 pages.", "default": "png" }, "quality": { "title": "Quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "JPEG quality, from 1 to 100. Ignored for PNG and PDF.", "default": 85 }, "fullPage": { "title": "Full Page", "type": "boolean", "description": "Capture the full page up to the height limit. Disable for the viewport only. PDF requires true.", "default": true }, "viewportWidth": { "title": "Viewport Width", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Desktop width in CSS pixels. Mobile and tablet use their device presets.", "default": 1440 }, "viewportHeight": { "title": "Viewport Height", "minimum": 240, "maximum": 2160, "type": "integer", "description": "Desktop height in CSS pixels. Mobile and tablet use their device presets.", "default": 900 }, "maxScreenshotHeight": { "title": "Max Screenshot Height", "minimum": 240, "maximum": 30000, "type": "integer", "description": "Maximum image height and scrolling distance. Must be at least 1024 and the desktop viewport height. PDF prints the complete document; this limit only bounds its scrolling.", "default": 12000 }, "captureSelector": { "title": "Capture Selector", "maxLength": 500, "type": "string", "description": "Optional CSS selector for one element. Oversized elements fail explicitly. Not available for PDF.", "default": "" }, "waitUntil": { "title": "Wait Until", "enum": [ "domcontentloaded", "load", "networkidle" ], "type": "string", "description": "Navigation readiness event. Network idle can time out on pages with continuous traffic.", "default": "load" }, "waitForSelector": { "title": "Wait For Selector", "maxLength": 500, "type": "string", "description": "Optional CSS selector that must become visible before capture. Failure produces an error row.", "default": "" }, "delay": { "title": "Delay", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Extra wait after navigation, in milliseconds.", "default": 500 }, "navigationTimeoutSecs": { "title": "Navigation Timeout Secs", "minimum": 1, "maximum": 120, "type": "integer", "description": "Maximum seconds for a navigation attempt.", "default": 30 }, "captureTimeoutSecs": { "title": "Capture Timeout Secs", "minimum": 2, "maximum": 180, "type": "integer", "description": "Maximum seconds for an entire capture attempt, including navigation, rendering, and encoding.", "default": 60 }, "assetTimeoutSecs": { "title": "Asset Timeout Secs", "minimum": 1, "maximum": 45, "type": "integer", "description": "Maximum seconds waiting for images in the capture area to load and decode. Hidden and out-of-scope images are excluded.", "default": 10 }, "failOnMissingImages": { "title": "Fail On Missing Images", "type": "boolean", "description": "Fail without saving a screenshot when an image needed by the capture remains unavailable. Disable to save a diagnostic screenshot with explicit asset issues.", "default": true }, "scrollToBottom": { "title": "Scroll To Bottom", "type": "boolean", "description": "Scroll to trigger lazy content, bounded by the time and image height limits, then return to the top.", "default": false }, "maxScrollTimeSecs": { "title": "Max Scroll Time Secs", "minimum": 1, "maximum": 30, "type": "integer", "description": "Maximum seconds spent scrolling in each attempt.", "default": 10 }, "cookieConsent": { "title": "Cookie Consent", "enum": [ "reject", "accept", "none" ], "type": "string", "description": "Automatically dismiss consent dialogs. Prefer rejecting optional cookies by default, with accept/close fallback. Use none to preserve consent overlays.", "default": "reject" }, "dismissModals": { "title": "Dismiss Modals", "type": "boolean", "description": "Close other detected modal dialogs using an explicit close, dismiss, or no-thanks control. Fail the capture if a detected blocking dialog remains.", "default": true }, "hideCookieBanners": { "title": "Hide Cookie Banners", "type": "boolean", "description": "Hide banners matched by a small list of known selectors. Does not click consent or guarantee removal.", "default": false }, "selectorsToHide": { "title": "Selectors to hide", "maxLength": 5000, "type": "string", "description": "CSS selectors to hide before capture, one selector per line. A comma-separated CSS selector is also valid.", "default": "" }, "darkMode": { "title": "Dark Mode", "type": "boolean", "description": "Use the browser dark color scheme. Only pages that support it will change appearance.", "default": false }, "blockMedia": { "title": "Block Media", "type": "boolean", "description": "Block video and audio downloads. Images, styles, scripts, and fonts remain enabled.", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Number of isolated browser contexts running concurrently. Start with 2 on a 2 GB Actor.", "default": 2 }, "maxRetries": { "title": "Max Retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Extra attempts for navigation failures, deadlines, unresolved dialogs, transient image failures, HTTP 429, and HTTP 5xx. Proxied HTTP 403 responses also retry. Other HTTP errors are final.", "default": 1 }, "maxCaptures": { "title": "Max Captures", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Reject input when the number of unique URL × device captures exceeds this limit.", "default": 100 }, "allowPrivateUrls": { "title": "Allow Private Urls", "type": "boolean", "description": "Local testing only. Must remain false on Apify.", "default": false }, "proxy": { "title": "Proxy", "type": "object", "description": "Optional Apify Proxy or custom proxy configuration. Omitting it uses a direct connection." } } }, "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 } } } } } } } } } }