Convert documents into different formats

Usage example

{
  "steps": {
    "converted": {
      "robot": "/document/convert",
      "use": ":original",
      "format": "pdf"
    }
  }
}

Parameters

• output_meta

  Record<string, boolean> | boolean

  Allows you to specify a set of metadata that is more expensive on CPU power to calculate, and thus is disabled by default to keep your Assemblies processing fast.

  For images, you can add "has_transparency": true in this object to extract if the image contains transparent parts and "dominant_colors": true to extract an array of hexadecimal color codes from the image.

  For videos, you can add the "colorspace: true" parameter to extract the colorspace of the output video.

  For audio, you can add "mean_volume": true to get a single value representing the mean average volume of the audio file.

  You can also set this to false to skip metadata extraction and speed up transcoding.

• result

  boolean (default: false)

  Whether the results of this Step should be present in the Assembly Status JSON

• queue

  "batch"

  Setting the queue to 'batch', manually downgrades the priority of jobs for this step to avoid consuming Priority job slots for jobs that don't need zero queue waiting times

• force_accept

  boolean (default: false)
  

    Force a Robot to accept a file type it would have ignored.
  

  By default Robots ignore files they are not familiar with. 🤖/video/encode, for example, will happily ignore input images.

  With the force_accept parameter set to true you can force Robots to accept all files thrown at them. This will typically lead to errors and should only be used for debugging or combatting edge cases.

• use

  string | Array<string> | Array<object> | 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"
      ]
    }
    

  Tip

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

• format

  … · required

  The desired format for document conversion.

• markdown_format

  "commonmark" | "gfm" (default: "gfm")

  Markdown can be represented in several variants, so when using this Robot to transform Markdown into HTML please specify which revision is being used.

• markdown_theme

  "bare" | "github" (default: "github")

  This parameter overhauls your Markdown files styling based on several canned presets.

• pdf_margin

  string (default: "6.25mm,6.25mm,14.11mm,6.25mm")

  PDF Paper margins, separated by , and with units.

  We support the following unit values: px, in, cm, mm.

  Currently this parameter is only supported when converting from html.

• pdf_print_background

  boolean (default: true)

  Print PDF background graphics.

  Currently this parameter is only supported when converting from html.

• pdf_format

  … (default: "Letter")

  PDF paper format.

  Currently this parameter is only supported when converting from html.

• pdf_display_header_footer

  boolean (default: false)

  Display PDF header and footer.

  Currently this parameter is only supported when converting from html.

• pdf_header_template

  string

  HTML template for the PDF print header.

  Should be valid HTML markup with following classes used to inject printing values into them:

  • date formatted print date
  • title document title
  • url document location
  • pageNumber current page number
  • totalPages total pages in the document

  Currently this parameter is only supported when converting from html, and requires pdf_display_header_footer to be enabled.

  To change the formatting of the HTML element, the font-size must be specified in a wrapper. For example, to center the page number at the top of a page you'd use the following HTML for the header template:

  

  <div style="font-size: 15px; width: 100%; text-align: center;"><span class="pageNumber"></span></div>
  

• pdf_footer_template

  string

  HTML template for the PDF print footer.

  Should use the same format as the pdf_header_template.

  Currently this parameter is only supported when converting from html, and requires pdf_display_header_footer to be enabled.

  To change the formatting of the HTML element, the font-size must be specified in a wrapper. For example, to center the page number in the footer you'd use the following HTML for the footer template:

  

  <div style="font-size: 15px; width: 100%; text-align: center;"><span class="pageNumber"></span></div>
  

Demos

Related blog posts