{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API: Full Page, Mobile & PDF (Bulk)", "description": "Screenshot any list of web pages: full page or first screen, desktop, tablet or mobile, PNG, JPEG or PDF. Lazy images loaded, cookie banners hidden. Pay only for screenshots that succeed.", "version": "1.0", "x-build-id": "f79uxMDhOerVgi9Q6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/prometheus-maker~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-prometheus-maker-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/prometheus-maker~website-screenshot/runs": { "post": { "operationId": "runs-sync-prometheus-maker-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/prometheus-maker~website-screenshot/run-sync": { "post": { "operationId": "run-sync-prometheus-maker-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", "required": [ "urls" ], "properties": { "urls": { "title": "Web pages", "type": "array", "description": "One URL per line, e.g. https://example.com or python.org.", "items": { "type": "string" } }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "desktop-hd", "tablet", "mobile", "mobile-android" ], "type": "string", "description": "Screen size and type to capture as.", "default": "desktop" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole page down to the bottom. Off = only the first screen.", "default": true }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG is sharp, JPEG is smaller, PDF is a printable document of the page.", "default": "png" }, "quality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1-100, only for JPEG.", "default": 80 }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide cookie and consent banners of common consent tools, and small fixed boxes about cookies. Nothing is clicked or accepted. Full-screen consent walls are left as they are.", "default": true }, "hideSelectors": { "title": "Hide elements", "type": "array", "description": "CSS selectors of anything else to hide, e.g. .chat-widget or #newsletter-popup.", "default": [], "items": { "type": "string" } }, "selector": { "title": "Capture only this element", "type": "string", "description": "CSS selector of one element to capture instead of the page, e.g. #pricing." }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded. 'networkidle' waits for background requests to stop (slower, more complete).", "default": "load" }, "waitForSelector": { "title": "Wait for element", "type": "string", "description": "Optional CSS selector to wait for before capturing." }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Wait this long after loading, e.g. for animations. Max 20000.", "default": 0 }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the page for its dark color scheme.", "default": false }, "width": { "title": "Custom width", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Override the device width in pixels." }, "height": { "title": "Custom height", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Override the device height in pixels (the first-screen size)." }, "timeoutSecs": { "title": "Page timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Give up on a page after this long.", "default": 30 }, "maxConcurrency": { "title": "Pages in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "Screenshots taken at the same time. Default: one per 2 GB of the run's memory (2 at the default 4 GB); maximum one per GB. More at once is not faster on heavy pages: they share the run's CPU." } } }, "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 } } } } } } } } } }