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
use (required) String / Array of Strings

General

Specifies which Step(s) to use as the input to this Robot.

Special Step names

A special Step name is ":original", which provides user uploads handled by Transloadit.

Providing several Steps as input

You can add arrays to use several Steps:
"use": [
  ":original",
  "encoded",
  "resized"
]

Step bundling

Some Robots can gather several Step results for a single invocation. For example, the /file/compress Robot would normally create one Zip file for each file passed to it. If you'd set bundle_steps to true, however, it will create one archive containing all the result files from all Steps you give it. To enable bundling, provide an object like the one below to the use parameter:
  "use": {
    "steps": [
      ":original",
      "encoded",
      "resized"
    ],
    "bundle_steps": true
  }
This is a crucial parameter for the /video/adaptive Robot, otherwise you'll generate 1 playlist for each viewing quality.
Keep in mind that all input Steps must be present in your Template. If one of them is missing, no result is generated because the Robot waits indefinitely for all input Steps to be finished.

Group by original

Sticking with the /file/compress Robot example, you can set group_by_original to true, in order to create a separate Zip file for each of your uploaded or imported files, instead of creating one archive containing all originals (or one per resulting file). This is a crucial parameter for the /media/playlist Robot.

Demo

See a demo for the use parameter here.
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.
omit_background Boolean false Determines wether 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 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 0 The delay (in milliseconds) applied to allow the page and all of its JavaScript to render before taking the screenshot.

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 that you can try live on our website:

Blog posts about the /html/convert Robot

We wrote the following posts about the /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.