POST
/
v1
/
web
/
html_to_any

​
Body

html
string

The HTML to convert to image.

url
string

The HTML to convert to image.

goto_options
object

This parameter allows you to specify custom page-load behavior.

scale
number
default: "1"

The device scale factor. The default value is 1.

full_page
boolean

Whether to capture the full page.

omit_background
boolean

Whether to omit the background.

quality
number
default: "75"

The quality of the image. 0-100.

type
string
default: "png"

The type of the image. Can be one of the following:

  • jpeg
  • png
  • webp
  • pdf
width
number
default: "1920"

The width of the image.

height
number
default: "1080"

The height of the image.

size_preset
string

The screen size preset to use. Supported values are:

  • QVGA
  • VGA
  • SVGA
  • HD
  • HD+
  • SXGA
  • FHD
  • 2K
  • 2K QHD
  • 5K
  • 4K UHD

See the full list of screen size presets here

pdf_display_header_footer
boolean
pdf_print_background
boolean
pdf_page_range
string
is_mobile
boolean

Sets whether the meta viewport tag is taken into account.

dark_mode
boolean

Sets the color scheme to dark mode.

use_graphic_renderer
boolean
default: "false"

Enables webgl, gpu and other 3d-apis. This option when enabled, can impact performance and increase api latency.

x-api-key
string
required

Your JigsawStack API key

​
Response

success
boolean

Indicates whether the call was successful.

Was this page helpful?

ScrapeCreate Prompt