{ "openapi": "3.0.1", "info": { "title": "Website Screenshot Capture", "description": "30+ device presets, full-page capture, dark mode, cookie banner blocking and batch processing for pixel-perfect website screenshots. Supports iPhone, iPad, Android, Desktop, and up to 100 URLs per run.", "version": "1.0", "x-build-id": "15sAMOA8ABfaMhVj6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/allscreenshots~website-screenshot-capture/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-allscreenshots-website-screenshot-capture", "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/allscreenshots~website-screenshot-capture/runs": { "post": { "operationId": "runs-sync-allscreenshots-website-screenshot-capture", "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/allscreenshots~website-screenshot-capture/run-sync": { "post": { "operationId": "run-sync-allscreenshots-website-screenshot-capture", "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": [ "apiKey" ], "properties": { "apiKey": { "title": "API Key", "type": "string", "description": "Your AllScreenshots API key. Sign up free at https://dashboard.allscreenshots.com/signup to get your key." }, "urls": { "title": "URLs to Screenshot", "type": "array", "description": "One or more URLs to capture. Supports up to 100 URLs per run.", "items": { "type": "string" } }, "devicePreset": { "title": "Device Preset", "enum": [ "", "desktop-hd", "desktop-large", "desktop-retina", "laptop", "laptop-retina", "iphone-se", "iphone-xr", "iphone-12", "iphone-12-pro-max", "iphone-14", "iphone-14-pro-max", "iphone-15", "iphone-15-pro-max", "ipad", "ipad-pro-11", "ipad-pro-12-9", "ipad-mini", "pixel-5", "pixel-7", "pixel-7-pro", "galaxy-s21", "galaxy-s23", "galaxy-tab-s7", "surface-pro-7", "facebook-og", "twitter-card", "linkedin-post", "instagram-square", "instagram-portrait", "instagram-story" ], "type": "string", "description": "Choose a pre-configured device or leave empty for custom viewport.", "default": "" }, "fullPage": { "title": "Full Page Screenshot", "type": "boolean", "description": "Capture the entire scrollable page, not just the viewport", "default": false }, "blockCookieBanners": { "title": "Block Cookie Banners", "type": "boolean", "description": "Automatically dismiss or hide cookie consent banners", "default": true }, "darkMode": { "title": "Dark Mode", "type": "boolean", "description": "Force dark mode/theme if the website supports prefers-color-scheme", "default": false }, "viewportWidth": { "title": "Viewport Width", "minimum": 100, "maximum": 4096, "type": "integer", "description": "Custom viewport width in pixels. Ignored when Device Preset is selected.", "default": 1920 }, "viewportHeight": { "title": "Viewport Height", "minimum": 100, "maximum": 4096, "type": "integer", "description": "Custom viewport height in pixels. Ignored when Device Preset is selected.", "default": 1080 }, "deviceScaleFactor": { "title": "Device Scale Factor", "minimum": 1, "maximum": 3, "type": "integer", "description": "Pixel density multiplier. Use 2 for Retina/HiDPI displays.", "default": 1 }, "format": { "title": "Output Format", "enum": [ "png", "jpeg", "webp", "pdf" ], "type": "string", "description": "Image format for the screenshot", "default": "png" }, "quality": { "title": "Image Quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Compression quality 1-100. Only applies to JPEG and WebP formats.", "default": 90 }, "delay": { "title": "Delay Before Capture", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait this many milliseconds after page load before taking screenshot", "default": 0 }, "waitFor": { "title": "Wait for Selector", "type": "string", "description": "CSS selector to wait for before capturing (e.g., '#content', '.loaded')" }, "waitUntil": { "title": "Wait Until Event", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Browser event to wait for before capturing", "default": "load" }, "timeout": { "title": "Page Timeout", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Maximum time to wait for page to load", "default": 30000 }, "customCss": { "title": "Custom CSS", "type": "string", "description": "Inject custom CSS before capturing. Use to hide elements or change styles." }, "hideSelectors": { "title": "Hide Elements", "type": "array", "description": "CSS selectors of elements to hide before capture", "items": { "type": "string" } }, "selector": { "title": "Capture Specific Element", "type": "string", "description": "CSS selector of element to capture instead of full page (e.g., '#main-content')" }, "outputToDataset": { "title": "Save to Dataset", "type": "boolean", "description": "Save screenshot metadata and URLs to the Actor's dataset for export", "default": true }, "outputToKeyValueStore": { "title": "Save to Key-Value Store", "type": "boolean", "description": "Save screenshot binary files to the Actor's key-value store", "default": true }, "fileNamePattern": { "title": "File Name Pattern", "type": "string", "description": "Pattern for screenshot file names. Placeholders: {domain}, {timestamp}, {index}, {format}", "default": "{domain}_{timestamp}.{format}" }, "url": { "title": "Single URL (Alternative)", "type": "string", "description": "Single URL to screenshot. Use 'URLs' field above for multiple URLs." } } }, "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 } } } } } } } } } }