Link Search Menu Expand Document

Using the Bruzu Image API

Generate images Using simple but powerfull API.

Live demo Get an API Key


Table of contents


Authentication

If you want to remove the watermark from your images, you can get an API key by clicking Get API key link on home page.

  • You need to pass the API key same as other parameters.
  • Keep you API Key secure. If exposed, it could be used to call API using your account.

Creating an image

To generate an image, make an HTTP request to the API.

  GET https://img.bruzu.com/?template=...

Parameters

The create image endpoint accepts the following parameters.

Name Type Description
apiKey String API key of your account
template* String This is the unique template id

objectName.propertyName=propertyValue

API support variables in form of objectName.propertyName=Value .

The object (element) value gets replaced with the passed value like while creating your image.

Example

This image was generated with a template.

https://img.bruzu.com/?template=15&top.text=Reminder&middle.text=This%2520too%2520shall%2520pass&bottom.text=OK


Example responses

HTTP/1.1 200 OK
Content-Type: image/png

...png document bytes

STATUS: 400 BAD REQUEST
{
    "error": "Param template is missing"
}
STATUS: 429 TOO MANY REQUESTS
{
    "error": "Plan limit exceeded",
    "statusCode": 429,
    "message": "You've used X of your N request quota. Upgrade via the Dashboard: https://bruzu.com"
}

File formats

The API supports png for now. you’ll get back a png by default.

Additional Query parameters

Query parameters can be added to the URL to adjust your image.

Name Type Description
height Integer The height of the image. Maximum 2000.
width Integer The width of the image. Maximum 2000.
zoom Integer Set the zoom/scale of output image.
download Integer Set download=1 and the image will be served as a downloadable attachment.