{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API: Full Page, Mobile & URL to PDF", "description": "Take full-page website screenshots in bulk: desktop or mobile, element capture, PNG, JPEG, WebP and URL to PDF, with cookie banners hidden. $1.50 per 1,000 screenshots.", "version": "0.1", "x-build-id": "TTUQIWJ6eYdgA4EiR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gmyri~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gmyri-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/gmyri~website-screenshot/runs": { "post": { "operationId": "runs-sync-gmyri-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/gmyri~website-screenshot/run-sync": { "post": { "operationId": "run-sync-gmyri-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", "type": "array", "description": "Public web pages to capture. One screenshot per URL. Use full URLs (https://...).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "format": { "title": "Image format", "enum": [ "png", "jpeg", "webp" ], "type": "string", "description": "Output image format. JPEG and WebP use the quality setting.", "default": "png" }, "fullPage": { "title": "Full-page screenshot", "type": "boolean", "description": "Capture the whole scrollable page instead of just the visible viewport.", "default": true }, "device": { "title": "Device preset", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "type": "string", "description": "Viewport size, pixel density and user agent. Override the size with the viewport fields below.", "default": "desktop" }, "viewportWidth": { "title": "Viewport width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Optional. Overrides the device preset width." }, "viewportHeight": { "title": "Viewport height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Optional. Overrides the device preset height." }, "selector": { "title": "Element selector (optional)", "type": "string", "description": "CSS selector of a single element to capture (e.g. '#pricing' or 'main'). Leave empty for the page." }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common cookie/consent banners (OneTrust, Cookiebot, Didomi, Usercentrics, Quantcast and more) with CSS. Nothing is clicked or accepted.", "default": true }, "hideSelectors": { "title": "Extra selectors to hide", "type": "array", "description": "CSS selectors to hide before capturing, e.g. chat widgets or sticky headers.", "items": { "type": "string" } }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Page-load event to wait for before capturing. 'networkidle' is best for heavy single-page apps but slower.", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Extra wait after loading, for animations and late content.", "default": 1000 }, "scrollToBottom": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scroll through the page before a full-page capture so lazy-loaded images appear.", "default": true }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Emulate prefers-color-scheme: dark.", "default": false }, "quality": { "title": "JPEG/WebP quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1-100. Ignored for PNG.", "default": 80 }, "maxHeightPx": { "title": "Max full-page height (px)", "minimum": 500, "maximum": 30000, "type": "integer", "description": "Very long pages are cut at this height (CSS pixels) to keep files usable.", "default": 15000 }, "savePdf": { "title": "Also save as PDF", "type": "boolean", "description": "Also print each page to PDF (charged as a separate 'PDF generated' event).", "default": false }, "pdfFormat": { "title": "PDF paper format", "enum": [ "A4", "Letter", "Legal", "A3", "Tabloid" ], "type": "string", "description": "Paper size when 'Also save as PDF' is on.", "default": "A4" }, "timeoutSecs": { "title": "Page timeout (s)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Maximum time to load and capture one page.", "default": 45 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages captured in parallel. Keep low (1-3) with 1-2 GB of memory.", "default": 3 } } }, "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 } } } } } } } } } }