AeroModel

AeroModel

Documentation

background

Solid color background in hexadecimal. Composed on the fly.

Format

Hex color on 3, 4, 6 or 8 characters, with or without #. The # must be URL-encoded as %23 in a URL.

FormatExample
3 hex#fff (white)
6 hex#001a33 (navy blue)
4 hex (RGBA)#fffe (white at 93% opacity)
8 hex (RGBA)#001a33ff

API examples

GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&airline=AF&background=%23ffffff
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&airline=AF&background=%23001a33
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A380&airline=EK&background=%23f5f5f0
GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=B789&airline=UA&background=%23000000

Note: %23 = URL encoding of #.

Visuals (A320 Air France)

background=%23ffffffbackground=%23001a33background=%231f8a3cNo background (transparent)

Use cases

ContextColor
Dark marketing background#001a33, #0a0a0f
Clean light background#f5f5f0, #ffffff
Airline brand colorhex of the primary brand color
Social network mockupcolor from the post palette

Errors

GET https://api.aeromodel.dash-systems.fr/v1/images/plane?api-key=YOUR_KEY&plane=A320&background=red&format=json
→ 400 { "error": "invalid render options", "details": ["background must be a hex color"] }

Response header

x-compose-background: solid:#001a33

For a gradient

Use backgroundGradient instead. If both are provided, backgroundGradient wins.

See also