HTML/CSS to Image integration (Developer Tools, Design & Media). Imported from open-connector.
https://hcti.io/v1/image
| Param | Type | Required | Description |
|---|---|---|---|
| html | string | optional | The HTML snippet or complete webpage markup to render. |
| url | string | optional | The public webpage URL to screenshot. This overrides html upstream. |
| css | string | optional | CSS to render with HTML snippets or inject into URL screenshots. |
| google_fonts | string | optional | Google Fonts to load, such as Roboto or multiple font families separated by a p… |
| selector | string | optional | A CSS selector for an element to crop the generated image to. |
| ms_delay | integer | optional | The fixed delay in milliseconds before generating the image. |
| max_wait_ms | integer | optional | The maximum time in milliseconds to wait before taking the screenshot. |
| device_scale | number | optional | The Chrome device scale factor. Higher values increase resolution and file size. |
| render_when_ready | boolean | optional | Whether page JavaScript must call ScreenshotReady() before the image is generat… |
| full_screen | boolean | optional | Whether to generate an image of the entire page height. |
| block_consent_banners | boolean | optional | Whether to automatically hide common cookie consent banners and popups. |
| viewport_width | integer | optional | The Chrome viewport width in pixels. Set with viewport_height to disable automa… |
| viewport_height | integer | optional | The Chrome viewport height in pixels. Set with viewport_width to disable automa… |
| viewport_mobile | boolean | optional | Whether Chrome should emulate a mobile viewport. |
| viewport_landscape | boolean | optional | Whether Chrome should emulate a landscape mobile viewport. |
| viewport_touch | boolean | optional | Whether Chrome should emulate touch input support. |
| color_scheme | string | optional | The Chrome color scheme to use while rendering websites that support prefers-co… |
| timezone | string | optional | The IANA timezone identifier used while rendering the image. |
| disable_twemoji | boolean | optional | Whether to use native emoji fonts instead of Twemoji. |
| proxy_id | string | optional | The configured HTML/CSS to Image dashboard proxy ID for outbound requests. |
/v1/image/batch
| Param | Type | Required | Description |
|---|---|---|---|
| default_options | object | optional | Default image creation options applied to every batch variation. |
| variations | array | required | The image variations to create, up to 25. |
/v1/image/{image_id}
| Param | Type | Required | Description |
|---|---|---|---|
| image_id | string | required | The image identifier to delete. |
/v1/image/batch
| Param | Type | Required | Description |
|---|---|---|---|
| ids | array | required | The image identifiers to delete. |
/v1/usage