snapshot

{
  "type": "object",
  "required": [
    "url"
  ],
  "additionalProperties": false,
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Absolute http or https URL to render."
    },
    "viewport": {
      "type": "object",
      "additionalProperties": false,
      "description": "Viewport in CSS pixels. Default 1280x800.",
      "properties": {
        "width": {
          "type": "integer",
          "minimum": 360,
          "maximum": 2560,
          "default": 1280
        },
        "height": {
          "type": "integer",
          "minimum": 360,
          "maximum": 2000,
          "default": 800
        }
      }
    },
    "wait_until": {
      "type": "string",
      "enum": [
        "load",
        "domcontentloaded",
        "networkidle"
      ],
      "default": "networkidle",
      "description": "When the page counts as ready. networkidle waits until at most two connections stay open for half a second, which is what most JavaScript pages need."
    },
    "wait_ms": {
      "type": "integer",
      "minimum": 0,
      "maximum": 8000,
      "default": 0,
      "description": "Wait this long after the page is ready before reading it. Counts against the 20 second budget, it is not added on top."
    },
    "include": {
      "type": "array",
      "default": [
        "dom",
        "a11y",
        "links",
        "forms",
        "console",
        "screenshot"
      ],
      "items": {
        "type": "string",
        "enum": [
          "dom",
          "a11y",
          "links",
          "forms",
          "console",
          "screenshot"
        ]
      },
      "description": "Which parts to return. Omit for all of them. Leaving parts out makes the answer smaller, not cheaper: the page is loaded once either way."
    },
    "screenshot_format": {
      "type": "string",
      "enum": [
        "png",
        "webp",
        "jpeg"
      ],
      "default": "webp",
      "description": "Image format. webp is the smallest and keeps the answer under the size cap most often."
    },
    "screenshot_quality": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 80,
      "description": "Compression quality for webp and jpeg. Ignored for png."
    },
    "full_page": {
      "type": "boolean",
      "default": false,
      "description": "Capture the whole document instead of the viewport. Same price on this endpoint."
    },
    "check_links": {
      "type": "boolean",
      "default": false,
      "description": "Look up the HTTP status of up to 50 links with HEAD, without following redirects. No extra charge. Without this, links carry no status field."
    }
  }
}