{ "openapi": "3.0.1", "info": { "title": "Website Screenshot to Social Image (No Crop)", "description": "Website screenshot API that turns any URL or HTML into ready-to-post images: Instagram 1080x1350, Pinterest pin, square, Story and Open Graph 1200x630. No cropping, rounded card or browser frame, dark mode, phone viewport, cookie banners hidden. $0.004 per image. AI agent and MCP ready.", "version": "1.0", "x-build-id": "VGMfoInzt2ViWoOpj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bigaceboy~website-screenshot-to-social/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bigaceboy-website-screenshot-to-social", "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/bigaceboy~website-screenshot-to-social/runs": { "post": { "operationId": "runs-sync-bigaceboy-website-screenshot-to-social", "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/bigaceboy~website-screenshot-to-social/run-sync": { "post": { "operationId": "run-sync-bigaceboy-website-screenshot-to-social", "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": "Web page URLs", "maxItems": 200, "type": "array", "description": "Public http(s) pages to screenshot. Private, localhost and cloud-metadata addresses are blocked (DNS is resolved and every redirect is checked).", "items": { "type": "string" } }, "html": { "title": "HTML snippet", "type": "string", "description": "Optional. One HTML document or fragment to render and screenshot (quote cards, charts, mock tweets, invoices). JavaScript is off for HTML unless you enable it under Advanced." }, "htmlSnippets": { "title": "More HTML snippets", "type": "array", "description": "Optional list of HTML strings, or objects like {\"name\": \"quote-1\", \"html\": \"

Hi

\"}. Combined with URLs and the HTML snippet." }, "presets": { "title": "Output sizes", "type": "array", "description": "Sizes to create for every page. instagram-portrait 1080×1350, pinterest-pin 1000×1500, square 1080×1080, story 1080×1920, og-image 1200×630 (link previews, X/LinkedIn cards), raw = the plain screenshot at its own size. 'custom' uses Custom width/height. Each selected size is one billable image.", "items": { "type": "string", "enum": [ "instagram-portrait", "pinterest-pin", "square", "story", "og-image", "raw", "custom" ], "enumTitles": [ "Instagram/Facebook portrait 1080×1350", "Pinterest pin 1000×1500", "Square 1080×1080", "Story/Reel 1080×1920", "OG image / link preview 1200×630", "Raw screenshot (no resize, no frame)", "Custom size (set below)" ] }, "default": [ "instagram-portrait", "og-image" ] }, "customWidth": { "title": "Custom width", "minimum": 64, "maximum": 6000, "type": "integer", "description": "Width for the 'custom' size (64–6000). Setting width and height adds a custom output." }, "customHeight": { "title": "Custom height", "minimum": 64, "maximum": 6000, "type": "integer", "description": "Height for the 'custom' size (64–6000)." }, "frameStyle": { "title": "Frame style", "enum": [ "rounded-shadow", "browser", "rounded", "none" ], "type": "string", "description": "How the screenshot sits on the background. rounded-shadow = rounded corners + soft drop shadow (default), browser = adds a simple browser-window bar with the page address, rounded = corners only, none = plain rectangle.", "default": "rounded-shadow" }, "backgroundColor": { "title": "Background color", "pattern": "^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$", "type": "string", "description": "Hex color behind the screenshot, e.g. #F4EFE6 (warm cream, default), #FFFFFF or #111111.", "default": "#F4EFE6" }, "paddingPercent": { "title": "Padding (%)", "minimum": 0, "maximum": 40, "type": "integer", "description": "Space around the screenshot as a percent of the output width/height. 0–40.", "default": 6 }, "cornerRadius": { "title": "Corner radius", "minimum": 0, "maximum": 200, "type": "integer", "description": "Rounded-corner radius in output pixels (frame styles other than none).", "default": 18 }, "outputFormat": { "title": "Output format", "enum": [ "png", "jpg", "webp" ], "type": "string", "description": "png is sharpest for text; jpg and webp are smaller.", "default": "png" }, "viewportWidth": { "title": "Viewport width", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Browser window width in CSS pixels. 1280 = laptop, 390 = phone.", "default": 1280 }, "viewportHeight": { "title": "Viewport height", "minimum": 240, "maximum": 4320, "type": "integer", "description": "Browser window height in CSS pixels (the visible area captured when Full page is off).", "default": 800 }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrolling page instead of just the visible window (scrolls first to load lazy images). Tall pages look small in social sizes; combine with pinterest-pin or story.", "default": false }, "fullPageMaxHeight": { "title": "Full page max height", "minimum": 500, "maximum": 16000, "type": "integer", "description": "Very long pages are cut at this height (CSS pixels).", "default": 6000 }, "deviceScaleFactor": { "title": "Device scale factor", "minimum": 1, "maximum": 3, "type": "integer", "description": "1 = normal, 2 = retina (sharper text, slower, bigger raw files).", "default": 1 }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the page for its dark color scheme (prefers-color-scheme: dark). Only works on sites that support it.", "default": false }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Best-effort: hides common cookie/consent popups (OneTrust, Cookiebot, Didomi, Quantcast, Usercentrics and generic fixed banners).", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded.", "default": "load" }, "delayMillis": { "title": "Extra delay", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Extra wait after load before the screenshot (animations, fonts, late content).", "default": 1000 }, "timeoutSecs": { "title": "Page timeout", "minimum": 5, "maximum": 180, "type": "integer", "description": "Give up on a page after this long (not charged).", "default": 45 }, "hideSelectors": { "title": "Hide elements", "type": "array", "description": "CSS selectors to hide before the screenshot, e.g. \".chat-widget\", \"#promo-bar\".", "items": { "type": "string" } }, "customCss": { "title": "Custom CSS", "type": "string", "description": "Extra CSS injected into the page before the screenshot." }, "htmlJavaScript": { "title": "Run JavaScript in HTML snippets", "type": "boolean", "description": "Off by default for safety. Turn on for snippets that draw charts with JS.", "default": false }, "quality": { "title": "Quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "jpg/webp quality (1–100). Ignored for png.", "default": 90 } } }, "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 } } } } } } } } } }