You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -44,11 +44,11 @@ The create image endpoint accepts the following parameters. Accepted as either `
44
44
45
45
| Name | Type | Description |
46
46
|:-------------|:------------------|:------|
47
-
|**html**<spanclass="text-red-200">*</span> |`String`| This is the HTML you want to render. You can send an HTML snippet \(`<div>Your content</div>`\) or an entire webpage. |
47
+
|**html**†|`String`| This is the HTML you want to render. You can send an HTML snippet \(`<div>Your content</div>`\) or an entire webpage. |
48
48
|**css**|`String`| The CSS for your image. When using with `url` it will be injected into the page. |
49
-
|**url**<spanclass="text-red-200">*</span> |`String`| The fully qualified URL to a public webpage. Such as `https://htmlcsstoimage.com`. When passed this will override the html param and will generate a screenshot of the url. |
49
+
|**url**†|`String`| The fully qualified URL to a public webpage. Such as `https://htmlcsstoimage.com`. When passed this will override the html param and will generate a screenshot of the url. |
50
50
51
-
{% include hint.md title="Required params" text="For creating an image, either `url`or`html`are required. `css` is optional." %}
51
+
{% include hint.md title="Required params" text="† Either `url`OR`html`is required, but not both. `css` is optional." %}
52
52
53
53
<hr>
54
54
@@ -61,7 +61,7 @@ Optional parameters for greater control over your image.
61
61
|**google_fonts**|`String`|[Google fonts](/guides/using-google-fonts/) to be loaded. Example: `Roboto`. Multiple fonts can be loaded like this: `Roboto|Open Sans` |
62
62
|**selector**|`String`| A [CSS selector](/guides/selector/) for an element on the webpage. We'll crop the image to this specific element. For example: `section#complete-toolkit.container-lg`|
63
63
|**ms_delay**|`Integer`| The number of milliseconds the API should delay before generating the image. This is useful when waiting for JavaScript. We recommend starting with `500`. Large values slow down the initial render time. [Learn more](/parameters/ms_delay/). |
64
-
|**device_scale**|`Double`|This adjusts the pixel ratio for the screenshot. Minimum: `1`, Maximum: `3`. [Learn more](/parameters/device_scale/). |
64
+
|**device_scale**|`Double`|Controls the image resolution by adjusting the pixel ratio. Minimum: `1`, Maximum: `3`. Higher values increase image quality and file size. For example, `2` will double the resolution. [Learn more](/parameters/device_scale/). |
65
65
|**render_when_ready**|`Boolean`| Set to true to control when the image is generated. Call `ScreenshotReady()` from JavaScript to generate the image. [Learn more](/parameters/render_when_ready/). |
66
66
|**full_screen**|`Boolean`| When set to true, the API will generate an image of the entire height of the page. |
67
67
|**viewport_width**|`Integer`| Set the width of Chrome's viewport. This will disable automatic cropping. Both height and width parameters must be set if using either. |
0 commit comments