{ "openapi": "3.0.1", "info": { "title": "Full Page Screenshot & URL to PDF ยท No Cookie Banners", "description": "Full-page website screenshots and PDFs that really capture the whole page: lazy-loaded images scrolled in, cookie banners hidden (never accepted), desktop/laptop/tablet/mobile. Optional visual diff vs. the last run. Pay per delivered file - blocked, 404 and dead URLs are free.", "version": "0.1", "x-build-id": "TotuGT4zQPX8ipbCf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thequietstack~website-screenshot-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thequietstack-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/thequietstack~website-screenshot-pdf/runs": { "post": { "operationId": "runs-sync-thequietstack-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/thequietstack~website-screenshot-pdf/run-sync": { "post": { "operationId": "run-sync-thequietstack-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", "required": [ "urls" ], "properties": { "urls": { "title": "URLs", "type": "array", "description": "Pages to capture. \"example.com\" is read as https://example.com. Duplicates are removed before anything is charged.", "items": { "type": "string" } }, "outputs": { "title": "What to create", "type": "array", "description": "Screenshot, PDF or both. Each delivered file is one charged event.", "items": { "type": "string", "enum": [ "screenshot", "pdf" ], "enumTitles": [ "Screenshot (PNG/JPEG)", "PDF" ] }, "default": [ "screenshot" ] }, "devices": { "title": "Devices", "type": "array", "description": "One capture per URL and device. desktop 1920x1080, laptop 1366x768, tablet iPad (gen 7), mobile iPhone 13 (390 px wide, 3x pixel density).", "items": { "type": "string", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "enumTitles": [ "Desktop 1920x1080", "Laptop 1366x768", "Tablet (iPad)", "Mobile (iPhone 13)" ] }, "default": [ "desktop" ] }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole page height, not just the first screen.", "default": true }, "maxHeightPx": { "title": "Max height (px)", "minimum": 500, "maximum": 30000, "type": "integer", "description": "Very long pages are cut at this height; the row says so (truncated: true) and reports the real page height.", "default": 15000 }, "screenshotFormat": { "title": "Screenshot format", "enum": [ "png", "jpeg" ], "type": "string", "description": "PNG is lossless; JPEG files are much smaller for long pages.", "default": "png" }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1-100, only used for JPEG.", "default": 80 }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hides consent banners of OneTrust, Cookiebot, Usercentrics, Didomi, Quantcast, TrustArc, Sourcepoint, Borlabs, Complianz, CookieYes, Iubenda and generic patterns, and removes their scroll lock. Banners are hidden, never clicked - no consent is given on your behalf.", "default": true }, "hideSelectors": { "title": "Also hide these CSS selectors", "type": "array", "description": "Extra elements to hide, e.g. a chat widget or a sticky promo bar: \"#intercom-container\", \".newsletter-popup\".", "items": { "type": "string" } }, "scrollForLazyLoad": { "title": "Scroll to load lazy content", "type": "boolean", "description": "Scrolls down step by step before capturing so lazy-loaded images and sections render, then scrolls back to the top.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded before scrolling and capturing. 'networkidle' is safest for heavy pages but slower.", "default": "load" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Optional. Capture only after this element is visible. If it never appears the URL is reported as selector-not-found (not charged)." }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Extra wait before capturing, e.g. for animations.", "default": 0 }, "navigationTimeoutSecs": { "title": "Page load timeout (s)", "minimum": 5, "maximum": 60, "type": "integer", "description": "Maximum time to load one page (max 60 s). Loading, scrolling and waiting for one page are capped at 60 s in total. URLs that time out are reported and never charged.", "default": 30 }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3", "A5", "Tabloid" ], "type": "string", "description": "Paper size of the PDF output.", "default": "A4" }, "pdfLandscape": { "title": "PDF landscape", "type": "boolean", "description": "Print the PDF in landscape orientation.", "default": false }, "pdfMedia": { "title": "PDF look", "enum": [ "screen", "print" ], "type": "string", "description": "screen = looks like the website in the browser. print = uses the site's print stylesheet.", "default": "screen" }, "pdfPrintBackground": { "title": "PDF with backgrounds", "type": "boolean", "description": "Include background colors and images in the PDF.", "default": true }, "compareWithPrevious": { "title": "Visual diff against the previous run", "type": "boolean", "description": "Compares each PNG screenshot pixel by pixel with the last capture of the same URL and device (stored in a named key-value store in your account). Rows get diffPercent, changed and a highlighted diff image. Included in the screenshot price.", "default": false }, "minChangePercent": { "title": "Changed if at least (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "A row is marked changed: true when this share of pixels differs.", "default": 0.5 }, "baselineStoreName": { "title": "Baseline store name", "type": "string", "description": "Named key-value store that keeps the last screenshot per URL and device. Use different names for separate projects.", "default": "screenshot-baselines" }, "maxCostUsd": { "title": "Hard cost cap (USD)", "type": "string", "description": "The run stops before starting a capture it could not pay for within this amount. Uses the live event prices. Leave empty for no cap (the platform's Max cost per run still applies)." }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 8, "type": "integer", "description": "Pages captured at the same time. 3 fits 2 GB memory; raise memory before raising this.", "default": 3 } } }, "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 } } } } } } } } } }