{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API - Page Screenshot Generator", "description": "Website screenshot API to capture any webpage as an image. This screenshot API supports full page, viewport, and element screenshots. Website screenshot generator API for automated website screenshot capture, visual testing, monitoring, and thumbnail generation. Reliable page screenshot API.", "version": "0.0", "x-build-id": "2j3esykc86A2tRsvN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/code-node-tools~website-screenshot-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-code-node-tools-website-screenshot-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/code-node-tools~website-screenshot-api/runs": { "post": { "operationId": "runs-sync-code-node-tools-website-screenshot-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/code-node-tools~website-screenshot-api/run-sync": { "post": { "operationId": "run-sync-code-node-tools-website-screenshot-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", "properties": { "url": { "title": "URL", "type": "string", "description": "URL of the webpage to screenshot" }, "urls": { "title": "URLs (Batch)", "type": "array", "description": "Multiple URLs for batch screenshot capture", "items": { "type": "string" } }, "screenshotType": { "title": "Screenshot Type", "enum": [ "fullPage", "viewport", "element" ], "type": "string", "description": "Type of screenshot to capture", "default": "fullPage" }, "selector": { "title": "Element Selector", "type": "string", "description": "CSS selector for element screenshot (only used when screenshotType is 'element')" }, "format": { "title": "Image Format", "enum": [ "png", "jpeg" ], "type": "string", "description": "Output image format", "default": "png" }, "quality": { "title": "JPEG Quality", "minimum": 0, "maximum": 100, "type": "integer", "description": "JPEG quality (0-100, ignored for PNG)", "default": 90 }, "width": { "title": "Viewport Width", "type": "integer", "description": "Viewport width in pixels", "default": 1920 }, "height": { "title": "Viewport Height", "type": "integer", "description": "Viewport height in pixels", "default": 1080 }, "deviceScaleFactor": { "title": "Device Scale Factor", "type": "number", "description": "Device scale factor (1 = normal, 2 = retina)", "default": 1 }, "isMobile": { "title": "Mobile Emulation", "type": "boolean", "description": "Emulate mobile device", "default": false }, "waitForSelector": { "title": "Wait for Selector", "type": "string", "description": "CSS selector to wait for before taking screenshot" }, "waitForTimeout": { "title": "Wait Timeout (ms)", "type": "integer", "description": "Additional wait time in milliseconds before screenshot", "default": 0 }, "waitUntil": { "title": "Wait Until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Wait until page reaches this state", "default": "load" }, "removeElements": { "title": "Remove Elements", "type": "array", "description": "CSS selectors of elements to remove before screenshot (e.g., cookie banners)", "items": { "type": "string" } }, "scrollToBottom": { "title": "Scroll to Bottom", "type": "boolean", "description": "Scroll to bottom to trigger lazy loading before screenshot", "default": false }, "darkMode": { "title": "Dark Mode", "type": "boolean", "description": "Enable dark mode if site supports it", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for the browser" } } }, "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 } } }, "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 } } } } } } } } } }