{ "openapi": "3.0.1", "info": { "title": "Quality Website Screenshot API", "description": "Full-page or viewport screenshots (PNG/JPEG/WebP/PDF) from a real headless Chrome browser, with a wait-for-selector option for JS-heavy pages.", "version": "0.1", "x-build-id": "ekMwICa0hoxqRo6on" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/inn_corp~quality-website-screenshot-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-inn_corp-quality-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/inn_corp~quality-website-screenshot-api/runs": { "post": { "operationId": "runs-sync-inn_corp-quality-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/inn_corp~quality-website-screenshot-api/run-sync": { "post": { "operationId": "run-sync-inn_corp-quality-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", "required": [ "urls" ], "properties": { "urls": { "title": "URLs", "type": "array", "description": "Pages to capture. Each is opened in a real headless Chrome browser and rendered exactly as a normal visitor would see it: this Actor does not bypass logins, paywalls, or any other access control. Supply only pages you have the right to capture.", "items": { "type": "string" } }, "fullPage": { "title": "Full page", "type": "boolean", "description": "On (default): capture the entire scrollable page, top to bottom. Off: capture only the current viewport, cut off at viewportHeight.", "default": true }, "viewportWidth": { "title": "Viewport width (px)", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Browser viewport width before capture. Common presets: 1280 (laptop), 1920 (desktop), 375 (mobile portrait), 768 (tablet portrait).", "default": 1280 }, "viewportHeight": { "title": "Viewport height (px)", "minimum": 240, "maximum": 2160, "type": "integer", "description": "Browser viewport height before capture. Only the visible cutoff when fullPage is off; fullPage captures ignore this and use the page's real scroll height instead.", "default": 800 }, "format": { "title": "Format", "enum": [ "png", "jpeg", "webp", "pdf" ], "type": "string", "description": "Output file format. PNG is lossless and the safest default; JPEG and WebP are smaller and take the quality setting; PDF prints the page instead of rastering it.", "default": "png" }, "waitForSelector": { "title": "Wait for CSS selector", "type": "string", "description": "Optional. A CSS selector (e.g. \".hero-image\", \"#chart-loaded\") the Actor waits to appear before capturing. Use this for pages whose real content renders after a JavaScript call; it is the reliable alternative to a fixed delay. Leave empty to skip." }, "delayMs": { "title": "Extra fixed delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Optional. A simple fixed wait after the page loads (and after waitForSelector resolves, if both are set) before capturing. Simpler than waitForSelector but blunter: it always waits the full amount, whether the page needed it or not. Default 0 (no extra wait).", "default": 0 }, "quality": { "title": "Quality (JPEG/WebP)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Compression quality, 1 to 100. Only applies to jpeg and webp; ignored for png (always lossless) and pdf.", "default": 90 }, "pageTimeoutSecs": { "title": "Timeout per page (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Wall-clock budget per URL, covering navigation, the wait strategy, and the capture itself. A page that blows the budget is reported with status \"timeout\" and is never charged.", "default": 30 } } }, "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 } } } } } } } } } }