{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & PDF API — Cookie Banner Removal", "description": "Use this when you need a clean screenshot or PDF of a web page (cookie banners, ads, chats removed). $0.0015/screenshot, $0.003/full page, $0.005/PDF. Input: {\"url\":\"https://example.com\",\"format\":\"png\"}. Output: screenshotUrl, title, status, width, height. Bulk URLs, mobile/desktop.", "version": "1.0", "x-build-id": "G9OFQfJdexpaCcmPq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/poised_beardlichen~website-screenshot-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-poised_beardlichen-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/poised_beardlichen~website-screenshot-pdf/runs": { "post": { "operationId": "runs-sync-poised_beardlichen-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/poised_beardlichen~website-screenshot-pdf/run-sync": { "post": { "operationId": "run-sync-poised_beardlichen-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": { "url": { "title": "Single page URL (optional)", "type": "string", "description": "Shortcut for one page URL, e.g. \"https://example.com\". Combined with the list below; provide at least one of the two." }, "urls": { "title": "URLs", "type": "array", "description": "Web pages to capture, processed in parallel. \"example.com\" without https:// works too. Use \"url\" instead for a single page.", "items": { "type": "string" } }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "webp", "pdf" ], "type": "string", "description": "Image format, or PDF for a printable document.", "default": "png" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of just the visible viewport.", "default": false }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile", "android" ], "type": "string", "description": "Viewport preset. Tablet and mobile use real device emulation (user agent, touch, pixel ratio).", "default": "desktop" }, "hideCookieBanners": { "title": "Hide cookie banners & consent popups", "type": "boolean", "description": "Remove cookie/consent pop-ups (OneTrust, Cookiebot, Didomi, Quantcast and more).", "default": true }, "blockAds": { "title": "Block ads & trackers", "type": "boolean", "description": "Block ads and trackers (EasyList/EasyPrivacy). Faster, cleaner pages.", "default": true }, "hideChatWidgets": { "title": "Hide chat widgets", "type": "boolean", "description": "Hide Intercom, Drift, HubSpot, Zendesk and similar chat bubbles.", "default": true }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Emulates prefers-color-scheme: dark.", "default": false }, "devices": { "title": "Multiple devices (optional)", "type": "array", "description": "Capture every URL on several devices in one run. Overrides \"Device\".", "items": { "type": "string", "enum": [ "desktop", "laptop", "tablet", "mobile", "android" ] } }, "width": { "title": "Custom viewport width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Overrides the preset width." }, "height": { "title": "Custom viewport height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Overrides the preset height." }, "scaleFactor": { "title": "Scale factor (retina)", "minimum": 1, "maximum": 3, "type": "integer", "description": "Device pixel ratio. 2 = retina-sharp images (4× pixels)." }, "selector": { "title": "Capture element (CSS selector)", "type": "string", "description": "Screenshot only this element, e.g. \"#pricing\" or \"article\"." }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Page-load event to wait for. \"networkidle\" is slower but safest for heavy apps.", "default": "load" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Wait until this element is visible before capturing." }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Additional wait before capture, for animations.", "default": 300 }, "scrollToBottom": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scroll first so lazy images load (full-page and PDF only).", "default": true }, "timeoutSecs": { "title": "Timeout per page (s)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Max time for navigation and waiting per attempt. Default 30 s.", "default": 30 }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries after network errors or timeouts. Default 1.", "default": 1 }, "customCss": { "title": "Custom CSS", "type": "string", "description": "CSS injected into every page, e.g. \".promo{display:none}\"." }, "customJs": { "title": "Custom JavaScript", "type": "string", "description": "Script run in the page before capture (may be async)." }, "quality": { "title": "JPEG/WebP quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Ignored for PNG and PDF.", "default": 80 }, "maxFullPageHeight": { "title": "Max full-page height (px)", "minimum": 1000, "maximum": 50000, "type": "integer", "description": "Very long pages are cut at this height.", "default": 16000 }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3", "Tabloid" ], "type": "string", "description": "Only for PDF output.", "default": "A4" }, "pdfLandscape": { "title": "PDF landscape", "type": "boolean", "description": "Only for PDF output.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Pages captured in parallel.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional Apify Proxy for sites that block data-centre traffic or for a country version.", "default": { "useApifyProxy": false } }, "chargeErrorPages": { "title": "Keep error/blocked pages as successes", "type": "boolean", "description": "HTTP 4xx/5xx and bot-protection pages are saved as failed and not charged by default. Enable to keep them as normal results.", "default": 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 } } } } } } } } } }