- Docs
- Parameters
- transparent_background
transparent_background
Render transparent PNGs without adding special background CSS
How it works
Section titled “How it works”Set transparent_background to true on a create image request to omit the page background from the rendered image. The parameter works with both HTML/CSS images and URL screenshots.
When the parameter is omitted, the existing CSS-based transparent background method continues to work. Set it explicitly to false when you want an opaque background even if the request CSS sets the body background to transparent.
Values
Section titled “Values”| Value | Description |
|---|---|
true |
Render the image with a transparent background |
false |
Render the image with an opaque background |
| omitted | Use the existing CSS-based background behavior |
HTML/CSS example
Section titled “HTML/CSS example”{ "html": "<div class='logo'>Your logo</div>", "css": ".logo { padding: 24px; }", "transparent_background": true}URL screenshot example
Section titled “URL screenshot example”{ "url": "https://example.com", "transparent_background": true}cURL example
Section titled “cURL example”curl -X POST https://hcti.io/v1/image -u 'UserID:APIKey' \ --data-urlencode html="<div class='logo'>Your logo</div>" \ --data transparent_background=trueThe parameter can also be saved on a template and used as a default or variation option in an image batch.
For more examples and the existing CSS method, see the transparent background guide.
Need help?
Talk to a human. Email support@htmlcsstoimage.com and we’ll help you get started.