{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Screenshot API — Full-Page, Element & Device Capture",
    "description": "Website Screenshot API: capture any URL as PNG, JPEG or WebP (PDF too) — true full-page, element & region capture, 13 device profiles, dark mode, retina, ad/cookie-banner blocking, stealth, auth & geo. Self-scaling and SSRF-safe. Standby HTTP + batch.",
    "version": "1.0",
    "x-build-id": "K3VnVKcEOTh07V6i5"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/cheapapi~website-screenshot-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-cheapapi-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/cheapapi~website-screenshot-api/runs": {
      "post": {
        "operationId": "runs-sync-cheapapi-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/cheapapi~website-screenshot-api/run-sync": {
      "post": {
        "operationId": "run-sync-cheapapi-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": [
          "url"
        ],
        "properties": {
          "url": {
            "title": "Target URL",
            "type": "string",
            "description": "The URL of the page to capture. Must be http(s) and resolve to a public address."
          },
          "urls": {
            "title": "Target URLs (batch)",
            "type": "array",
            "description": "Optional list of URLs to capture in a single batch run. When provided, each URL produces one output. Overrides nothing — `url` is still used if `urls` is empty.",
            "items": {
              "type": "string"
            }
          },
          "format": {
            "title": "Output format",
            "enum": [
              "png",
              "jpeg",
              "webp",
              "pdf"
            ],
            "type": "string",
            "description": "Output file format. `pdf` always captures the full page.",
            "default": "png"
          },
          "quality": {
            "title": "Quality",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Compression quality for `jpeg` and `webp` (1-100). Ignored for `png` and `pdf`.",
            "default": 80
          },
          "omitBackground": {
            "title": "Transparent background",
            "type": "boolean",
            "description": "Hide the default white page background, producing a transparent capture. Only meaningful for `png` and `webp`.",
            "default": false
          },
          "fullPage": {
            "title": "Full page",
            "type": "boolean",
            "description": "Capture the entire scrollable page instead of just the viewport. Height is capped at 16384 px (the Chromium texture limit).",
            "default": false
          },
          "device": {
            "title": "Device profile",
            "enum": [
              "desktop",
              "desktop_hd",
              "desktop_1440",
              "desktop_mac",
              "square",
              "portrait",
              "portrait_2x3",
              "widescreen_720",
              "iphone_15",
              "iphone_se",
              "pixel_8",
              "galaxy_s23",
              "ipad"
            ],
            "type": "string",
            "description": "Realistic, consistent device profile (viewport + pixel density + matching user agent + mobile/touch). All profiles cost the same. Default: desktop Full HD. Set a custom width/height below to override.",
            "default": "desktop"
          },
          "width": {
            "title": "Custom viewport width (px)",
            "minimum": 1,
            "maximum": 3840,
            "type": "integer",
            "description": "Override the device profile width. Leave empty to use the selected device."
          },
          "height": {
            "title": "Custom viewport height (px)",
            "minimum": 1,
            "maximum": 4320,
            "type": "integer",
            "description": "Override the device profile height. Ignored when Full page is enabled. Leave empty to use the selected device."
          },
          "deviceScaleFactor": {
            "title": "Device scale factor",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "Override pixel density (1 = standard, 2 = retina). Leave empty to use the selected device."
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "load",
              "domcontentloaded",
              "commit"
            ],
            "type": "string",
            "description": "Navigation lifecycle event to wait for before capturing.",
            "default": "load"
          },
          "delayMs": {
            "title": "Extra delay (ms)",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Additional delay after the page is ready, to let animations or late content settle.",
            "default": 0
          },
          "timeoutMs": {
            "title": "Navigation timeout (ms)",
            "minimum": 1000,
            "maximum": 60000,
            "type": "integer",
            "description": "Maximum time to wait for navigation and rendering before failing.",
            "default": 30000
          },
          "colorScheme": {
            "title": "Color scheme",
            "enum": [
              "no-preference",
              "light",
              "dark"
            ],
            "type": "string",
            "description": "Emulated `prefers-color-scheme` media feature.",
            "default": "no-preference"
          },
          "selector": {
            "title": "Element selector",
            "type": "string",
            "description": "Optional CSS selector. When set, only the first matching element is captured instead of the page."
          },
          "hideSelectors": {
            "title": "Hide selectors",
            "type": "array",
            "description": "CSS selectors for elements to hide (set `visibility:hidden`) before capturing.",
            "items": {
              "type": "string"
            }
          },
          "blockAds": {
            "title": "Block ads",
            "type": "boolean",
            "description": "Block common advertising and tracking network requests.",
            "default": true
          },
          "acceptCookies": {
            "title": "Auto-accept cookie consent",
            "type": "boolean",
            "description": "Click the 'Accept / I understand / Kabul et' button on consent dialogs (CMP vendors + text heuristic, iframes included). This GRANTS consent, which unlocks content gated behind it (e.g. recommendation lists). On by default.",
            "default": true
          },
          "blockCookieBanners": {
            "title": "Hide leftover cookie banners",
            "type": "boolean",
            "description": "Visually hide any cookie/GDPR banner still present after auto-accept (CSS display:none). Note: hiding does NOT grant consent — use Auto-accept for consent-gated content.",
            "default": true
          },
          "blockImages": {
            "title": "Block images",
            "type": "boolean",
            "description": "Skip loading images for faster, text-only captures.",
            "default": false
          },
          "waitForSelector": {
            "title": "Wait for selector",
            "type": "string",
            "description": "Optional CSS selector to wait for (visible) before capturing. Useful for single-page apps and late-rendered content. Fails if the element never appears within the timeout."
          },
          "clip": {
            "title": "Clip region",
            "type": "object",
            "description": "Capture only a rectangular region: { \"x\": 0, \"y\": 0, \"width\": 800, \"height\": 600 }. Takes precedence over Full page; ignored for PDF and element capture."
          },
          "locale": {
            "title": "Locale",
            "type": "string",
            "description": "Emulated locale, e.g. en-US, de-DE, tr-TR. Affects Accept-Language and JS locale APIs."
          },
          "timezoneId": {
            "title": "Timezone",
            "type": "string",
            "description": "Emulated IANA timezone, e.g. Europe/Istanbul, America/New_York."
          },
          "userAgent": {
            "title": "User agent",
            "type": "string",
            "description": "Override the browser User-Agent string. Leave empty to use the device profile's realistic UA."
          },
          "stealth": {
            "title": "Stealth mode",
            "type": "boolean",
            "description": "Mask obvious automation tells (navigator.webdriver, missing window.chrome, empty plugins, HeadlessChrome UA) so the page does not look like a bot. Does NOT solve CAPTCHAs/Cloudflare challenges — pair with a residential proxy and/or cookies for protected sites. On by default.",
            "default": true
          },
          "isMobile": {
            "title": "Mobile emulation",
            "type": "boolean",
            "description": "Emulate a mobile device (touch + mobile viewport meta). Pair with a small width/height for phone screenshots.",
            "default": false
          },
          "hasTouch": {
            "title": "Touch support",
            "type": "boolean",
            "description": "Enable touch events. Defaults to true when Mobile emulation is on.",
            "default": false
          },
          "geolocation": {
            "title": "Geolocation",
            "type": "object",
            "description": "Spoof GPS location and grant the geolocation permission: { \"latitude\": 41.0082, \"longitude\": 28.9784 }."
          },
          "cookies": {
            "title": "Session cookies",
            "type": "array",
            "description": "Cookies for authenticated / paywalled pages. Each: { \"name\": \"sid\", \"value\": \"...\", \"domain\": \".example.com\", \"path\": \"/\" }. Cookies without a domain/url are scoped to the target URL."
          },
          "headers": {
            "title": "Extra HTTP headers",
            "type": "object",
            "description": "Custom request headers, e.g. { \"Authorization\": \"Bearer ...\" }. Sent ONLY to first-party (same-origin) requests — never leaked to cross-origin subresources or after a cross-origin redirect. Hop-by-hop and spoofable headers (Host, Cookie, Content-Length, ...) are rejected."
          },
          "proxy": {
            "title": "Upstream proxy",
            "type": "string",
            "description": "Route this capture through YOUR OWN proxy, e.g. http://user:pass@host:port or socks5://host:1080 (capture the page as seen from your proxy's location/country). The proxy address must be public. Schemes: http, https, socks4, socks5. Note: Chromium ignores auth for socks proxies."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}