Convert - HTML to Image

** AVAILABLE MAY / JUNE 2025 **

Overview

The 'Convert - HTML to Image' flow action converts either the HTML data obtained from the specified URL or the HTML data provided to a JPG image.

Credit Count

This action consumes 1 credit per operation.

Note, different Encodian actions can consume different number credits. Please always check the action specific documentation and read What is an Encodian Action for a full description of how credits are consumed.

Default Parameters

The default 'Convert - HTML to Image' flow action parameters are detailed below:

• File Content: Optional - The file content of the source HTML file
• HTML Data: Optional - The HTML which will be converted to an image
• URL: Optional - The URL of the web page to convert to an image
• Width: Set the image width (pixels), 595 by default
• Height: Set the image height (pixels), 842 by default

Advanced Parameters

The advanced 'Convert - HTML to Image' flow action parameters are detailed below:

• CSS Type: Set whether the standard or print style sheets should be used for HTML conversion
• Decode HTML Data: Set whether the data provided in the 'HTML Data' field should be decoded
• Delay: Set the delay in milliseconds between the HTML being received and the conversion to allow time for JavaScript to load.
• Enable Hyperlinks: Enable or disable hyperlinks.
• Enable Javascript: Enable or disable javascript.
• Margin - Bottom: Set the bottom margin value (pixels) The default value is set to 0.
• Margin - Left: Set the left margin value (pixels) The default value is set to 0.
• Margin - Right: Set the right margin value (pixels) The default value is set to 0.
• Margin - Top: Set the top margin value (pixels) The default value is set to 0.
  
• Rotation Angle: Set number of degrees to rotate the image

Return Parameters

The 'Convert - HTML to Image' flow action returns the following data. 

Standard Return Values

• FileContent - The JPG image.
• OperationId - The unique ID assigned to this operation.
• HttpStatusCode - The HTTP Status code for the response.
• HttpStatusMessage - The HTTP Status message for the response.
• Errors - An array of error messages should an error occur.
• Operation Status - Indicates whether the operation has been completed, has been queued or has failed.