{ "openapi": "3.0.1", "info": { "title": "Website Screenshot Generator: Full Page, Mobile, PDF", "description": "Capture full-page screenshots and PDFs of any website on desktop, iPhone, Android, and iPad in one run. Cookie banners and ads removed automatically. Dark mode, single elements, logged-in pages. PNG, JPEG, or PDF with share links. Pay only for screenshots delivered.", "version": "0.1", "x-build-id": "QyaNlsUnbOrGubqbt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vero-api~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vero-api-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/vero-api~website-screenshot/runs": { "post": { "operationId": "runs-sync-vero-api-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/vero-api~website-screenshot/run-sync": { "post": { "operationId": "run-sync-vero-api-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", "properties": { "urls": { "title": "Websites", "type": "array", "description": "The pages to capture, one per line. Bare domains like apify.com work too.", "items": { "type": "string" } }, "html": { "title": "HTML to capture", "type": "string", "description": "Paste a complete HTML page to turn it into an image or PDF, like an invoice, a report, or a social card. Use full https:// links for images, styles, and fonts. It's captured once per device, along with any websites above." }, "format": { "title": "File format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG for sharp, lossless images. JPEG for smaller files. PDF for a printable document.", "default": "png" }, "fullPage": { "title": "Capture the full page", "type": "boolean", "description": "Capture the whole page from top to bottom, up to 16,384 pixels tall. Turn off to capture only what fits on the screen.", "default": true }, "devices": { "title": "Devices", "type": "array", "description": "Capture each page as it looks on these devices. Pick several to get one screenshot per device.", "items": { "type": "string", "enum": [ "desktop", "iphone-15-pro", "iphone-15-pro-max", "iphone-14", "pixel-7", "galaxy-s9", "ipad-pro-11", "ipad-mini", "galaxy-tab-s9" ], "enumTitles": [ "Desktop", "iPhone 15 Pro", "iPhone 15 Pro Max", "iPhone 14", "Google Pixel 7", "Samsung Galaxy S9+", "iPad Pro 11\"", "iPad Mini", "Samsung Galaxy Tab S9" ] }, "default": [ "desktop" ] }, "viewportWidth": { "title": "Desktop width", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Screen width for desktop screenshots. 1280 fits a laptop, 1920 a full HD monitor.", "default": 1280 }, "viewportHeight": { "title": "Desktop height", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Screen height for desktop screenshots. Sets the image height when \"Capture the full page\" is off.", "default": 800 }, "scale": { "title": "Pixel density", "minimum": 1, "maximum": 3, "type": "integer", "description": "1 for standard screens, 2 for crisp Retina-quality images, 3 for the sharpest detail.", "default": 1 }, "quality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Image quality for JPEG files, from 1 to 100. 80 is a great balance of size and sharpness.", "default": 80 }, "closeCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Dismiss cookie consent pop-ups so they don't cover the page.", "default": true }, "blockAds": { "title": "Hide ads and pop-ups", "type": "boolean", "description": "Remove ads, newsletter pop-ups, and chat widgets for a clean, distraction-free shot.", "default": true }, "hideSelectors": { "title": "Hide these elements", "type": "array", "description": "Anything else to remove, by its CSS selector, like .promo-bar or #chat-widget.", "items": { "type": "string" } }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Show the page in dark mode on sites that support it.", "default": false }, "disableAnimations": { "title": "Freeze animations", "type": "boolean", "description": "Pause animations, background videos, and blinking cursors so every screenshot comes out sharp, consistent, and fast.", "default": true }, "transparentBackground": { "title": "Transparent background", "type": "boolean", "description": "PNG only. Keeps the background see-through on pages that don't paint one. Great for logos and widgets.", "default": false }, "elementSelector": { "title": "Capture one element", "type": "string", "description": "Capture a single part of the page instead of the whole thing, like #pricing or .hero. In Chrome: right-click it, Inspect, then Copy → Copy selector." }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as ready. \"Network is quiet\" waits for late-loading images and data.", "default": "load" }, "waitForSelector": { "title": "Wait for element", "type": "string", "description": "Wait until this part of the page shows up before capturing, like .product-grid." }, "delayMs": { "title": "Extra wait", "minimum": 0, "maximum": 120000, "type": "integer", "description": "Extra time to wait just before capturing, for slow charts, maps, or videos.", "default": 0 }, "scrollToBottom": { "title": "Scroll to load everything", "type": "boolean", "description": "Keep scrolling until pages that load more as you scroll, like feeds and endless lists, stop growing. Lazy-loaded images in full-page shots, single elements, and PDFs are filled in either way.", "default": false }, "pageLoadTimeoutSecs": { "title": "Page load timeout", "minimum": 5, "maximum": 300, "type": "integer", "description": "How long to give each page to load. Raise it for very slow sites.", "default": 60 }, "cookies": { "title": "Cookies", "type": "array", "description": "Capture pages as a logged-in visitor. Export your cookies with a browser extension like Cookie-Editor and paste the JSON here." }, "locale": { "title": "Language", "type": "string", "description": "Browser language, like de-DE or fr-FR. Sites that adapt to your language will show it." }, "timezone": { "title": "Time zone", "type": "string", "description": "Browser time zone, like Europe/Paris or America/New_York. Dates and times on the page follow it." }, "headers": { "title": "Extra HTTP headers", "type": "object", "description": "Extra information sent with every page visit, like {\"Accept-Language\": \"de-DE\"}." }, "userAgent": { "title": "User agent", "type": "string", "description": "Leave empty to match the chosen device. Set it only when a site needs a specific browser." }, "customCss": { "title": "Custom CSS", "type": "string", "description": "Restyle the page before capturing, like body { font-size: 18px; }." }, "customScript": { "title": "Custom JavaScript", "type": "string", "description": "Code that runs on the page before capturing, like clicking a tab or opening a menu. You can use await." }, "pdfPaperFormat": { "title": "PDF paper size", "enum": [ "A4", "A3", "A5", "Letter", "Legal", "Tabloid" ], "type": "string", "description": "Page size for PDF files.", "default": "A4" }, "pdfLandscape": { "title": "Landscape", "type": "boolean", "description": "Lay PDF pages out sideways.", "default": false }, "pdfPrintBackground": { "title": "Include backgrounds", "type": "boolean", "description": "Keep background colors and images in the PDF, just like on screen.", "default": true } } }, "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 } } } } } } } } } }