{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & PDF API", "description": "Render any public page in a real browser and get a screenshot or an A4 PDF back. Full page or viewport, desktop to mobile presets, retina, dark mode, ads blocked and consent overlays hidden so the image shows the page, not a cookie wall.", "version": "1.0", "x-build-id": "gUcBPJgYyedBD2niw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/noclat~website-screenshot-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-noclat-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/noclat~website-screenshot-pdf/runs": { "post": { "operationId": "runs-sync-noclat-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/noclat~website-screenshot-pdf/run-sync": { "post": { "operationId": "run-sync-noclat-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", "minItems": 1, "type": "array", "description": "Pages to render. One capture is produced per URL.", "default": [ "https://apify.com", "https://stripe.com" ], "items": { "type": "string" } }, "screenshot": { "title": "Screenshot", "type": "boolean", "description": "Produce an image of the page.", "default": true }, "pdf": { "title": "PDF", "type": "boolean", "description": "Produce an A4 PDF of the page, printed with backgrounds.", "default": false }, "imageFormat": { "title": "Image format", "enum": [ "png", "jpeg" ], "type": "string", "description": "PNG is lossless and best for interfaces. JPEG is much smaller for photo-heavy pages.", "default": "png" }, "quality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1 to 100. Ignored for PNG.", "default": 85 }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole document, scrolling through it first so lazy-loaded images appear. Turn off to capture only the viewport.", "default": true }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile", "custom" ], "type": "string", "description": "Viewport preset. Choose Custom to set your own width and height.", "default": "desktop" }, "width": { "title": "Viewport width", "minimum": 200, "maximum": 5000, "type": "integer", "description": "Overrides the preset width." }, "height": { "title": "Viewport height", "minimum": 200, "maximum": 5000, "type": "integer", "description": "Overrides the preset height. With Full page on, this is only the starting window." }, "deviceScaleFactor": { "title": "Pixel density", "minimum": 1, "maximum": 3, "type": "integer", "description": "2 gives a retina-quality image at twice the pixels." }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Render the page as a visitor whose system is set to dark.", "default": false }, "hideCookieBanners": { "title": "Hide consent and cookie overlays", "type": "boolean", "description": "Hides the usual consent, cookie and newsletter overlays so the image shows the page. They are hidden, never clicked, so nothing is consented to.", "default": true }, "hideSelectors": { "title": "Also hide these elements", "type": "array", "description": "CSS selectors to hide before capturing, for example a chat bubble or a sticky header.", "items": { "type": "string" } }, "blockAds": { "title": "Block ads and trackers", "type": "boolean", "description": "Blocks the usual ad and analytics hosts, which makes pages load faster and look cleaner.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When to consider the page ready. Network idle is the safest for heavy apps and the slowest.", "default": "load" }, "waitForSelector": { "title": "Wait for element", "type": "string", "description": "Wait for this CSS selector before capturing. The capture still happens if it never appears." }, "delaySecs": { "title": "Extra delay (seconds)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Wait this long after the page is ready, for animations to settle." }, "maxRunMinutes": { "title": "Stop the whole run after (minutes)", "minimum": 1, "maximum": 60, "type": "integer", "description": "A safety net for long lists of slow pages. The run stops cleanly and reports what it captured.", "default": 15 }, "timeoutSecs": { "title": "Timeout per page (seconds)", "minimum": 5, "maximum": 90, "type": "integer", "description": "Give up on a page after this long. Capped at 90 seconds.", "default": 45 } } }, "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 } } } } } } } } } }