{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & PDF - Reliable Capture", "description": "Capture full-page or viewport screenshots (PNG/JPEG) and PDFs of any URL. Waits for the page to settle, dismisses cookie banners, supports device presets and custom waits. Pay only for successful captures.", "version": "0.1", "x-build-id": "BAGe5xVC2hIKFv5ua" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/amazing_wizdom~web-screenshot-capture/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-amazing_wizdom-web-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/amazing_wizdom~web-screenshot-capture/runs": { "post": { "operationId": "runs-sync-amazing_wizdom-web-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/amazing_wizdom~web-screenshot-capture/run-sync": { "post": { "operationId": "run-sync-amazing_wizdom-web-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": [ "url" ], "properties": { "url": { "title": "URL to capture", "type": "string", "description": "The page to screenshot or render to PDF. Include the protocol (https://). Public URLs only.", "default": "https://example.com" }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "png (lossless), jpeg (smaller), or pdf (paginated document).", "default": "png" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the entire scrollable page (PNG/JPEG). Ignored for PDF.", "default": true }, "device": { "title": "Device / viewport", "enum": [ "desktop_1920", "desktop_1366", "iphone", "ipad", "custom" ], "type": "string", "description": "Preset viewport. Choose 'custom' to set width/height below.", "default": "desktop_1920" }, "width": { "title": "Custom width (px)", "minimum": 200, "maximum": 4000, "type": "integer", "description": "Viewport width when device = custom." }, "height": { "title": "Custom height (px)", "minimum": 200, "maximum": 4000, "type": "integer", "description": "Viewport height when device = custom." }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When to consider the page ready: load (all resources), domcontentloaded (fast), or networkidle (best for JS-heavy sites).", "default": "load" }, "waitForSelector": { "title": "Wait for selector", "type": "string", "description": "Optional CSS selector to wait for before capturing (e.g. a chart or main content)." }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Extra wait after the page is ready, for late animations. Max 30000.", "default": 0 }, "dismissCookieBanners": { "title": "Dismiss cookie banners", "type": "boolean", "description": "Attempt to auto-close common cookie / consent banners before capturing.", "default": true }, "jpegQuality": { "title": "JPEG quality (1-100)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Only used when format = jpeg.", "default": 80 }, "maxFullPageHeightPx": { "title": "Max full-page height (px)", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Fail instead of capturing full pages taller than this (protects memory). Default 20000.", "default": 20000 }, "failOnHttpError": { "title": "Fail on HTTP 4xx/5xx", "type": "boolean", "description": "By default the actor captures error pages too (and reports the status). Enable to fail instead so you are not charged for a 404/403 page.", "default": false }, "headers": { "title": "Custom HTTP headers", "type": "object", "description": "Optional headers sent with the request (e.g. Authorization or a custom User-Agent). Stored encrypted." }, "cookies": { "title": "Cookies", "type": "array", "description": "Optional cookies for capturing pages behind a login. Array of Playwright cookie objects. Stored encrypted." } } }, "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 } } } } } } } } } }