{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API — Clean, No Popups", "description": "Clean, full-page screenshots of up to 500 websites per run. Cookie banners, popups and chat bubbles are hidden, lazy images are loaded, and endless pages are handled. Every link gets a clear result, and every failure is explained in plain words.", "version": "0.1", "x-build-id": "OrNGKoull2gEGBlL3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spellzarr~website-screenshot-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spellzarr-website-screenshot-api", "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/spellzarr~website-screenshot-api/runs": { "post": { "operationId": "runs-sync-spellzarr-website-screenshot-api", "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/spellzarr~website-screenshot-api/run-sync": { "post": { "operationId": "run-sync-spellzarr-website-screenshot-api", "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", "properties": { "urls": { "title": "Website links", "minItems": 1, "maxItems": 500, "type": "array", "description": "One link per line, 1 to 500 links. We add https:// if it is missing and remove duplicates.", "items": { "type": "string", "maxLength": 2048 }, "default": [ "https://example.com" ] }, "device": { "title": "Device", "enum": [ "laptop", "phone" ], "type": "string", "description": "Laptop = 1440 x 900. Phone = 390 x 844, sharp (2x), mobile layout.", "default": "laptop" }, "capture": { "title": "Capture", "enum": [ "fullPage", "topOnly" ], "type": "string", "description": "Full page = the whole page from top to bottom. Top only = what you see first, without scrolling.", "default": "fullPage" }, "devicePreset": { "title": "Size and view: Device preset", "enum": [ "none", "iphone", "android", "ipad", "laptop", "bigMonitor" ], "type": "string", "description": "Pick a ready-made device. Overrides the Device field above. None = use the Device field.", "default": "none" }, "customWidth": { "title": "Size and view: Custom width", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Screen width in pixels (320 to 3840). Fill in width and height together. Overrides the Device preset." }, "customHeight": { "title": "Size and view: Custom height", "minimum": 320, "maximum": 2160, "type": "integer", "description": "Screen height in pixels (320 to 2160). Fill in width and height together." }, "sharp2x": { "title": "Size and view: 2x sharp mode", "type": "boolean", "description": "Makes the image twice as sharp (and twice as big). Only allowed when the width is 1920 or less.", "default": false }, "captureMode": { "title": "Capture: Capture mode", "enum": [ "useMain", "visible", "fullPage", "topN", "element" ], "type": "string", "description": "Overrides the Capture field above. Use main field = keep what you picked above.", "default": "useMain" }, "topNPx": { "title": "Capture: Top N px", "minimum": 100, "maximum": 30000, "type": "integer", "description": "Used when Capture mode is Top N px. How many pixels from the top (100 to 30000).", "default": 3000 }, "elementSelector": { "title": "Capture: Element CSS selector", "maxLength": 300, "type": "string", "description": "Used when Capture mode is One element. Example: #main or .product-card. Max 300 characters.", "default": "" }, "maxWaitSecs": { "title": "Waiting: Max wait time", "minimum": 5, "maximum": 60, "type": "integer", "description": "The longest we wait for a page to finish loading (5 to 60 seconds). If the page is still busy, we take the screenshot anyway and add a note.", "default": 30 }, "cleanScreenshot": { "title": "Cleaning: Clean screenshot", "type": "boolean", "description": "Hides popups, newsletter boxes and chat bubbles.", "default": true }, "cookieBanner": { "title": "Cleaning: Cookie banner", "enum": [ "hide", "rejectAll" ], "type": "string", "description": "Hide = hide the banner. Click \"Reject all\" = press the page's reject button. We never press \"Accept all\".", "default": "hide" }, "stickyElements": { "title": "Cleaning: Sticky elements", "enum": [ "keepOnce", "hide", "leave" ], "type": "string", "description": "Headers and bars that stay on screen while you scroll. Keep once at top = shown once, not repeated down the image.", "default": "keepOnce" }, "endlessPages": { "title": "Endless pages: When found", "enum": [ "captureTop", "skip" ], "type": "string", "description": "Endless pages keep loading more while you scroll. Capture top = save the top part (counts as a screenshot). Skip = no image (free).", "default": "captureTop" }, "maxPageHeight": { "title": "Endless pages: Max page height", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "The tallest image we make (1000 to 30000 px). Taller pages are cut here.", "default": 15000 }, "followPages": { "title": "Pagination: Follow pages up to N", "minimum": 0, "maximum": 20, "type": "integer", "description": "Follows the page's \"Next\" link up to N times (0 to 20). Same website only. Each page gets its own row.", "default": 0 }, "loadMoreClicks": { "title": "Pagination: Click \"Load more\" up to N times", "minimum": 0, "maximum": 20, "type": "integer", "description": "Presses buttons like Load more / Show more / See more / View more up to N times (0 to 20).", "default": 0 }, "clickSteps": { "title": "Clicks: Run these clicks first", "maxItems": 10, "type": "array", "description": "Up to 10 steps, done in order before the screenshot. Each step = the exact text of a button or link (capital letters and extra spaces don't matter). Experts: css:. 5 seconds per step. You are responsible for the clicks you add and must follow each site's rules.", "items": { "type": "string", "maxLength": 304 }, "default": [] }, "outputFormat": { "title": "Output: Format", "enum": [ "png", "jpeg", "webp", "pdf" ], "type": "string", "description": "PNG = best quality. JPEG / WebP = smaller files. PDF = print layout, not a picture.", "default": "png" }, "resizeWidth": { "title": "Output: Resize output width", "minimum": 100, "maximum": 3840, "type": "integer", "description": "Make the final image this wide (100 to 3840 px). The shape stays the same. Empty = no resize." } } }, "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 } } } } } } } } } }