Our /html/convert Robot

Take screenshots of webpages or uploaded HTML files

🤖/html/convert takes screenshots of web pages or uploaded HTML pages.

A URL can be provided instead of an input HTML file, to capture a screenshot from the website referenced by the URL.

Use 🤖/image/resize to resize or crop the screenshot as needed.

Warning: A validation error will occur if neither an HTML file is uploaded nor a URL parameter is given.

Note: Any files imported within the HTML page will be included in the cost.

Usage example

Take a full screenshot of the Transloadit homepage:

{
  "steps": {
    "captured": {
      "robot": "/html/convert",
      "url": "https://transloadit.com"
    }
  }
}

Parameters

  • use

    String / Array of Strings / Object

    Specifies which Step(s) to use as input.

    • You can pick any names for Steps except ":original" (reserved for user uploads handled by Transloadit)

    • You can provide several Steps as input with arrays:

      "use": [
  ":original",
  "encoded",
  "resized"
]

    💡 That’s likely all you need to know about use, but you can view Advanced use cases.

  • url

    String / Null ⋅ default: null

    The URL of the web page to be converted. Optional, as you can also upload/import HTML files and pass it to this Robot.

  • format

    String ⋅ default: "png"

    The format of the resulting image. The supported values are "pdf", "jpg", "jpeg" and "png".

  • fullpage

    Boolean ⋅ default: true

    Determines if a screenshot of the full page should be taken or not.

    If set to true, the height parameter will not have any effect, as heights of websites vary. You can control the size of the resulting image somewhat, though, by setting the width parameter.

    If set to false, an image will be cropped from the top of the webpage according to your width and height parameters.

  • omit_background

    Boolean ⋅ default: false

    Determines whether to preserve a transparent background in HTML pages. Useful if you're generating artwork in HTML that you want to overlay on e.g. a video.

    The default of false fills transparent areas with a white background, for easier reading/printing.

    This parameter is only used when format is not pdf.

  • width

    Integer ⋅ default: 1024

    The screen width that will be used, in pixels. Change this to change the dimensions of the resulting image.

  • height

    Integer ⋅ default: 768

    The screen height that will be used, in pixels. By default this equals the length of the web page in pixels if fullpage is set to true. If fullpage is set to false, the height parameter takes effect and defaults to the value 768.

  • delay

    Integer ⋅ default: 0

    The delay (in milliseconds) applied to allow the page and all of its JavaScript to render before taking the screenshot.

  • headers

    Object ⋅ default: {}

    An object containing optional headers that will be passed along with the original request to the website. For example, this parameter can be used to pass along an authorization token along with the request.

Demos

Related blog posts