{ "openapi": "3.0.1", "info": { "title": "Website Screenshot Generator", "description": "Capture screenshots of any website using Playwright headless browser. Full-page or viewport capture. Supports batch mode (up to 50 URLs), device presets (desktop/tablet/mobile), CSS selector targeting, PNG/JPEG/WebP output.", "version": "1.0", "x-build-id": "6vOuQsDRAfIZr9dKz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/perryay~website-screenshot-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-perryay-website-screenshot-generator", "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/perryay~website-screenshot-generator/runs": { "post": { "operationId": "runs-sync-perryay-website-screenshot-generator", "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/perryay~website-screenshot-generator/run-sync": { "post": { "operationId": "run-sync-perryay-website-screenshot-generator", "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": "Single URL", "type": "string", "description": "URL of the website to screenshot (required when batchMode is false)." }, "batchData": { "title": "Batch Data", "type": "array", "description": "Array of objects for batch screenshot capture (max 50). Each object supports: url (required), device, fullPage, delay, cssSelector, width, height, format, quality.", "default": [] }, "batchMode": { "title": "Batch Mode", "type": "boolean", "description": "Enable batch processing mode. When true, provide batchData array. When false, provide a single url.", "default": false }, "device": { "title": "Device Preset", "enum": [ "desktop", "tablet", "mobile" ], "type": "string", "description": "Device preset for viewport dimensions. Overridden by custom width/height. Defaults to desktop if not set.", "default": "desktop" }, "fullPage": { "title": "Full Page Capture", "type": "boolean", "description": "Capture the full scrollable page height (true) or just the visible viewport (false).", "default": false }, "delay": { "title": "Capture Delay (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Delay in milliseconds to wait before capturing the screenshot. Useful for pages with animations or lazy-loaded content. Max: 60000ms (60s).", "default": 0 }, "width": { "title": "Custom Viewport Width (px)", "minimum": 320, "maximum": 7680, "type": "integer", "description": "Custom viewport width in pixels. Overrides device preset. Min: 320, Max: 7680." }, "height": { "title": "Custom Viewport Height (px)", "minimum": 240, "maximum": 4320, "type": "integer", "description": "Custom viewport height in pixels. Overrides device preset. Min: 240, Max: 4320." }, "cssSelector": { "title": "CSS Selector", "type": "string", "description": "CSS selector to target a specific element on the page. Only this element will be captured in the screenshot. Example: '#main-content', '.hero-banner', 'img.hero-logo'." }, "format": { "title": "Image Format", "enum": [ "png", "jpeg", "webp" ], "type": "string", "description": "Output image format. PNG (lossless, default), JPEG (lossy, smaller files), WebP (modern, efficient compression).", "default": "png" }, "quality": { "title": "Image Quality (JPEG/WebP)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Quality level for lossy formats (JPEG, WebP). 1 = lowest quality/smallest file, 100 = highest quality/largest file. Ignored for PNG format." } } }, "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 } } } } } } } } } }