{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & PDF: full page, mobile, element, WebP", "description": "Screenshots (PNG, JPEG, WebP) and PDFs of any list of URLs. Full page or viewport, a CSS element or a clip, desktop/tablet/iPhone/Android presets, dark mode, cookie-banner and ad hiding, lazy-load scrolling. Each file gets a link, final URL, title, HTTP status and size.", "version": "1.0", "x-build-id": "k6L2fduzgqmfvo0Ot" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/angadseth~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-angadseth-website-screenshot", "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/angadseth~website-screenshot/runs": { "post": { "operationId": "runs-sync-angadseth-website-screenshot", "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/angadseth~website-screenshot/run-sync": { "post": { "operationId": "run-sync-angadseth-website-screenshot", "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, one per line, e.g. https://example.com. A missing https:// is added. Repeated URLs are captured once.", "default": [ "https://example.com", "https://apify.com" ], "items": { "type": "string" } }, "output": { "title": "What to save", "enum": [ "screenshot", "pdf", "both" ], "type": "string", "description": "A screenshot, a PDF, or both for every page. Each saved file is one result.", "default": "screenshot" }, "format": { "title": "Image format", "enum": [ "png", "jpeg", "webp" ], "type": "string", "description": "PNG is sharp and lossless. JPEG and WebP are much smaller; set their quality below. WebP images can be at most 16,383 px tall.", "default": "png" }, "quality": { "title": "JPEG / WebP quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1 to 100. Ignored for PNG.", "default": 80 }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "iphone", "android", "custom" ], "type": "string", "description": "Screen size, pixel density, touch and user agent of a real device. The viewport fields below override the size and density of any preset.", "default": "desktop" }, "viewportWidth": { "title": "Viewport width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Overrides the device width. Leave empty to use the device preset." }, "viewportHeight": { "title": "Viewport height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Overrides the device height (the visible area; a full-page shot is taller). Leave empty to use the device preset." }, "deviceScaleFactor": { "title": "Device scale factor", "minimum": 0.5, "maximum": 4, "type": "number", "description": "Pixel density, e.g. 2 for a Retina-sharp image twice the size. Leave empty to use the device preset." }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page. Off = only the visible viewport.", "default": true }, "maxPageHeight": { "title": "Max page height (px)", "minimum": 500, "maximum": 100000, "type": "integer", "description": "Full-page shots stop at this height (CSS px), so endless pages do not make giant files. The record says truncated: true when the page was cut.", "default": 20000 }, "selector": { "title": "Capture only this element (CSS selector)", "type": "string", "description": "Screenshot one element instead of the page, e.g. \"#pricing\" or \"main h1\". The first visible match is used. A page with no match is reported as failed (and not charged)." }, "clip": { "title": "Clip area", "type": "object", "description": "Capture a fixed rectangle of the page in CSS pixels from the top-left corner, e.g. {\"x\": 0, \"y\": 0, \"width\": 1200, \"height\": 630} for a social-card sized image. Ignored when an element selector is set." }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded. If a page never gets there (busy sites never go network-quiet), it is still captured once the time runs out, with a warning.", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Wait this long after loading, before capturing, e.g. for animations or charts.", "default": 500 }, "waitForSelector": { "title": "Wait for element (CSS selector)", "type": "string", "description": "Wait until this element is visible before capturing, e.g. \".chart canvas\". If it never appears, the page is captured anyway with a warning." }, "scrollToBottom": { "title": "Scroll to load lazy content", "type": "boolean", "description": "Before a full-page shot or PDF, scroll down the page step by step so lazy images and sections load, then go back to the top.", "default": true }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide cookie and consent pop-ups of common consent tools (OneTrust, Cookiebot, Didomi, Quantcast, Usercentrics and more) with CSS. Nothing is ever clicked, so no consent is given on your behalf.", "default": true }, "hideSelectors": { "title": "Hide elements (CSS selectors)", "type": "array", "description": "Elements to remove before capturing, one CSS selector per line, e.g. \".chat-widget\" or \"#newsletter-popup\".", "items": { "type": "string" } }, "blockAds": { "title": "Block ads and trackers", "type": "boolean", "description": "Do not load requests to a built-in list of about 90 ad and tracking domains. Pages load faster and ad slots stay empty.", "default": false }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Tell the page the device prefers a dark colour scheme (prefers-color-scheme: dark). Sites that support dark mode show it.", "default": false }, "customCss": { "title": "Custom CSS", "type": "string", "description": "CSS added to every page before capturing, e.g. \"header { position: static !important; }\"." }, "reducedMotion": { "title": "Reduce motion", "type": "boolean", "description": "Ask pages to turn off animations (prefers-reduced-motion) and freeze CSS animations at capture time, for sharper and repeatable shots.", "default": true }, "userAgent": { "title": "User agent", "type": "string", "description": "Custom user agent string. Leave empty to use the device preset (desktop presets use current Chrome)." }, "locale": { "title": "Language (locale)", "type": "string", "description": "Browser language, e.g. \"de-DE\" or \"hi-IN\"; sites that adapt to the language show it. Default en-US." }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3", "A5", "Tabloid" ], "type": "string", "description": "Paper size of the PDF pages.", "default": "A4" }, "pdfLandscape": { "title": "PDF landscape", "type": "boolean", "description": "Landscape pages instead of portrait.", "default": false }, "pdfPrintBackground": { "title": "PDF background colours and images", "type": "boolean", "description": "Keep background colours and images in the PDF, like on screen.", "default": true }, "pdfMargin": { "title": "PDF margin", "type": "string", "description": "Margin on all four sides, e.g. \"1cm\", \"10mm\", \"0.5in\" or \"20px\". 0 = edge to edge.", "default": "0px" }, "pdfMedia": { "title": "PDF style", "enum": [ "screen", "print" ], "type": "string", "description": "\"As on screen\" makes the PDF look like the website. \"Print\" uses the site's own print layout, often simpler and without menus.", "default": "screen" }, "pdfScale": { "title": "PDF scale", "minimum": 0.1, "maximum": 2, "type": "number", "description": "Zoom of the page content in the PDF, 0.1 to 2.", "default": 1 }, "timeoutSecs": { "title": "Timeout per page (seconds)", "minimum": 10, "maximum": 300, "type": "integer", "description": "The most time one attempt at one page may take, from opening to saving the file.", "default": 60 }, "maxRetries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many more times to try a page that fails (in a fresh browser tab, with a new proxy session if a proxy is used). Pages that do not exist are not retried.", "default": 2 }, "maxConcurrency": { "title": "Pages at a time", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages to capture in parallel. 3 is safe at 2 GB memory; give more memory before going higher.", "default": 3 }, "includeFailedInDataset": { "title": "Add failed pages to the dataset", "type": "boolean", "description": "Off (default): failed pages are listed in the FAILED and SUMMARY records of the key-value store and are not charged. On: they are also added to the dataset with an error field, and each counts as a result.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Use Apify Proxy (for example residential, or a country) when a site shows a different page to data-centre visitors.", "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 } } } } } } } } } }