POST /web/html_to_any

post/web/html_to_any

Request

  • Base URL: https://api.jigsawstack.com/v1
  • URL: https://api.jigsawstack.com/v1/web/html_to_any
  • Auth: API key in header x-api-key

Request body

htmlstring nullable
urlstring nullable
full_pageboolean
omit_backgroundboolean
qualitynumber
type'png' | 'jpeg' | 'webp' | 'pdf'
widthnumber
heightnumber
scalenumber
is_mobileboolean
dark_modeboolean
use_graphic_rendererboolean
size_preset'QVGA' | 'VGA' | 'SVGA' | 'HD' | 'SXGA' | 'HD+' | 'FHD' | '2K' | '2K QHD' | '5K' | '4K UHD' | '8K UHD' | 'iPhone 13 Pro' | 'iPhone XR' | 'iPhone XS' | 'iPhone XS Max' | 'iPhone X' | 'iPhone 8 Plus' | 'iPhone 8' | 'iPhone 7 Plus' | 'iPhone 7' | 'iPhone 6 Plus/6S Plus' | 'iPhone 6/6S' | 'iPhone 5' | 'iPod Touch' | 'iPad Pro' | 'iPad Third & Fourth Generation' | 'iPad Air 1 & 2' | 'iPad Mini 2 & 3' | 'iPad Mini' | 'Nexus 6P' | 'Nexus 5X' | 'Google Pixel 7 Pro' | 'Google Pixel 4 XL' | 'Google Pixel 4' | 'Google Pixel 3a XL' | 'Google Pixel 3a' | 'Google Pixel 3 XL' | 'Google Pixel 3' | 'Google Pixel 2 XL' | 'Google Pixel XL' | 'Google Pixel' | 'Samsung Galaxy Note 10+' | 'Samsung Galaxy Note 10' | 'Samsung Galaxy Note 9' | 'Samsung Galaxy Note 5' | 'LG G5' | 'One Plus 3' | 'Samsung Galaxy S9+' | 'Samsung Galaxy S9' | 'Samsung Galaxy S8+' | 'Samsung Galaxy S8' | 'Samsung Galaxy S7 Edge' | 'Samsung Galaxy S7' | 'Nexus 9' | 'Nexus 7 (2013)' | 'Pixel C' | 'Samsung Galaxy Tab 10' | 'Chromebook Pixel' | 'Letter' | 'Legal' | 'Tabloid' | 'Ledger' | 'A0' | 'A1' | 'A2' | 'A3' | 'A4' | 'A5' | 'A6' | 'Letter landscape' | 'Legal landscape' | 'Tabloid landscape' | 'Ledger landscape' | 'A0 landscape' | 'A1 landscape' | 'A2 landscape' | 'A3 landscape' | 'A4 landscape' | 'A5 landscape' | 'A6 landscape' nullable
pdf_display_header_footerboolean
pdf_print_backgroundboolean
pdf_page_rangestring nullable
return_type'url' | 'base64' | 'binary'

Response

Successful response

successboolean

Whether the request was successful

dataobject

Response data

Changes

No recorded changes to this operation across all 1 revision of this API.