Little Eagle Reference

Images are generated on-the-fly by our servers. Construct a URL incorporating your project ID, choice of template, input parameters, and signature.

We’ll generate an image dynamically on the first request, and then cache by input parameters for future requests.

Project /1/p/[projectID]/[template]

Generate an image for a particular project. Requires a signature, which is a HMAC-256 digest of the combined path & query params concatenated together.

URL Structure

https://cdn.littleeagle.io/1/p/[projectID]/[template]?[...params]
projectID
The ID of your project.
template
One of overlay, overlay-left, message, or plain.
params
See next section below.

URL Search Params

The following URL search params are supported:

w
The width of your image in pixels.
h
The height of your image in pixels.
format
The image format, either png or jpeg.
bg-color
The background color in hex RGB. For example: #4598ab
img
The main hero image. Pass a full URL.
logo
Your logo image. Pass a full URL.
logo2
Your second logo image. Only supported by overlay-left template. Pass a full URL.
logo-pos
Your logo position. One of topLeft, topRight, bottomLeft, bottomRight.
t1
The first piece of text.
t1-size
The first piece of text’s font size. For example: 24
t1-color
The first piece of text’s color in hex RGB.
t2
The second piece of text.
t2-size
The second piece of text’s font size.
t2-color
The second piece of text’s color in hex RGB.
s
The HMAC-256 digest of the combined path + query params. Should be specified last.

GitHub /1/github/[username]

URL Structure

https://cdn.littleeagle.io/1/github/[username]?[...params]
username
Your username or org name from GitHub.
params
See next section below.

URL Search Params

The following URL search params are supported:

w
The width of your image in pixels.
h
The height of your image in pixels.
format
The image format, either png or jpeg.
author-name
The name or the author to display. Uses the provided username if not specified.
website
The website shown under the author.
bg-color
The background color in hex RGB. For example: #4598ab
t1
The first piece of text.
t1-size
The first piece of text’s font size. For example: 24
t1-color
The first piece of text’s color in hex RGB.
t2
The second piece of text.
t2-size
The second piece of text’s font size.
t2-color
The second piece of text’s color in hex RGB.