{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & URL/HTML to PDF: Full Page, Mobile, Bulk", "description": "Capture full-page or viewport screenshots of websites (PNG, JPEG, WebP) and save web pages or raw HTML as PDF. Desktop, laptop, tablet and phone devices, dark mode, element screenshots, cookie banners hidden, lazy images loaded.", "version": "0.1", "x-build-id": "U8RVzqZBHAd13iHMk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ai_admin~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ai_admin-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/ai_admin~website-screenshot/runs": { "post": { "operationId": "runs-sync-ai_admin-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/ai_admin~website-screenshot/run-sync": { "post": { "operationId": "run-sync-ai_admin-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": "URLs", "type": "array", "description": "Web pages to capture. \"example.com\" without https:// works too.", "default": [ { "url": "https://apify.com" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "html": { "title": "Raw HTML (optional)", "type": "string", "description": "HTML to render instead of (or in addition to) URLs — e.g. an invoice or report template to turn into PDF. External images and styles referenced by absolute https URLs are loaded." }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "webp", "pdf" ], "type": "string", "description": "png, jpeg, webp — screenshot; pdf — printable PDF of the page.", "default": "png" }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile", "android" ], "type": "string", "description": "desktop 1920×1080, laptop 1366×768, tablet iPad Pro 11, mobile iPhone 15 Pro, android Galaxy S24 (phones and tablets at their real pixel density).", "default": "desktop" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page (up to 20,000 px high), not just the first screen.", "default": true }, "selector": { "title": "Element (CSS selector)", "type": "string", "description": "Capture only this element, e.g. #pricing or .chart. Empty = whole page." }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide floating cookie and consent banners (OneTrust, Cookiebot, Didomi and similar).", "default": true }, "scrollToBottom": { "title": "Load lazy images", "type": "boolean", "description": "Scroll through the page before capturing so lazy-loaded images appear.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "networkidle", "domcontentloaded" ], "type": "string", "description": "load = page and images loaded (default); networkidle = no network activity for 0.5 s (single-page apps); domcontentloaded = fastest.", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait this long before capturing (animations, charts).", "default": 0 }, "viewportWidth": { "title": "Viewport width (desktop/laptop)", "minimum": 0, "maximum": 3840, "type": "integer", "description": "Custom width in pixels; 0 = device default.", "default": 0 }, "viewportHeight": { "title": "Viewport height (desktop/laptop)", "minimum": 0, "maximum": 3000, "type": "integer", "description": "Custom height in pixels; 0 = device default.", "default": 0 }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the site for its dark theme (prefers-color-scheme: dark).", "default": false }, "quality": { "title": "JPEG/WebP quality", "minimum": 10, "maximum": 100, "type": "integer", "description": "10 (smallest) to 100 (best).", "default": 85 }, "css": { "title": "Custom CSS (optional)", "type": "string", "description": "Injected before capturing, e.g. to hide chat widgets: .intercom-launcher{display:none!important}" }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3", "A5" ], "type": "string", "description": "For PDF output.", "default": "A4" }, "pdfLandscape": { "title": "PDF landscape", "type": "boolean", "description": "For PDF output.", "default": false }, "pdfScreenMedia": { "title": "PDF looks like the screen", "type": "boolean", "description": "Off = the site's print styles (clean, no menus); on = exactly as on screen.", "default": false }, "pdfMargin": { "title": "PDF margin", "type": "string", "description": "e.g. 0, 10mm, 0.5in", "default": "10mm" }, "timeoutSecs": { "title": "Page timeout (s)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Give up on a page that does not load in this time (not charged).", "default": 60 } } }, "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 } } } } } } } } } }