A Hyke Studio picture is an address. Put the address in an image tag and the picture appears on your page. There is nothing to download first and nothing to store.
1. Get your key
Sign up free and copy your publishable key from the dashboard. A publishable key is made to sit in a web page: it can only fetch pictures, and you can lock it to your own website on the Keys screen. Your secret key is different. It never goes in a web page or in an address.
2. Put the address in an image tag
<img src="https://api.hykestudio.com/v1/vehicle?key=YOUR_KEY&make=toyota&model=corolla&year=2020&color=7B1E3C&angle=front-3q"
alt="Toyota Corolla, maroon, front three-quarter view">
Shown here at up to 800 px wide · delivered at 1,536 px by default, up to 3,072 px. Any softness is only this page's display size.
A sample from our library, made for our own pages: our plate and mark on it never appear on pictures you request.
Replace YOUR_KEY with your publishable key. The address answers with the picture itself, not a link to a picture: a WebP 1536 pixels wide, on a transparent background, unless you ask for something else.
3. Choose what the picture shows
Every choice is one more option on the address:
| Option | What it does | Left out |
|---|---|---|
make, model |
The vehicle | — |
year |
Which run of years | The newest we hold |
color |
A colour name or any six-character colour code | Silver |
angle |
One of the seven angles | front-3q |
width |
Up to 3072 pixels | 1536 |
format |
webp, png or jpg |
webp |
background |
transparent or a colour code |
Transparent (white for a JPEG) |
plate_text |
Your own text on the plate | A blank plate |
The other guides take each of these in turn.
4. A picture always comes back
A value we cannot use is replaced, never refused: color=banana gets silver. The Hyke-Differences header counts what we changed, and the address in Hyke-Details explains each change. A vehicle we do not hold yet gets the nearest match or a stand-in straight away; on a paid plan the real vehicle is made within the hour, and the same address then shows it.
Only four things stop a picture: a missing or wrong key, a suspended account, requests arriving too fast, and, on the free plan, a month's basic requests used up.
5. How long a browser keeps it
A picture of exactly the vehicle you asked for is kept by the browser for a day. Anything else, a stand-in or a picture in basic settings, is kept for five minutes, so the real picture takes over soon after it is ready. If your own server keeps a copy, it may keep it for up to 7 days, then must delete it or request the picture again (Terms of Use, section 8).
6. What the picture is
Every picture is a computer-generated representation of the vehicle, not a photograph. Every response carries the same sentence in its Hyke-Disclosure header:
Computer-generated representation. Not supplied by or affiliated with any manufacturer.