{ "openapi": "3.0.1", "info": { "title": "SnapScout: Website Screenshot API for AI Agents (Image + Text)", "description": "Let your agent see and read any web page. URLs in, one record each: a public screenshot URL (PNG/JPEG, viewport, full page or element) plus HTTP status, final URL, title, meta and clean page text. Cookie banners clicked away. $0.003 per screenshot, failures free.", "version": "0.1", "x-build-id": "RwwdfQQn9ADhCtlf2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cybermax~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cybermax-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/cybermax~website-screenshot/runs": { "post": { "operationId": "runs-sync-cybermax-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/cybermax~website-screenshot/run-sync": { "post": { "operationId": "run-sync-cybermax-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": "Pages to capture. Full URLs or bare domains (\"example.com\" becomes https://example.com/). One screenshot record per URL; duplicates are skipped.", "items": { "type": "string" } }, "device": { "title": "Device", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "type": "string", "description": "Viewport and user agent: desktop 1366x768, laptop 1920x1080, tablet 820x1180 @2x, mobile 390x844 @2x.", "default": "desktop" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of the first screen. Scrolls first so lazy images load. Capped at 'Max full-page height'.", "default": false }, "selector": { "title": "Element selector (optional)", "type": "string", "description": "CSS selector of one element to capture instead of the page, e.g. \"#pricing\" or \"main\". The record fails with 'selector not found' if it isn't there." }, "format": { "title": "Image format", "enum": [ "png", "jpeg" ], "type": "string", "description": "PNG is lossless; JPEG is 3-10x smaller, better for vision models and long pages.", "default": "png" }, "jpegQuality": { "title": "JPEG quality", "minimum": 30, "maximum": 100, "type": "integer", "description": "30-100. Only used when the format is JPEG.", "default": 80 }, "includeText": { "title": "Include page text", "type": "boolean", "description": "Return the visible text of the page (main/article if present, else body), whitespace-cleaned, so an agent can read the page without looking at the image.", "default": true }, "maxTextChars": { "title": "Max text characters", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Cut the page text at this many characters (0-50000). 'textChars' always reports the full length.", "default": 4000 }, "dismissCookieBanners": { "title": "Dismiss cookie banners", "type": "boolean", "description": "Click 'accept' on common consent platforms (OneTrust, Cookiebot, Didomi, Quantcast, TrustArc, Usercentrics, CookieYes and plain 'Accept all' buttons in 10+ languages), then hide leftover overlays.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "domcontentloaded", "load", "networkidle" ], "type": "string", "description": "Page state to wait for before capturing (best effort, up to 15 s after the HTML has loaded; pages that never settle are still captured, with a warning).", "default": "load" }, "delaySecs": { "title": "Extra delay (seconds)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Wait this long after loading, for animations and late content. 0-30.", "default": 1 }, "viewportWidth": { "title": "Viewport width override (px)", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Optional. Overrides the device width (320-3840)." }, "viewportHeight": { "title": "Viewport height override (px)", "minimum": 320, "maximum": 4320, "type": "integer", "description": "Optional. Overrides the device height (320-4320)." }, "maxFullPageHeight": { "title": "Max full-page height (px)", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "Longer pages are cut at this height (1000-30000), with a warning in the record.", "default": 15000 }, "includeImageBase64": { "title": "Include image as base64", "type": "boolean", "description": "Also put the image bytes in the record as base64 (for agents that can't fetch URLs). Makes records large; prefer JPEG with this.", "default": false }, "navigationTimeoutSecs": { "title": "Navigation timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long to wait for the page's HTML (5-120).", "default": 30 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many pages to capture at once (1-8). Heavy pages share the CPU, so more is not always faster.", "default": 2 } } }, "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 } } } } } } } } } }