{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & PDF: Full-Page, No Cookie Banners", "description": "Capture any URL or HTML as a full-page PNG/JPEG screenshot or PDF. Auto-accepts cookie banners, loads lazy images, blocks ads, device presets, bulk URLs. $3/1,000, compute included, failed captures free.", "version": "1.0", "x-build-id": "uKuEzvg5vxHfBcVpz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/genesis.labs.co~website-screenshot-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-genesis.labs.co-website-screenshot-pdf", "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/genesis.labs.co~website-screenshot-pdf/runs": { "post": { "operationId": "runs-sync-genesis.labs.co-website-screenshot-pdf", "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/genesis.labs.co~website-screenshot-pdf/run-sync": { "post": { "operationId": "run-sync-genesis.labs.co-website-screenshot-pdf", "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": "Pages to capture. Add as many as you like; they run in parallel.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "formats": { "title": "Output formats", "type": "array", "description": "Choose one or more. Each file is charged separately.", "items": { "type": "string", "enum": [ "png", "jpeg", "pdf" ], "enumTitles": [ "PNG screenshot", "JPEG screenshot", "PDF document" ] }, "default": [ "png" ] }, "html": { "title": "Or: raw HTML", "type": "string", "description": "Render your own HTML (invoices, reports, OG images) instead of a URL." }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole page, not just the first screen.", "default": true }, "device": { "title": "Device", "enum": [ "desktop-1920", "desktop-1440", "laptop-1366", "macbook-retina", "ipad", "iphone-15", "pixel-9", "og-image", "custom" ], "type": "string", "description": "Device.", "default": "desktop-1440" }, "viewportWidth": { "title": "Custom width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Used with device 'custom', or to override a preset." }, "viewportHeight": { "title": "Custom height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Custom height (px)." }, "deviceScaleFactor": { "title": "Pixel density", "minimum": 1, "maximum": 3, "type": "integer", "description": "1 = normal, 2 = retina, 3 = phone-sharp. Overrides the preset." }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the site for its dark color scheme.", "default": false }, "dismissCookieBanners": { "title": "Dismiss cookie banners", "type": "boolean", "description": "Accepts common consent banners (OneTrust, Cookiebot, Didomi, Quantcast, Usercentrics, Google and more) and hides leftovers.", "default": true }, "blockAds": { "title": "Block ads & trackers", "type": "boolean", "description": "Faster loads and cleaner images.", "default": true }, "hideSelectors": { "title": "Hide elements (CSS selectors)", "type": "array", "description": "E.g. .chat-widget, #newsletter-popup", "items": { "type": "string" } }, "freezeStickyElements": { "title": "Freeze sticky headers", "type": "boolean", "description": "Turns fixed/sticky headers into normal elements so they appear once at the top of full-page captures.", "default": false }, "elementSelector": { "title": "Capture only this element", "type": "string", "description": "CSS selector, e.g. #pricing. Screenshots only that element." }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Wait until.", "default": "load" }, "waitForSelector": { "title": "Wait for element", "type": "string", "description": "Wait until this CSS selector is visible before capturing." }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait this long before capturing (animations, charts).", "default": 0 }, "scrollToLoad": { "title": "Scroll to load lazy content", "type": "boolean", "description": "Scrolls the page to trigger lazy-loaded images, then scrolls back to the top.", "default": true }, "maxScrollMs": { "title": "Max scrolling time (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Stops scrolling infinite feeds after this long.", "default": 8000 }, "maxHeight": { "title": "Max image height (px)", "minimum": 200, "maximum": 30000, "type": "integer", "description": "Very long pages are cut at this height.", "default": 16000 }, "jpegQuality": { "title": "JPEG quality", "minimum": 10, "maximum": 100, "type": "integer", "description": "JPEG quality.", "default": 85 }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3", "Tabloid" ], "type": "string", "description": "PDF paper size.", "default": "A4" }, "pdfLandscape": { "title": "PDF landscape", "type": "boolean", "description": "PDF landscape.", "default": false }, "pdfPrintBackground": { "title": "PDF: print backgrounds", "type": "boolean", "description": "PDF: print backgrounds.", "default": true }, "pdfMedia": { "title": "PDF: CSS media", "enum": [ "screen", "print" ], "type": "string", "description": "PDF: CSS media.", "default": "screen" }, "pdfMarginMm": { "title": "PDF margin (mm)", "minimum": 0, "maximum": 50, "type": "integer", "description": "PDF margin (mm).", "default": 10 }, "navigationTimeoutSecs": { "title": "Page load timeout (s)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Page load timeout (s).", "default": 45 }, "maxRetries": { "title": "Retries per URL", "minimum": 0, "maximum": 5, "type": "integer", "description": "Extra attempts for timeouts and browser crashes. Failed captures are never charged.", "default": 1 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Default is based on memory (1 page per 400 MB)." }, "ignoreHttpsErrors": { "title": "Ignore HTTPS certificate errors", "type": "boolean", "description": "Ignore HTTPS certificate errors.", "default": false }, "userAgent": { "title": "Custom user agent", "type": "string", "description": "Custom user agent." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Use for geo-specific pages or sites that block datacenter IPs. Proxy traffic is billed by Apify separately.", "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 } } } } } } } } } }