{ "openapi": "3.0.1", "info": { "title": "Screenshot & HTML file from Url", "description": "From 1$/1000 results. Capture website screenshots &/or full-page HTML in one run, from $1/1000 URLs. PNG, JPEG & PDF — full-page, custom viewport, lazy-load scroll, cookie-banner hiding, batch mode. HTML files open correctly in any browser. REST API ready. No watermark.", "version": "0.1", "x-build-id": "OLwExBPS8im1LHADv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leadsbrary~screenshot-html-file-from-url/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leadsbrary-screenshot-html-file-from-url", "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/leadsbrary~screenshot-html-file-from-url/runs": { "post": { "operationId": "runs-sync-leadsbrary-screenshot-html-file-from-url", "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/leadsbrary~screenshot-html-file-from-url/run-sync": { "post": { "operationId": "run-sync-leadsbrary-screenshot-html-file-from-url", "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": "Page URLs", "type": "array", "description": "Add one or more HTTP/HTTPS URLs to capture. Domains without a protocol are automatically opened as HTTPS.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "Choose the file format stored in the Key-Value Store.", "default": "png" }, "fullPage": { "title": "Full-page screenshot", "type": "boolean", "description": "Capture the whole page instead of only the visible viewport. Applies to PNG/JPEG output.", "default": true }, "saveHtml": { "title": "Save HTML source", "type": "boolean", "description": "Also save the full page HTML as a .html file in the Key-Value Store and add the link in the dataset.", "default": false }, "viewportWidth": { "title": "Viewport width", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Browser viewport width before the screenshot is taken.", "default": 1280 }, "viewportHeight": { "title": "Viewport height", "minimum": 240, "maximum": 2160, "type": "integer", "description": "Browser viewport height before the screenshot is taken.", "default": 720 }, "jpegQuality": { "title": "JPEG quality", "minimum": 30, "maximum": 100, "type": "integer", "description": "Quality used when the output format is JPEG.", "default": 90 }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When navigation is considered ready enough for the capture.", "default": "load" }, "delayBeforeScreenshotMs": { "title": "Delay before capture", "minimum": 0, "maximum": 300000, "type": "integer", "description": "Extra wait time after navigation and before the screenshot/PDF is created.", "default": 0 }, "scrollToBottom": { "title": "Scroll to bottom first", "type": "boolean", "description": "Scroll the page before the capture to trigger lazy-loaded content, then return to the top.", "default": false }, "delayAfterScrollMs": { "title": "Delay after scrolling", "minimum": 0, "maximum": 300000, "type": "integer", "description": "Extra wait time after scrolling to allow lazy-loaded images and content to appear.", "default": 1000 }, "selectorsToHide": { "title": "Selectors to hide", "type": "string", "description": "Optional CSS selectors to hide before the capture. Add one selector per line, for example: .cookie-banner", "default": "" }, "navigationTimeoutSecs": { "title": "Navigation timeout", "minimum": 5, "maximum": 300, "type": "integer", "description": "Maximum time allowed for loading each page.", "default": 60 }, "maxRequestRetries": { "title": "Retries per URL", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times a failed URL should be retried before an error record is written to the dataset.", "default": 1 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many pages can be captured at the same time. Keep this low for large pages or low-memory runs.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy setup. Leave the default value to run without proxies. Enable Apify Proxy or add custom proxy URLs only when needed.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }