Skip to content
On this page

Banner

Generate a banner image, useful for creating open graph image etc.

Endpoint

GET or POST https://api.browserku.com/banner

URL Query or Request Body

template

  • Type: string

The HTML template, we support Vue syntax using petite-vue and TailwindCSS class name.

data

  • type: object?

Data available in the template.

fonts

  • Type: Record<string, string>?

Make google fonts available as class names.

The default config:

json
{
  "roboto": "Roboto:400,700",
  "lobster": "Lobster:400,700",
  "open-sans": "Open Sans:400,700",
  "lato": "Lato:400,700"
}

This allows you use class names font-roboto, font-lobster, font-open-sans, font-lato in your template.

The value should be a Google font name, and optionally font weights separated by comma.

noCache

  • Type: boolean?

Skip cache (if exists).

ttl

  • Type: string?
  • Default: 1d

Set how long the response should be cached for.

response

  • Type: string?

Use a property in response data as the actual response.

If you want to render the chart image as the response, set response to banner.url.