The /html/convert Robot

We can process your documents in an automated way, saving you costly resources.

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

Parameters

Name Type Default Description
url String / Null 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 "png" The format of the resulting image. The supported values are "jpg","jpeg", "png" and "pdf".
fullpage boolean 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.
width Integer 1024 The screen width that will be used, in pixels. Change this to change the dimensions of the resulting image.
height Integer 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 2000 The delay (in milliseconds) applied to allow the page and all of its JavaScript to render before taking the screenshot.

Live demos

Our /html/convert Robot can be used in combination with other Robots, to create powerful workflows unique to your use case.
Here are a few example scenarios, and the required the Assembly Instructions to implement them.
You can also try demos of these examples right here, live on our website.

Take a screenshot of a website (by uploading an HTML file)

{
  "steps": {
    ":original": {
      "robot": "/upload/handle"
    },
    "screenshot": {
      "use": [":original"],
      "robot": "/html/convert",
      "result": true
    },
    "resized": {
      "use": ["screenshot"],
      "robot": "/image/resize",
      "result": true,
      "gravity": "top",
      "height": 768,
      "imagemagick_stack": "v2.0.3",
      "resize_strategy": "fillcrop",
      "width": 1024,
      "zoom": false
    },
    "exported": {
      "use": ["screenshot", "resized", ":original"],
      "robot": "/s3/store",
      "credentials": "demo_s3_credentials"
    }
  }
}

Take a screenshot of a website automatically (by using a URL)

{
  "steps": {
    "screenshot": {
      "robot": "/html/convert",
      "result": true,
      "format": "png",
      "url": "https://uppy.io",
      "width": 1024
    },
    "resized": {
      "use": ["screenshot"],
      "robot": "/image/resize",
      "result": true,
      "gravity": "top",
      "height": 768,
      "imagemagick_stack": "v2.0.3",
      "resize_strategy": "fillcrop",
      "width": 1024,
      "zoom": false
    },
    "exported": {
      "use": ["screenshot", "resized", ":original"],
      "robot": "/s3/store",
      "credentials": "demo_s3_credentials"
    }
  }
}

Blog posts about our /html/convert Robot

Over the years we wrote the following posts about our /html/convert Robot on our blog:

Did you know?

You can easily combine Robots to create powerful workflows, unique to your business.
This is the power of Transloadit.