{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & PDF - Full Page, Mobile, Dark Mode", "description": "Full-page or viewport screenshots (PNG, JPEG) and PDFs of any URL list. 12 device presets, dark mode, cookie banner hiding, lazy-load scrolling, batches up to 1000 URLs. Pay only per captured page.", "version": "0.1", "x-build-id": "dAagquM8JtIbnnKTr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maksym_kotenko~website-screenshot-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maksym_kotenko-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/maksym_kotenko~website-screenshot-pdf/runs": { "post": { "operationId": "runs-sync-maksym_kotenko-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/maksym_kotenko~website-screenshot-pdf/run-sync": { "post": { "operationId": "run-sync-maksym_kotenko-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, up to 1000 per run. A missing scheme defaults to https://. Duplicates are captured once.", "items": { "type": "string" } }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG is lossless, JPEG is smaller, PDF renders the page as a document.", "default": "png" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of the first screen. Ignored for PDF.", "default": true }, "device": { "title": "Device", "enum": [ "desktop-1920", "desktop-1440", "desktop-1366", "desktop-1280", "desktop-2560", "macbook-retina", "ipad-air", "ipad-pro", "iphone-15", "iphone-se", "pixel-8", "galaxy-s24", "custom" ], "type": "string", "description": "Viewport size, pixel ratio, touch and user agent of the emulated device. Choose Custom to set your own viewport below.", "default": "desktop-1920" }, "colorScheme": { "title": "Color scheme", "enum": [ "light", "dark", "no-preference" ], "type": "string", "description": "Sets prefers-color-scheme, so sites with a dark theme render in dark mode.", "default": "light" }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hides consent popups of the common consent platforms (OneTrust, Cookiebot, Didomi, Usercentrics, Quantcast, Sourcepoint, CookieYes and more) and unlocks page scrolling.", "default": true }, "hideSelectors": { "title": "Hide elements", "type": "array", "description": "Extra CSS selectors to hide before capture, for example chat widgets or promo bars.", "items": { "type": "string" }, "default": [] }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Navigation is done when this event fires. Network idle is slower but safer for single-page apps.", "default": "load" }, "delaySecs": { "title": "Extra delay", "minimum": 0, "maximum": 60, "type": "integer", "description": "Wait this long after the page loads, for animations and late content.", "default": 0 }, "scrollToBottom": { "title": "Scroll to load lazy content", "type": "boolean", "description": "Scroll through the page before capture so lazy-loaded images appear in a full-page screenshot.", "default": false }, "navigationTimeoutSecs": { "title": "Page timeout", "minimum": 10, "maximum": 180, "type": "integer", "description": "Maximum time to load one page.", "default": 60 }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times a page that failed to load or answered 5xx is retried. Failed pages are not charged.", "default": 2 }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Only for JPEG output.", "default": 80 }, "maxHeightPx": { "title": "Max full-page height", "minimum": 1000, "maximum": 16384, "type": "integer", "description": "Very long pages are cut at this height. High pixel ratio devices are limited further to 16384 image pixels.", "default": 16384 }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "A3", "A5", "Letter", "Legal", "Tabloid" ], "type": "string", "description": "Only for PDF output.", "default": "A4" }, "pdfLandscape": { "title": "PDF landscape", "type": "boolean", "description": "Only for PDF output.", "default": false }, "viewportWidth": { "title": "Custom viewport width", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Used when Device is Custom viewport.", "default": 1280 }, "viewportHeight": { "title": "Custom viewport height", "minimum": 240, "maximum": 4320, "type": "integer", "description": "Used when Device is Custom viewport.", "default": 800 }, "deviceScaleFactor": { "title": "Custom pixel ratio", "minimum": 1, "maximum": 3, "type": "number", "description": "Used when Device is Custom viewport. 2 gives a retina-sharp image.", "default": 1 }, "maxConcurrency": { "title": "Max parallel pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Upper bound for pages captured at once. The actual parallelism also depends on run memory: give 4 GB or more for large batches.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Use a proxy for sites that block datacenter traffic or show region-specific content.", "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 } } } } } } } } } }