{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & PDF — Full Page, Mobile, Video", "description": "Screenshot any website or HTML as PNG, JPEG, WebP, PDF or scrolling MP4/GIF. Full page, element or region, 200+ devices, cookie banners hidden or accepted, sticky headers fixed. Public links, page text for AI agents. Pay only for successful captures.", "version": "1.0", "x-build-id": "fRJF1fgd2UPCFP26T" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devdeep~website-screenshot-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devdeep-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/devdeep~website-screenshot-pdf/runs": { "post": { "operationId": "runs-sync-devdeep-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/devdeep~website-screenshot-pdf/run-sync": { "post": { "operationId": "run-sync-devdeep-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": { "urls": { "title": "Page URLs", "type": "array", "description": "The web pages to capture. One file per URL. Duplicates are removed; invalid addresses are reported.", "items": { "type": "string" } }, "url": { "title": "Single URL", "type": "string", "description": "Optional: one page URL (handy for API and AI-agent calls). Added to 'Page URLs'." }, "html": { "title": "Raw HTML", "type": "string", "description": "Optional: HTML to render and capture instead of (or as well as) URLs, e.g. an invoice or email template." }, "captureMode": { "title": "What to capture", "enum": [ "fullPage", "viewport", "customHeight", "element", "region" ], "type": "string", "description": "fullPage = the whole page. viewport = the first screen only. customHeight = from the top down to 'Height to capture'. element = one element (CSS selector). region = an exact rectangle (Region).", "default": "fullPage" }, "format": { "title": "Format", "enum": [ "png", "jpeg", "webp", "pdf", "mp4", "gif" ], "type": "string", "description": "PNG (sharp), JPEG or WebP (smaller), PDF (printable, selectable text), MP4 or GIF (a video scrolling down the page).", "default": "png" }, "elementSelector": { "title": "Element selector", "type": "string", "description": "CSS selector of the element to capture when 'What to capture' is 'element', e.g. #pricing." }, "clip": { "title": "Region", "type": "object", "description": "Rectangle to capture when 'What to capture' is 'region', in CSS pixels from the top-left of the page: {\"x\":0,\"y\":0,\"width\":800,\"height\":600}.", "default": {} }, "customHeight": { "title": "Height to capture", "minimum": 50, "maximum": 30000, "type": "integer", "description": "For 'customHeight': capture from the top of the page down to this many pixels.", "default": 2000 }, "maxHeight": { "title": "Maximum full-page height", "minimum": 1000, "maximum": 50000, "type": "integer", "description": "Very long or endless pages are cut at this height (the result says truncated: true).", "default": 15000 }, "quality": { "title": "Image quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1–100, for JPEG and WebP.", "default": 80 }, "omitBackground": { "title": "Transparent background", "type": "boolean", "description": "Make the default white background transparent (PNG and WebP; the page must not paint its own background).", "default": false }, "thumbnailWidth": { "title": "Thumbnail width", "minimum": 0, "maximum": 1200, "type": "integer", "description": "Also save a small JPEG thumbnail this many pixels wide (0 = none). Free.", "default": 0 }, "device": { "title": "Device", "enum": [ "desktop", "desktop_1440", "laptop", "macbook", "tablet", "mobile", "android", "square", "social_card", "custom" ], "type": "string", "description": "Screen to emulate. Mobile, Android and tablet also set a mobile user agent and touch.", "default": "desktop" }, "devicePreset": { "title": "Exact device model", "enum": [ "Blackberry PlayBook", "Blackberry PlayBook landscape", "BlackBerry Z30", "BlackBerry Z30 landscape", "Galaxy Note 3", "Galaxy Note 3 landscape", "Galaxy Note II", "Galaxy Note II landscape", "Galaxy S III", "Galaxy S III landscape", "Galaxy S5", "Galaxy S5 landscape", "Galaxy S8", "Galaxy S8 landscape", "Galaxy S9+", "Galaxy S9+ landscape", "Galaxy S24", "Galaxy S24 landscape", "Galaxy A55", "Galaxy A55 landscape", "Galaxy Tab S4", "Galaxy Tab S4 landscape", "Galaxy Tab S9", "Galaxy Tab S9 landscape", "Galaxy Z Fold 6", "Galaxy Z Fold 6 landscape", "Galaxy Z Fold 6 Cover", "Galaxy Z Fold 6 Cover landscape", "Galaxy Z Fold 7", "Galaxy Z Fold 7 landscape", "Galaxy Z Fold 7 Cover", "Galaxy Z Fold 7 Cover landscape", "Galaxy Z Flip 6", "Galaxy Z Flip 6 landscape", "Galaxy Z Flip 6 Cover", "Galaxy Z Flip 6 Cover landscape", "Galaxy Z Flip 7", "Galaxy Z Flip 7 landscape", "Galaxy Z Flip 7 Cover", "Galaxy Z Flip 7 Cover landscape", "iPad (gen 5)", "iPad (gen 5) landscape", "iPad (gen 6)", "iPad (gen 6) landscape", "iPad (gen 7)", "iPad (gen 7) landscape", "iPad (gen 11)", "iPad (gen 11) landscape", "iPad Mini", "iPad Mini landscape", "iPad Pro 11", "iPad Pro 11 landscape", "iPhone 6", "iPhone 6 landscape", "iPhone 6 Plus", "iPhone 6 Plus landscape", "iPhone 7", "iPhone 7 landscape", "iPhone 7 Plus", "iPhone 7 Plus landscape", "iPhone 8", "iPhone 8 landscape", "iPhone 8 Plus", "iPhone 8 Plus landscape", "iPhone SE", "iPhone SE landscape", "iPhone SE (3rd gen)", "iPhone SE (3rd gen) landscape", "iPhone X", "iPhone X landscape", "iPhone XR", "iPhone XR landscape", "iPhone 11", "iPhone 11 landscape", "iPhone 11 Pro", "iPhone 11 Pro landscape", "iPhone 11 Pro Max", "iPhone 11 Pro Max landscape", "iPhone 12", "iPhone 12 landscape", "iPhone 12 Pro", "iPhone 12 Pro landscape", "iPhone 12 Pro Max", "iPhone 12 Pro Max landscape", "iPhone 12 Mini", "iPhone 12 Mini landscape", "iPhone 13", "iPhone 13 landscape", "iPhone 13 Pro", "iPhone 13 Pro landscape", "iPhone 13 Pro Max", "iPhone 13 Pro Max landscape", "iPhone 13 Mini", "iPhone 13 Mini landscape", "iPhone 14", "iPhone 14 landscape", "iPhone 14 Plus", "iPhone 14 Plus landscape", "iPhone 14 Pro", "iPhone 14 Pro landscape", "iPhone 14 Pro Max", "iPhone 14 Pro Max landscape", "iPhone 15", "iPhone 15 landscape", "iPhone 15 Plus", "iPhone 15 Plus landscape", "iPhone 15 Pro", "iPhone 15 Pro landscape", "iPhone 15 Pro Max", "iPhone 15 Pro Max landscape", "iPhone 16", "iPhone 16 landscape", "iPhone 16 Plus", "iPhone 16 Plus landscape", "iPhone 16 Pro", "iPhone 16 Pro landscape", "iPhone 16 Pro Max", "iPhone 16 Pro Max landscape", "iPhone 16e", "iPhone 16e landscape", "iPhone 17", "iPhone 17 landscape", "iPhone Air", "iPhone Air landscape", "iPhone 17 Pro", "iPhone 17 Pro landscape", "iPhone 17 Pro Max", "iPhone 17 Pro Max landscape", "iPhone 17e", "iPhone 17e landscape", "Kindle Fire HDX", "Kindle Fire HDX landscape", "LG Optimus L70", "LG Optimus L70 landscape", "Microsoft Lumia 550", "Microsoft Lumia 550 landscape", "Microsoft Lumia 950", "Microsoft Lumia 950 landscape", "Nexus 10", "Nexus 10 landscape", "Nexus 4", "Nexus 4 landscape", "Nexus 5", "Nexus 5 landscape", "Nexus 5X", "Nexus 5X landscape", "Nexus 6", "Nexus 6 landscape", "Nexus 6P", "Nexus 6P landscape", "Nexus 7", "Nexus 7 landscape", "Nokia Lumia 520", "Nokia Lumia 520 landscape", "Nokia N9", "Nokia N9 landscape", "Pixel 2", "Pixel 2 landscape", "Pixel 2 XL", "Pixel 2 XL landscape", "Pixel 3", "Pixel 3 landscape", "Pixel 4", "Pixel 4 landscape", "Pixel 4a (5G)", "Pixel 4a (5G) landscape", "Pixel 5", "Pixel 5 landscape", "Pixel 6", "Pixel 6 landscape", "Pixel 6 Pro", "Pixel 6 Pro landscape", "Pixel 6a", "Pixel 6a landscape", "Pixel 7", "Pixel 7 landscape", "Pixel 7 Pro", "Pixel 7 Pro landscape", "Pixel 7a", "Pixel 7a landscape", "Pixel 8", "Pixel 8 landscape", "Pixel 8 Pro", "Pixel 8 Pro landscape", "Pixel 8a", "Pixel 8a landscape", "Pixel 9", "Pixel 9 landscape", "Pixel 9 Pro", "Pixel 9 Pro landscape", "Pixel 9 Pro XL", "Pixel 9 Pro XL landscape", "Pixel 10", "Pixel 10 landscape", "Pixel 10 Pro", "Pixel 10 Pro landscape", "Pixel 10 Pro XL", "Pixel 10 Pro XL landscape", "Moto G4", "Moto G4 landscape", "Desktop Chrome HiDPI", "Desktop Edge HiDPI", "Desktop Firefox HiDPI", "Desktop Safari", "Desktop Chrome", "Desktop Edge", "Desktop Firefox" ], "type": "string", "description": "Optional: emulate one of 200+ exact devices (overrides 'Device'), e.g. iPhone 15 Pro Max, Galaxy S9+, iPad Pro 11 landscape." }, "viewportWidth": { "title": "Width (custom)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Viewport width for 'Custom size'.", "default": 1280 }, "viewportHeight": { "title": "Height (custom)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Viewport height for 'Custom size'.", "default": 800 }, "isMobile": { "title": "Mobile (custom)", "type": "boolean", "description": "For 'Custom size': behave like a phone (mobile viewport rules).", "default": false }, "hasTouch": { "title": "Touch (custom)", "type": "boolean", "description": "For 'Custom size': report a touch screen.", "default": false }, "scale": { "title": "Pixel density", "enum": [ "device", "1", "2", "3" ], "type": "string", "description": "'Device default' uses the device's own density (iPhone = 3x). 2x gives sharp retina images.", "default": "device" }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the site for its dark colour scheme.", "default": false }, "cookieBanners": { "title": "Cookie banners", "enum": [ "hide", "accept", "reject", "off" ], "type": "string", "description": "hide = hide consent banners (fastest). accept / reject = click the banner's accept or reject button (then hide what's left). off = leave them.", "default": "hide" }, "blockAds": { "title": "Block ads and trackers", "type": "boolean", "description": "Block requests to common ad and tracking domains.", "default": true }, "stickyElements": { "title": "Sticky headers and chat bubbles", "enum": [ "fix", "hide", "off" ], "type": "string", "description": "fix = show them once at the top (no repeats in full-page shots). hide = remove them. off = leave as is.", "default": "fix" }, "selectorsToHide": { "title": "Extra selectors to hide", "type": "array", "description": "CSS selectors to hide before capturing, e.g. .chat-widget.", "items": { "type": "string" } }, "blockResources": { "title": "Don't load", "type": "array", "description": "Skip loading these to go faster (images also disappear from the capture).", "items": { "type": "string", "enum": [ "images", "media", "fonts" ], "enumTitles": [ "Images", "Video and audio", "Web fonts" ] }, "default": [] }, "customCss": { "title": "Custom CSS", "type": "string", "description": "CSS injected before capturing." }, "customJs": { "title": "Custom JavaScript", "type": "string", "description": "JavaScript run in the page before capturing, e.g. to click a tab or close a pop-up." }, "loadLazyContent": { "title": "Load lazy images", "type": "boolean", "description": "Scroll through the page so lazy-loaded images appear, then return to the top.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle", "commit" ], "type": "string", "description": "When the page counts as loaded. networkidle is safest for heavy pages; commit is fastest.", "default": "load" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Optional CSS selector to wait for before capturing." }, "waitForImages": { "title": "Wait for images", "type": "boolean", "description": "Wait until all images finish loading (up to 15 s).", "default": true }, "delayMs": { "title": "Extra delay", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Extra wait before capturing, for animations.", "default": 500 }, "pdfPaper": { "title": "PDF paper", "enum": [ "A4", "Letter", "Legal", "Tabloid", "Ledger", "A3", "A5", "A6", "A2", "A1", "A0", "singlePage" ], "type": "string", "description": "Paper size, or 'Single long page' to keep the whole page on one page like a screenshot.", "default": "A4" }, "pdfLandscape": { "title": "Landscape", "type": "boolean", "description": "Landscape orientation.", "default": false }, "pdfScale": { "title": "Scale", "type": "string", "description": "Zoom of the page in the PDF, 0.1–2.", "default": "1" }, "pdfMargin": { "title": "Margin", "type": "string", "description": "Margin on every side, e.g. 0, 10mm, 0.5in, 20px.", "default": "0" }, "pdfPrintBackground": { "title": "Print backgrounds", "type": "boolean", "description": "Include background colours and images.", "default": true }, "pdfPageRanges": { "title": "Pages", "type": "string", "description": "Optional page ranges, e.g. 1-3, 5." }, "pdfMedia": { "title": "CSS media", "enum": [ "screen", "print" ], "type": "string", "description": "screen = looks like the website. print = uses the site's print stylesheet.", "default": "screen" }, "videoSeconds": { "title": "Video length", "minimum": 2, "maximum": 60, "type": "integer", "description": "For MP4/GIF: seconds to scroll from top to bottom.", "default": 8 }, "videoWidth": { "title": "Video width", "minimum": 320, "maximum": 1920, "type": "integer", "description": "Maximum video width in pixels (GIFs are capped at 800).", "default": 1280 }, "includePageText": { "title": "Include page text", "type": "boolean", "description": "Also return the page's visible text and meta description, so an AI agent can read the page as well as see it. Free.", "default": false }, "maxTextChars": { "title": "Maximum text length", "minimum": 100, "maximum": 100000, "type": "integer", "description": "Cut the returned page text at this many characters.", "default": 5000 }, "cookies": { "title": "Cookies", "type": "array", "description": "Cookies to set before loading, e.g. [{\"name\":\"session\",\"value\":\"abc\",\"domain\":\".example.com\"}]. Only for accounts you own.", "default": [] }, "headers": { "title": "Extra HTTP headers", "type": "object", "description": "Headers sent with every request, e.g. {\"Accept-Language\":\"de-DE\"}.", "default": {} }, "httpUsername": { "title": "HTTP auth username", "type": "string", "description": "For pages behind basic HTTP authentication." }, "httpPassword": { "title": "HTTP auth password", "type": "string", "description": "Password for basic HTTP authentication." }, "userAgent": { "title": "User agent", "type": "string", "description": "Optional custom browser user agent." }, "locale": { "title": "Language", "type": "string", "description": "Browser language, e.g. en-US, de-DE, ja-JP.", "default": "en-US" }, "timezoneId": { "title": "Time zone", "type": "string", "description": "Optional time zone, e.g. Europe/Berlin, Asia/Kolkata." }, "geolocation": { "title": "Location", "type": "object", "description": "Optional GPS location, e.g. {\"latitude\":40.71,\"longitude\":-74.0}.", "default": {} }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Use a proxy for sites that block data-centre traffic or to load country-specific versions.", "default": { "useApifyProxy": false } }, "timeoutSecs": { "title": "Timeout per page", "minimum": 10, "maximum": 180, "type": "integer", "description": "Give up on a page after this many seconds (retried, then reported as failed and not charged).", "default": 45 }, "maxRetries": { "title": "Retries per page", "minimum": 0, "maximum": 5, "type": "integer", "description": "Times to retry a page that fails.", "default": 2 }, "maxConcurrency": { "title": "Pages in parallel", "minimum": 1, "maximum": 20, "type": "integer", "description": "Pages captured at the same time.", "default": 5 } } }, "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 } } } } } } } } } }