{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API: full-page, element, mobile & PDF", "description": "Capture screenshots of any list of URLs with real Chromium: viewport, full-page, element and PDF captures in PNG, JPEG, WebP or PDF, with cookie-banner hiding, ad blocking, dark mode and custom CSS/JS. Also usable as a live HTTP API via Standby mode. By Steadyline Data.", "version": "0.1", "x-build-id": "iLb3kYEmomxRO1hW8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/steadyline~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-steadyline-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/steadyline~website-screenshot/runs": { "post": { "operationId": "runs-sync-steadyline-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/steadyline~website-screenshot/run-sync": { "post": { "operationId": "run-sync-steadyline-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", "type": "array", "description": "Pages to capture (http/https only). A missing scheme defaults to https://.", "items": { "type": "string" } }, "viewport": { "title": "Viewport", "enum": [ "desktop", "laptop", "tablet", "mobile", "custom" ], "type": "string", "description": "Device preset. Mobile and tablet use a touch, mobile user agent and higher pixel density.", "default": "desktop" }, "customWidth": { "title": "Custom width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Used when viewport = custom." }, "customHeight": { "title": "Custom height (px)", "minimum": 200, "maximum": 2160, "type": "integer", "description": "Used when viewport = custom." }, "deviceScaleFactor": { "title": "Device scale factor", "minimum": 1, "maximum": 3, "type": "integer", "description": "Pixel density for custom viewport (1-3)." }, "isMobile": { "title": "Emulate mobile (custom viewport)", "type": "boolean", "description": "Mobile user agent and touch for custom viewport." }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of just the viewport (billed as full-page).", "default": false }, "selector": { "title": "Element selector", "type": "string", "description": "CSS selector; when set, only the first matching visible element is captured (e.g. header, #pricing)." }, "format": { "title": "Format", "enum": [ "png", "jpeg", "webp", "pdf" ], "type": "string", "description": "Image format, or PDF (A4, backgrounds printed; billed as full-page/PDF).", "default": "png" }, "quality": { "title": "Quality (JPEG/WebP)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Compression quality for JPEG and WebP.", "default": 80 }, "waitUntil": { "title": "Wait until", "enum": [ "networkidle", "load", "domcontentloaded" ], "type": "string", "description": "When to consider the page loaded. networkidle falls back gracefully if a site never goes idle.", "default": "networkidle" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait after load before capturing (animations, late widgets).", "default": 0 }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hides ~60 common consent-manager and cookie-banner selectors (OneTrust, Cookiebot, Didomi, Quantcast, Usercentrics, ...). Banners are hidden, never accepted.", "default": true }, "hideSelectors": { "title": "Extra selectors to hide", "type": "array", "description": "Your own CSS selectors to hide (popups, chat bubbles).", "items": { "type": "string" } }, "blockAds": { "title": "Block ads, trackers and chat widgets", "type": "boolean", "description": "Blocks requests to ~60 ad, analytics and chat-widget hosts. Faster, cleaner captures.", "default": true }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Emulates prefers-color-scheme: dark.", "default": false }, "customCss": { "title": "Custom CSS", "type": "string", "description": "CSS injected before capture." }, "customJs": { "title": "Custom JavaScript", "type": "string", "description": "JavaScript evaluated in the page (browser sandbox only, no server access) before capture, e.g. to click a tab. Batch mode only." }, "timeoutSecs": { "title": "Timeout per page (s)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Navigation and capture timeout.", "default": 45 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages captured in parallel. ~3 per 2 GB memory.", "default": 3 }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Retries per URL on navigation errors.", "default": 1 } } }, "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 } } } } } } } } } }