{ "openapi": "3.0.1", "info": { "title": "Screenshot URL API — Full-Page, PDF & Device Screenshots", "description": "Turn any URL into a PNG, JPEG or PDF. Full-page capture with lazy-image auto-scroll, cookie-banner dismissal, retina/device sizing, and single-element screenshots. One public image link per URL. Pay only per successful capture — timeouts and errors are free.", "version": "0.1", "x-build-id": "P5LB0RvAKjOOnUfEX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/qualifyops~url-screenshot-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-qualifyops-url-screenshot-pro", "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/qualifyops~url-screenshot-pro/runs": { "post": { "operationId": "runs-sync-qualifyops-url-screenshot-pro", "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/qualifyops~url-screenshot-pro/run-sync": { "post": { "operationId": "run-sync-qualifyops-url-screenshot-pro", "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 to screenshot", "type": "array", "description": "One or more web page URLs. Each produces one image (or PDF) with a public link in the output.", "items": { "type": "string" } }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "png (lossless), jpeg (smaller), or pdf (full document).", "default": "png" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the entire scrollable page (auto-scrolls to trigger lazy-loaded images). Off = just the viewport.", "default": true }, "dismissCookieBanners": { "title": "Dismiss cookie / consent banners", "type": "boolean", "description": "Auto-click common cookie/consent 'Accept' buttons before capture so they don't cover the page.", "default": true }, "selector": { "title": "Element selector (optional)", "type": "string", "description": "CSS selector to screenshot a single element instead of the page (e.g. '#hero', '.pricing-table')." }, "viewportWidth": { "title": "Viewport width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Browser width. Use 390 for mobile, 1920 for desktop.", "default": 1920 }, "viewportHeight": { "title": "Viewport height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Browser height (ignored dimension-wise when Full page is on).", "default": 1080 }, "deviceScaleFactor": { "title": "Pixel density (retina)", "minimum": 1, "maximum": 3, "type": "integer", "description": "1 = normal, 2 = retina/2x, 3 = 3x. Higher = sharper, larger files.", "default": 1 }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle", "commit" ], "type": "string", "description": "When to consider the page loaded before capture.", "default": "networkidle" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Additional wait after load — useful for animations/fonts settling.", "default": 500 }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1–100, only used when format is JPEG.", "default": 85 }, "timeoutSecs": { "title": "Per-URL timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Give up on a URL after this many seconds (emits a free error row).", "default": 60 } } }, "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 } } } } } } } } } }