Using the Bruzu Image API

Generate images Using simple but powerfull API.

Table of contents

Authentication
Creating an image

Authentication

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

You need to pass the API key same as other parameters. (apiKey)
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/?...

Root Parameters

The create image endpoint accepts the following parameters.

Name	Alias	Type	Description
apiKey	ak	`String`	API key of your account
height	h	`Integer`	The height of the image. Maximum `2000`. Default value is `500`
width	w	`Integer`	The width of the image. Maximum `2000`. Default value is `500`
backgroundColor	bc	`String`	Background Color of the Image. Default is `none` ( transparent )
backgroundImage	bi	`String`	Background Image url.
backgroundImage.opacity	bi.o	`Float`	Opacity or the background image, between 0 and 1. Default value is 1
scale	s	`Integer`	Set the scale of output image.
download	d	`Integer`	Set `download=1` or `d=1` and the image will be served as a downloadable attachment.

Edit it on live demo

https://img.bruzu.com/
?backgroundImage=https://source.unsplash.com/U-Kty6HxcQc/600x400
&backgroundImage.opacity=0.7
&height=400
&width=600
&backgroundColor=red

Element Parameters

Element names can vary form a to z, You can specify many elements with properties like a.text or b.src etc.

Default Element and properties

Root Element all type of other elements inherit from.

Every Type of Element have these properties

Name	Alias	Type	Description	Default value
`[a-z]`.type	`[a-z]`.tp	`String`	Type of element ( `textbox`, `image`, `rect`, `circle`, `line`, `tringle`)	`textbox`( if `.text` exists ), `image`( if `.src` exists )
`[a-z]`.angle	`[a-z]`.a	`Number`	Angle of rotation of an element (in degrees)	`0`
`[a-z]`.color	`[a-z]`.c	`String`	Color of an element. takes css colors, (hax, rgb, rgba or name or color)	`black`
`[a-z]`.backgroundColor	`[a-z]`.bc	`String`	Background color of an element. takes css colors, (hax, rgb, rgba or name or color)	`transparent`
`[a-z]`.height	`[a-z]`.h	`Number`	Element height	`60% of root image height`
`[a-z]`.width	`[a-z]`.w	`Number`	Element width	`80% of root image width`
`[a-z]`.originX	`[a-z]`.ox	`String`	Horizontal origin of transformation of an element (one of “left”, “right”, “center”)	`center`
`[a-z]`.originY	`[a-z]`.oy	`String`	Vertical origin of transformation of an object (one of “top”, “bottom”, “center”)	`center`
`[a-z]`.left	`[a-z]`.x	`Number`	Left position of an element. Note that by default it’s relative to element center ( This can be changed by changing originX of the element).	`(root image width)/2`
`[a-z]`.top	`[a-z]`.y	`Number`	Top position of an element. Note that by default it’s relative to element center. ( This can be changed by changing originY of the element)	`(root image width)/2`
`[a-z]`.opacity	`[a-z]`.o	`Number`	Opacity of an element	`1`
`[a-z]`.scaleX	`[a-z]`.sx	`Number`	Element scale factor (horizontal)	`1`
`[a-z]`.scaleY	`[a-z]`.sy	`Number`	Element scale factor (vertical)	`1`
`[a-z]`.shadow	`[a-z]`.sdw	`String`	Shadow of the element, `offset-x offset-y blur-radius color`	`0px 0px 0px transparent`
`[a-z]`.skewX	`[a-z]`.skx	`Number`	Angle of skew on x axes of an element (in degrees).	`0`
`[a-z]`.skewY	`[a-z]`.sky	`Number`	Angle of skew on y axes of an element (in degrees).	`0`
`[a-z]`.stroke	`[a-z]`.sc	`String`	Element border color	`transparent`
`[a-z]`.strokeWidth	`[a-z]`.sw	`Number`	Width of border.	`0`
`[a-z]`.flipX	`[a-z]`.fx	`Boolean`	When true, an object is rendered as flipped horizontally.	`false`
`[a-z]`.flipY	`[a-z]`.fy	`Boolean`	When true, an object is rendered as flipped vertically.	`false`

Textbox Element and properties

You can define and element type text by using [a-z].type=textbox or [a-z].text={any text}. Textbox Element have these extra properties.

Name	Alias	Type	Description	Default value
`[a-z]`.text	`[a-z]`.t	`String`	Content of the element	` `
`[a-z]`.textAlign	`[a-z]`.ta	`String`	Text alignment. Possible values: `left`, `center`, `right`, `justify`, `justify-left`, `justify-center` or `justify-right`.	`justify`
`[a-z]`.fontSize	`[a-z]`.fs	`Number`	Font size (in pixels).	`40`
`[a-z]`.fontFamily	`[a-z]`.ff	`String`	Font family name ( We support all the Google fonts)	`Times New Roman`
`[a-z]`.fontStyle	`[a-z]`.fontStyle	`String`	Font style . Possible values: “”, “normal”, “italic” or “oblique”.	`normal`
`[a-z]`.fontWeight	`[a-z]`.fw	`Number\|String`	Font weight (e.g. bold, normal, 400, 600, 800)	`normal`
`[a-z]`.charSpacing	`[a-z]`.cs	`Number`	Additional space between characters expressed in thousands of em unit	`0`
`[a-z]`.lineHeight	`[a-z]`.lh	`Number`	Line height	`1.16`
`[a-z]`.linethrough	`[a-z]`.lt	`Boolean`	Text decoration linethrough.	`false`
`[a-z]`.overline	`[a-z]`.ol	`Boolean`	Text decoration overline.	`false`
`[a-z]`.underline	`[a-z]`.ul	`Boolean`	Text decoration underline.	`false`
`[a-z]`.textBackgroundColor	`[a-z]`.tbc	`String`	Background color of text lines	`transparent`

Edit it on live demo

https://img.bruzu.com/
?backgroundColor=white
&a.text=Bruzu
&a.textAlign=center
&a.fontFamily=Rye
&a.fontSize=100
&a.color=red

Image Element and properties

You can define and element type text by using [a-z].type=image or [a-z].src={url link to the image}. Image Element have these extra properties.

Name	Type	Description	Default value
`[a-z]`.src	`String`	Image url.	`null`
`[a-z]`.cropX	`Number`	Image crop in pixels from original image size.	`0`
`[a-z]`.cropY	`Number`	Image crop in pixels from original image size.	`0`

Edit it on live demo

https://img.bruzu.com/
?backgroundColor=white
&a.type=image
&a.src=https://source.unsplash.com/200x300/?rose
&a.height=300
&a.width=200

Rectangle Element and properties

You can define and element type text by using [a-z].type=rect. Rectangle Element have these extra properties.

Name	Type	Description	Default value
`[a-z]`.rx	`Number`	Horizontal border radius.	`0`
`[a-z]`.ry	`Number`	Vertical border radius.	`0`

Edit it on live demo

https://img.bruzu.com/
?backgroundColor=white
&a.type=Rect
&a.height=100
&b.width=400
&a.color=pink

Circle Element and properties

You can define and element type text by using [a-z].type=circle. Rectangle Element have these extra properties.

Name	Alias	Type	Description	Default value
`[a-z]`.radius	`[a-z]`.r	`Number`	Radius of this circle.	`0`

Edit it on live demo

https://img.bruzu.com/
?backgroundColor=white
&a.type=circle
&a.radius=200
&a.color=rgb(209,249,62)

Line Element and properties

You can define and element type text by using [a-z].type=circle. Rectangle Element have these extra properties.

Name	Type	Description	Default value
`[a-z]`.x1	`Number`	x value or first line edge	`0`
`[a-z]`.y1	`Number`	y value or first line edge	`0`
`[a-z]`.x2	`Number`	x value or second line edge	`0`
`[a-z]`.y2	`Number`	y value or second line edge	`0`

Edit it on live demo

https://img.bruzu.com/
?backgroundColor=black
&a.type=line
&a.x1=20
&a.y1=20
&a.x2=200
&a.y2=200
&a.stroke=pink
&a.strokeWidth=2

Triangle Element and properties

You can define and element type text by using [a-z].type=triangle. Triangle Element have these extra properties.

Name	Alias	Type	Description	Default value
`[a-z]`.height	`[a-z]`.h	`Number`	Height of triangle	`100`
`[a-z]`.width	`[a-z]`.w	`Number`	Width of triangle	`100`

Edit it on live demo

https://img.bruzu.com/
?backgroundColor=white
&a.type=triangle
&a.width=300
&a.height=200
&a.color=pink

Example

This image was generated with a template.

https://img.bruzu.com/
?backgroundImage=https://source.unsplash.com/500x500/?gradient
&a.type=rect
&a.originX=left
&a.originY=top
&a.left=73
&a.top=224
&a.width=354
&a.height=51
&a.fill=white
&a.rx=5
&a.ry=5
&b.originX=left
&b.originY=top
&b.left=385.98
&b.top=238.66
&b.width=100
&b.height=100
&b.fill=rgb(0,0,0)
&b.scaleX=0.23
&b.scaleY=0.23
&b.src=https://i.imgur.com/8tNQSOl.png
&c.text=Think! Why?
&c.originX=left
&c.originY=center
&c.left=89.67
&c.top=249.96
&c.width=280
&c.height=22.6
&c.maxHeight=30
&c.fontSize=20
&c.fontWeight=400
&c.fontFamily=Roboto
&c.fontStyle=normal
&c.lineHeight=1.16

Example responses

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

...png document bytes

STATUS: 400 BAD REQUEST

{
    "error": "Something 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.