{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API — Full Page, Mobile, PDF, No Login", "description": "Website screenshot API for URL lists: full page or first screen, desktop/tablet/phone presets, PNG/JPEG/WebP/PDF, dark mode, cookie-banner and ad hiding, wait/scroll/selector/clip controls. Image URL, final URL, status and SHA-256 per row. Pay per capture.", "version": "0.1", "x-build-id": "OheUghkiAghbhCMAn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgenwatch~website-screenshot-evidence-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgenwatch-website-screenshot-evidence-api", "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/nexgenwatch~website-screenshot-evidence-api/runs": { "post": { "operationId": "runs-sync-nexgenwatch-website-screenshot-evidence-api", "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/nexgenwatch~website-screenshot-evidence-api/run-sync": { "post": { "operationId": "run-sync-nexgenwatch-website-screenshot-evidence-api", "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": "Page URLs (website screenshot targets)", "type": "array", "description": "Page URLs to capture, one per line (http/https). Up to maxUrls per run (max 100). Each URL is checked against robots.txt before the browser opens it.", "items": { "type": "string" }, "default": [ "https://example.com/" ] }, "url": { "title": "Single URL", "type": "string", "description": "Convenience field for one page (added in front of urls)." }, "device": { "title": "Device preset", "enum": [ "desktop", "laptop", "desktop-hd", "tablet", "mobile", "iphone", "android" ], "type": "string", "description": "Viewport, pixel density and touch emulation: desktop 1280×800, laptop 1366×768, desktop-hd 1920×1080, tablet 768×1024 @2x, mobile/iphone 390×844 @3x, android 412×915 @2.6x. Override with width/height/deviceScaleFactor.", "default": "desktop" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scroll height instead of the first screen.", "default": false }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "webp", "pdf" ], "type": "string", "description": "png (lossless), jpeg or webp (use quality), or pdf (the page printed to PDF with backgrounds).", "default": "png" }, "quality": { "title": "JPEG/WebP quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1-100, used for jpeg and webp only.", "default": 80 }, "width": { "title": "Viewport width (px)", "minimum": 200, "maximum": 4000, "type": "integer", "description": "Overrides the device preset (200-4000)." }, "height": { "title": "Viewport height (px)", "minimum": 200, "maximum": 4000, "type": "integer", "description": "Overrides the device preset (200-4000). Ignored for the height of a full-page capture." }, "deviceScaleFactor": { "title": "Pixel density", "minimum": 1, "maximum": 3, "type": "integer", "description": "1 = normal, 2 or 3 = retina-sharp captures (bigger files)." }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle", "commit" ], "type": "string", "description": "When the page counts as loaded: load (default), domcontentloaded (fastest), networkidle (slowest, best for apps), commit.", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Wait this long after load before capturing (0-15000), for animations and late scripts.", "default": 0 }, "timeoutMs": { "title": "Navigation timeout (ms)", "minimum": 3000, "maximum": 90000, "type": "integer", "description": "Give up on a page after this long (3000-90000). A timed-out page is delivered as unreachable and not billed.", "default": 30000 }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Optional CSS selector that must appear before capturing (e.g. #main). Not found → a warning on the row, capture proceeds." }, "scrollToBottom": { "title": "Scroll to bottom first", "type": "boolean", "description": "Scroll through the page before capturing so lazy-loaded images and sections render (use with fullPage).", "default": false }, "delayAfterScrollingMs": { "title": "Delay after scrolling (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Pause after the scroll pass (0-15000).", "default": 1500 }, "selector": { "title": "Element selector", "type": "string", "description": "Capture only the first element matching this CSS selector (e.g. .pricing-table). No match → unreachable row, not billed." }, "hideSelectors": { "title": "Hide elements", "type": "array", "description": "CSS selectors hidden before capture (chat widgets, banners, popups).", "default": [], "items": { "type": "string" } }, "clip": { "title": "Clip region", "type": "object", "description": "Capture a fixed rectangle: {\"x\":0,\"y\":0,\"width\":800,\"height\":600} in CSS pixels." }, "colorScheme": { "title": "Color scheme", "enum": [ "light", "dark", "no-preference" ], "type": "string", "description": "Emulate the site's light or dark mode.", "default": "light" }, "locale": { "title": "Locale", "type": "string", "description": "Browser locale, e.g. en-US, de-DE (affects language and formats on many sites)." }, "timezoneId": { "title": "Timezone", "type": "string", "description": "IANA timezone for the page, e.g. America/Vancouver." }, "blockCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common consent/cookie banners by CSS before capturing (nothing is clicked or accepted).", "default": false }, "blockAds": { "title": "Block ads", "type": "boolean", "description": "Abort requests to well-known ad and tracking hosts so the capture is not covered by ads.", "default": false }, "blockImages": { "title": "Block images", "type": "boolean", "description": "Skip image and media downloads (faster, text-only captures).", "default": false }, "customCss": { "title": "Custom CSS", "type": "string", "description": "CSS injected before capture (e.g. to hide a sticky header)." }, "omitBackground": { "title": "Transparent background", "type": "boolean", "description": "Omit the default white background (PNG/WebP), for transparent captures.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional Apify Proxy for sites that block data-centre IPs: {\"useApifyProxy\": true, \"apifyProxyGroups\": [\"RESIDENTIAL\"], \"apifyProxyCountry\": \"US\"}. Off by default.", "default": { "useApifyProxy": false } }, "maxUrls": { "title": "Max URLs", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum URLs captured and billed per run (1-100).", "default": 10 }, "userAgent": { "title": "User agent", "type": "string", "description": "User-Agent string sent by the browser. Default identifies NexGenWatchBot with a contact URL." }, "viewport": { "title": "Viewport preset", "enum": [ "desktop", "mobile", "full" ], "type": "string", "description": "Older preset field, still accepted: desktop, mobile or full (full = desktop size, whole page). Prefer `device` and `fullPage`.", "default": "desktop" } } }, "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 } } } } } } } } } }