{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & HTML to Image (PNG, JPEG, PDF)", "description": "Capture full-page website screenshots or PDFs for desktop, tablet or mobile, or render your own HTML to PNG, JPEG or PDF. Cookie banners, popups and ads are removed automatically. Pay only for successful screenshots.", "version": "1.0", "x-build-id": "aIr3uL3F8lk5dsmSj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/adaptive_arbor_rtz~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-adaptive_arbor_rtz-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/adaptive_arbor_rtz~website-screenshot/runs": { "post": { "operationId": "runs-sync-adaptive_arbor_rtz-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/adaptive_arbor_rtz~website-screenshot/run-sync": { "post": { "operationId": "run-sync-adaptive_arbor_rtz-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", "properties": { "urls": { "title": "URLs", "type": "array", "description": "Web page addresses to capture, one per line (e.g. https://example.com). Each URL produces one screenshot or PDF. Addresses without http:// or https:// get https:// added.", "items": { "type": "string" } }, "html": { "title": "HTML to render (optional)", "type": "string", "description": "Optional. Raw HTML to turn into an image or PDF instead of (or as well as) a URL, e.g. an invoice, social card or email template. Images, fonts and CSS linked from it are loaded." }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "type": "string", "description": "Which screen to emulate. desktop = 1920×1080, laptop = 1366×768, tablet = iPad (touch, tablet user agent), mobile = iPhone 14 (touch, mobile user agent, 3× pixel density).", "default": "desktop" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of only the visible screen. Very long pages are cut at 'Maximum height'.", "default": true }, "format": { "title": "Output format", "enum": [ "jpeg", "png", "pdf" ], "type": "string", "description": "jpeg = small image files (recommended, fast to download), png = lossless image (larger files), pdf = printable A4 document of the page (ignores Device size and Only this element).", "default": "jpeg" }, "hideCookieBanners": { "title": "Hide cookie banners and popups", "type": "boolean", "description": "Hide cookie-consent dialogs, newsletter popups and chat widgets so the page itself is visible. They are hidden, never accepted.", "default": true }, "blockAds": { "title": "Block ads and trackers", "type": "boolean", "description": "Block ads and tracking scripts. Gives cleaner screenshots and faster, cheaper runs.", "default": true }, "selector": { "title": "Only this element (CSS selector)", "type": "string", "description": "Optional. Capture only the first element matching this CSS selector, e.g. 'main' or '#pricing'. If nothing matches, the URL is reported as failed and not charged." }, "hideSelectors": { "title": "Hide these elements", "type": "array", "description": "Optional CSS selectors of elements to hide before capturing, e.g. '.sticky-header' or '#promo-bar'.", "items": { "type": "string" } }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the site for its dark colour scheme (prefers-color-scheme: dark). Only works on sites that support it.", "default": false }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded. load = all resources loaded (recommended), domcontentloaded = HTML ready (fastest), networkidle = no network activity for 0.5 s (slowest, best for heavy JavaScript apps).", "default": "load" }, "delaySecs": { "title": "Extra wait (seconds)", "minimum": 0, "maximum": 60, "type": "integer", "description": "Extra seconds to wait after the page loads, for animations or late content.", "default": 1 }, "scrollToLoadLazyContent": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scroll through the page before capturing so lazy-loaded images appear in full-page screenshots.", "default": true }, "viewportWidth": { "title": "Custom width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Optional. Overrides the device width." }, "viewportHeight": { "title": "Custom height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Optional. Overrides the device height (the visible area when 'Full page' is off)." }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Quality 1–100 when the output format is jpeg.", "default": 80 }, "maxHeight": { "title": "Maximum height (px)", "minimum": 500, "maximum": 30000, "type": "integer", "description": "Full-page screenshots taller than this are cut at this height.", "default": 10000 }, "timeoutSecs": { "title": "Page timeout (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Give up on a page that has not loaded after this many seconds. Failed pages are not charged.", "default": 60 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages to capture at the same time.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Use a proxy for sites that block data-centre traffic or show a different country's version.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }