{
"openapi": "3.0.1",
"info": {
"title": "Screenshot Pro — Full-Page Screenshot, Element Capture & PDF",
"description": "Capture full-page or element screenshots in PNG, JPEG or WebP, or render pages to PDF. Auto-dismisses cookie banners, blocks ads, emulates devices and waits for the element you actually care about.",
"version": "0.1",
"x-build-id": "tistllFbmhfalg7qy"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/p6t_p10n~screenshot-pro/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-p6t_p10n-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/p6t_p10n~screenshot-pro/runs": {
"post": {
"operationId": "runs-sync-p6t_p10n-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/p6t_p10n~screenshot-pro/run-sync": {
"post": {
"operationId": "run-sync-p6t_p10n-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",
"type": "array",
"description": "Pages to capture. Accepts plain URLs or objects with per-URL overrides for waitForSelector, selector, fullPage and delayMs.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"format": {
"title": "Output format",
"enum": [
"png",
"jpeg",
"webp",
"pdf"
],
"type": "string",
"description": "PNG is lossless. JPEG and WebP produce much smaller files — WebP is typically 25-35% smaller than JPEG at the same quality. PDF renders the page through Chromium's print pipeline.",
"default": "png"
},
"fullPage": {
"title": "Full page",
"type": "boolean",
"description": "Capture the entire scrollable page instead of just the visible viewport.",
"default": true
},
"selector": {
"title": "Element selector",
"type": "string",
"description": "Capture only this element instead of the page. CSS selector. Overrides Full page."
},
"quality": {
"title": "Quality (JPEG / WebP)",
"minimum": 1,
"maximum": 100,
"type": "integer",
"description": "1-100. Ignored for PNG and PDF.",
"default": 80
},
"omitBackground": {
"title": "Transparent background",
"type": "boolean",
"description": "Produce a transparent background where the page has none. PNG and WebP only.",
"default": false
},
"device": {
"title": "Device preset",
"enum": [
"custom",
"desktop",
"desktop-hd",
"macbook-pro-16",
"iphone-15",
"iphone-15-pro-max",
"iphone-se",
"pixel-7",
"galaxy-s9",
"ipad-pro-11",
"ipad-mini"
],
"type": "string",
"description": "Sets viewport, user agent, scale factor and touch support in one go. Choose custom to drive the viewport fields below.",
"default": "custom"
},
"viewportWidth": {
"title": "Viewport width",
"minimum": 100,
"maximum": 3840,
"type": "integer",
"description": "Used when Device preset is custom.",
"default": 1440
},
"viewportHeight": {
"title": "Viewport height",
"minimum": 100,
"maximum": 4320,
"type": "integer",
"description": "Used when Device preset is custom. Irrelevant for full-page captures beyond triggering lazy loading.",
"default": 900
},
"deviceScaleFactor": {
"title": "Scale factor (retina)",
"minimum": 1,
"maximum": 3,
"type": "integer",
"description": "2 gives a retina-quality image at double the pixel dimensions. Leave empty to use the device preset's native scale; setting a value overrides the preset, including forcing 1x on a retina device."
},
"darkMode": {
"title": "Dark mode",
"type": "boolean",
"description": "Emulate prefers-color-scheme: dark.",
"default": false
},
"waitUntil": {
"title": "Wait until",
"enum": [
"commit",
"domcontentloaded",
"load",
"networkidle"
],
"type": "string",
"description": "Navigation completion signal. networkidle is the safest for JS-heavy pages but the slowest.",
"default": "load"
},
"waitForSelector": {
"title": "Wait for selector",
"type": "string",
"description": "Block until this element is visible before capturing. The most reliable way to avoid capturing a half-rendered page."
},
"delayMs": {
"title": "Extra delay",
"minimum": 0,
"maximum": 60000,
"type": "integer",
"description": "Fixed pause immediately before capture, for animations that have no observable end state.",
"default": 0
},
"scrollToBottom": {
"title": "Scroll to bottom first",
"type": "boolean",
"description": "Scroll through the page to trigger lazy-loaded images, then return to the top. Almost always needed for full-page captures.",
"default": true
},
"timeoutSecs": {
"title": "Timeout per URL",
"minimum": 5,
"maximum": 300,
"type": "integer",
"description": "Give up on a single URL after this long and record it as a failed item.",
"default": 60
},
"retries": {
"title": "Retries per URL",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Retry a failed URL this many times, with a fresh browser context each attempt.",
"default": 2
},
"dismissCookieBanners": {
"title": "Dismiss cookie banners",
"type": "boolean",
"description": "Detect and click through consent dialogs from OneTrust, Cookiebot, Didomi, Quantcast, TrustArc, Usercentrics, Osano, CookieYes, Complianz and generic accept buttons in 12 languages.",
"default": true
},
"stickyMode": {
"title": "Sticky & fixed elements",
"enum": [
"keep",
"unstick",
"hide"
],
"type": "string",
"description": "Pinned bars and widgets can be dragged into a tall capture. unstick returns them to normal flow so they render once, in place; hide removes them. Both only touch overlay-sized elements, never full-viewport layout containers — but they do mutate the page, so keep is the default.",
"default": "keep"
},
"hideSelectors": {
"title": "Hide elements",
"type": "array",
"description": "CSS selectors to hide before capture — chat widgets, sticky headers, newsletter modals.",
"default": [],
"items": {
"type": "string"
}
},
"blockAds": {
"title": "Block ads & trackers",
"type": "boolean",
"description": "Drop requests to known ad and analytics hosts. Faster pages, cleaner images, lower compute cost.",
"default": true
},
"blockResourceTypes": {
"title": "Block resource types",
"type": "array",
"description": "Additional Playwright resource types to block outright.",
"items": {
"type": "string",
"enum": [
"image",
"media",
"font",
"stylesheet",
"script",
"websocket",
"xhr",
"fetch"
]
},
"default": []
},
"customCss": {
"title": "Custom CSS",
"type": "string",
"description": "Injected as a <style> tag before capture."
},
"customJs": {
"title": "Custom JavaScript",
"type": "string",
"description": "Body of an async function evaluated in the page before capture. Runs after cookie handling and element hiding."
},
"pdfFormat": {
"title": "PDF page format",
"enum": [
"A4",
"A3",
"A5",
"Letter",
"Legal",
"Tabloid"
],
"type": "string",
"description": "Paper size of the generated PDF pages.",
"default": "A4"
},
"pdfLandscape": {
"title": "Landscape",
"type": "boolean",
"description": "Rotate the PDF pages to landscape orientation.",
"default": false
},
"pdfPrintBackground": {
"title": "Print background graphics",
"type": "boolean",
"description": "Off by default in Chromium, which is why most PDF scrapers produce washed-out pages. On by default here.",
"default": true
},
"pdfMedia": {
"title": "Render with media type",
"enum": [
"screen",
"print"
],
"type": "string",
"description": "screen reproduces what a visitor sees. print applies the site's print stylesheet, which usually strips navigation and ads.",
"default": "screen"
},
"pdfScale": {
"title": "Scale",
"type": "string",
"description": "Render scale between 0.1 and 2.",
"default": "1"
},
"pdfMargin": {
"title": "Margin",
"type": "string",
"description": "CSS length applied to all four sides, e.g. 0, 1cm, 0.5in.",
"default": "0"
},
"userAgent": {
"title": "User agent",
"type": "string",
"description": "Overrides the device preset's user agent."
},
"headers": {
"title": "Extra HTTP headers",
"type": "object",
"description": "Sent with every request, e.g. an Authorization header for gated pages."
},
"cookies": {
"title": "Cookies",
"type": "array",
"description": "Playwright cookie objects, for capturing pages behind a login.",
"default": []
},
"locale": {
"title": "Locale",
"type": "string",
"description": "e.g. en-US, th-TH. Affects rendered language and number formatting."
},
"timezone": {
"title": "Timezone",
"type": "string",
"description": "IANA timezone, e.g. Asia/Bangkok."
},
"maxConcurrency": {
"title": "Concurrency",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "How many pages to capture in parallel. Each parallel page is a separate browser context, so memory is the practical limit — around 1 GB per heavy page.",
"default": 5
},
"proxy": {
"title": "Proxy",
"type": "object",
"description": "Proxy configuration. Residential proxies help on sites that block datacenter IPs.",
"default": {
"useApifyProxy": true
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}