Heroimg is an image generator that creates images with text on them. You can use it to create images for your social media posts, blog posts, or any other purpose.
Heroimg currently has only one API endpoint available, you should use the GET method to access it:
| Method | URL | Description |
|---|---|---|
| GET | /hero | Generate an image with text on it |
/hero parametersThe following parameters are available for the API:
| Parameter | Type | Description | Options | Default |
|---|---|---|---|---|
title |
string | Headline text to be displayed on the image | / | NEED A TITLE |
subtitle |
string | Subtitle or copyright text to be displayed on the image | / | / |
style |
string | Style of the image background |
blobwaveblurry-gradientblob-scenelayered-waveslayered-peaks
|
blurry-gradient |
shape |
string | Shape of the image |
16:94:31:1 |
16:9 |
fontSize |
number | Font size of the headline text | / | 96 |
subFontSize |
number | Font size of the subtitle text | / | fontSize / 2 |
fontColor |
string | Color of the text | / | #ffffff |
The API returns an image with the specified text on it. The image is in PNG format.
If the parameters are invalid, the API returns a 400 Bad Request response. If the image cannot be generated, the API
returns a 500 Internal Server Error response.