{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API: Bulk, Full Page, Mobile & PDF", "description": "Website screenshot tool and API: bulk URLs to PNG, JPEG or PDF, full-page or element capture, device presets, cookie banners hidden. Failed URLs are never charged.", "version": "1.0", "x-build-id": "nz53dYwJdlNQVGuY9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/altronite~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-altronite-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/altronite~website-screenshot/runs": { "post": { "operationId": "runs-sync-altronite-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/altronite~website-screenshot/run-sync": { "post": { "operationId": "run-sync-altronite-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": "URLs", "maxItems": 1000, "type": "array", "description": "Pages to capture, one per line. A missing scheme defaults to https://. Up to 1,000 per run.", "default": [ "https://apify.com" ], "items": { "type": "string" } }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile", "custom" ], "type": "string", "description": "Desktop 1920×1080, laptop 1366×768, tablet 810×1080 (2x), mobile 390×844 (3x), or custom (set the viewport below).", "default": "desktop" }, "viewportWidth": { "title": "Custom viewport width", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Used only when Device is Custom.", "default": 1280 }, "viewportHeight": { "title": "Custom viewport height", "minimum": 200, "maximum": 2160, "type": "integer", "description": "Used only when Device is Custom.", "default": 800 }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of the visible viewport.", "default": false }, "selector": { "title": "Element selector", "type": "string", "description": "Optional CSS selector, e.g. `#main`. When set, only that element is captured (PNG/JPEG)." }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG (lossless), JPEG (smaller, quality below) or PDF (printable, full page).", "default": "png" }, "quality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1–100, JPEG only.", "default": 80 }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded. Network idle is safest for heavy single-page apps but slower.", "default": "load" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Optional CSS selector that must be visible before capturing, e.g. `#main`." }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Extra wait after load, e.g. for animations. Max 30,000 ms.", "default": 0 }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common consent pop-ups with CSS. Nothing is clicked or accepted.", "default": true }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the page for its dark colour scheme (prefers-color-scheme: dark).", "default": false }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip URLs the site's robots.txt disallows. Turn off only for pages you have the right to capture.", "default": true }, "timeoutSecs": { "title": "Page timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Per navigation, selector wait and image capture step. Navigation and capture failures are retried once; missing selectors are not retried.", "default": 45 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 7, "type": "integer", "description": "Pages captured at the same time. Raise memory with it (about 512 MB per page).", "default": 3 }, "chargeHttpErrors": { "title": "Capture HTTP error pages", "type": "boolean", "description": "Capture and charge pages with HTTP status 400 or higher. Bot checks are always uncharged errors.", "default": false }, "scrollToLoad": { "title": "Scroll to load images", "type": "boolean", "description": "Before PNG/JPEG capture, scroll toward the bottom and back to the top, at most 20 steps / about 5 seconds. Does not apply to PDF.", "default": true } } }, "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 } } } } } } } } } }