{ "openapi": "3.0.1", "info": { "title": "Website Screenshot Generator", "description": "Capture public webpages in batches as PNG or JPEG with viewport, full-page, image, timing, and navigation metadata for visual QA and archiving.", "version": "0.1", "x-build-id": "onGFNDK9LvoHTa0NX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~website-screenshot-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-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/automation-lab~website-screenshot-generator/runs": { "post": { "operationId": "runs-sync-automation-lab-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/automation-lab~website-screenshot-generator/run-sync": { "post": { "operationId": "run-sync-automation-lab-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Webpage URLs", "type": "array", "description": "Public HTTP(S) webpages to capture. Each URL produces one metadata record and, when successful, one image in the run's key-value store.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "viewportWidth": { "title": "Viewport width", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Browser viewport width in CSS pixels.", "default": 1440 }, "viewportHeight": { "title": "Viewport height", "minimum": 240, "maximum": 2160, "type": "integer", "description": "Browser viewport height in CSS pixels.", "default": 900 }, "deviceScaleFactor": { "title": "Device scale factor", "minimum": 1, "maximum": 3, "type": "number", "description": "Output pixel density. Use 2 for high-resolution captures; higher values create larger images.", "default": 1 }, "fullPage": { "title": "Capture full page", "type": "boolean", "description": "Capture the entire scrollable page instead of only the visible viewport.", "default": true }, "format": { "title": "Image format", "enum": [ "png", "jpeg" ], "type": "string", "description": "PNG preserves exact pixels; JPEG usually produces smaller files.", "default": "png" }, "quality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "JPEG quality from 1 to 100. Ignored for PNG captures.", "default": 85 }, "waitUntil": { "title": "Page readiness condition", "enum": [ "load", "domcontentloaded", "networkidle", "commit" ], "type": "string", "description": "Browser navigation milestone to wait for before the optional delay and capture.", "default": "domcontentloaded" }, "delayMs": { "title": "Additional delay (milliseconds)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Extra wait after the readiness condition, useful for animations or delayed widgets.", "default": 0 }, "navigationTimeoutSecs": { "title": "Navigation timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum time to wait for each page navigation.", "default": 45 }, "userAgent": { "title": "Custom user agent", "minLength": 1, "maxLength": 500, "type": "string", "description": "Optional browser User-Agent header. Leave empty to use the maintained Chromium default." }, "hideSelectors": { "title": "CSS selectors to hide", "maxItems": 50, "type": "array", "description": "Optional CSS selectors for banners or overlays to make invisible before capture (maximum 50).", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Maximum screenshots", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of supplied URLs processed in one run.", "default": 20 } } }, "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 } } } } } } } } } }