Render a URL as an image or video

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "block_ads": {
      "type": "boolean",
      "description": "Whether to block ads on the rendered page"
    },
    "click_accept": {
      "type": "boolean",
      "description": "Whether to automatically click accept buttons on the rendered page"
    },
    "delay": {
      "type": "string",
      "description": "The amount of milliseconds to delay before taking a screenshot"
    },
    "format": {
      "type": "string",
      "description": "The format of the rendered output",
      "enum": [
        "png",
        "jpg",
        "pdf",
        "svg",
        "mp4",
        "webp",
        "webm",
        "html"
      ]
    },
    "full_page": {
      "type": "boolean",
      "description": "Whether to capture the full page"
    },
    "gpu": {
      "type": "boolean",
      "description": "Whether to enable GPU rendering"
    },
    "height": {
      "type": "integer",
      "description": "The viewport height of the rendered output"
    },
    "hide_cookie_banners": {
      "type": "boolean",
      "description": "Whether to hide cookie banners on the rendered page"
    },
    "html": {
      "type": "string",
      "description": "The raw HTML to render as an image or video"
    },
    "metadata": {
      "type": "boolean",
      "description": "Whether to return metadata about the URL"
    },
    "retina": {
      "type": "boolean",
      "description": "Whether to render the image in retina quality"
    },
    "selector": {
      "type": "string",
      "description": "The CSS selector of an element you would like to capture"
    },
    "thumb_height": {
      "type": "integer",
      "description": "The height of the thumbnail image"
    },
    "thumb_width": {
      "type": "integer",
      "description": "The width of the thumbnail image"
    },
    "url": {
      "type": "string",
      "description": "The URL to render as an image or video"
    },
    "wait_for": {
      "type": "string",
      "description": "CSS selector of an element to wait to be present in the web page before rendering"
    },
    "wait_to_leave": {
      "type": "string",
      "description": "CSS selector of an element, such as a loading spinner, to wait to leave the web page before rendering"
    },
    "wait_until": {
      "type": "string",
      "description": "When",
      "enum": [
        "requestsfinished",
        "mostrequestsfinished",
        "loaded",
        "domloaded"
      ]
    },
    "width": {
      "type": "integer",
      "description": "The viewport width of the rendered output"
    }
  }
}

Output

{
  "type": "object",
  "properties": {
    "renderUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL where the rendered output is stored"
    },
    "size": {
      "type": "integer",
      "format": "int64",
      "description": "The size of the rendered output in bytes"
    }
  }
}