Every address, in one page.

A publishable key, sent here or in the Authorization: Bearer header — served exactly alike either way. A secret key goes in the Authorization: Bearer header only: a secret key sent here is refused invalid-key, and the key is flagged for regeneration. A key presented in both places at once is refused invalid-key. A key is required on every request — the one thing we cannot guess.

The id of a vehicle in the catalogue — the deterministic way to ask: no matching, no guessing. It wins outright: a make, model, market or vehicle_type sent beside it is reported ignored and the id decides what is served, with the difference ignored, not-offered, and nothing is refused.

An id we hold: that exact vehicle. Colour, angle, size and the rest still follow the usual never-refuse rules.

An id we issued, vehicle still being made: a stand-in of its shape, with a difference saying the vehicle is not in the library yet (not-in-library-yet).

An id we issued and have since withdrawn or replaced: still a picture. A replaced id quietly leads to its replacement; a withdrawn one is served a stand-in of the right shape, with the difference asset_id, substituted, blocked.

An id we never issued: refused asset-id-not-found, with the closest real ids suggested when any are close enough — the one place a mistake is made loud.

The vehicle's make, expected unless asset_id is given. Left out, a generic vehicle, with the difference make, assumed, not-specified. A make we do not recognise is served a generic vehicle, with the difference make, substituted, not-recognised. A make on the do-not-make list whose vehicle we do not hold is served down the matching ladder, with the difference make, substituted, blocked.

The vehicle's model, expected unless asset_id is given. Left out, a generic vehicle — of the body style asked when the request gave one — with the difference model, assumed, not-specified. A model we do not recognise is served a generic vehicle of the right kind where we can tell, with the difference model, substituted, not-recognised. A body style typed into the model is recognised: model=civic hatchback is treated as model=civic&body=hatchback; a model name already on our lists is never cut.

The model year. Left out, the newest run of years we hold for that model, with the difference year, assumed, not-specified; for a vehicle we have never made, the model's newest generation. A year outside every run we hold is served the nearest run of years, with the difference year, substituted, not-in-library-yet, at match level nearest-years.

One of the sixty body styles of the five kinds, or a folded alias. A body we do not recognise is served the closest of the sixty — of the sent kind's own when a valid vehicle_type was sent — with the difference body, substituted, not-recognised. A body style of another kind than the confirmed model's is served the model's own body style, with the difference body, substituted, not-offered. The sixty, by kind: car (no default: a car with no shape known is served a plain generic vehicle): sedan, hatchback, suv, wagon, minivan, pickup, van, bus, coupe, convertible, microcar, campervan, semi_truck, box_truck, dump_truck, waste_truck, cargo_trike, rickshaw, trike, tadpole, autocycle, utv, quad, sport_utv; motorcycle (default standard): standard, sport, cruiser, touring, adventure, scooter, off_road; boat (default bowrider): bowrider, fishing, console, pontoon, watercraft, cabin_boat, yacht, sailboat, catamaran; heavy_machine (default tractor): tractor, crawler, combine, sprayer, paddy, excavator, mini_digger, loader, skid_steer, backhoe, telehandler, bulldozer, grader, hauler; aircraft (default single_prop): single_prop, twin_prop, turboprop, bizjet, airliner, helicopter.

body=sedan

Which market's design is wanted where one name means different cars in different markets: us, europe, japan, china, india or south-korea. Left out, the account's own vehicle market, and the US design when that is empty too. It changes nothing for a vehicle sold as one design everywhere. South Korea reads as south-korea, with no difference. A value that is still not one of the six is served the market the option would have fallen back to, with the difference market, substituted, not-recognised.

The kind of vehicle wanted: car (Cars — trucks, three-wheelers and ATVs among them), motorcycle, boat, heavy_machine (farm and construction machines) or aircraft (planes and helicopters). Left out, the kind is decided from the vehicle named — the asset, the body style, the confirmed model's kind, a make that builds one kind only. Heavy Machines reads as heavy_machine, with no difference. Other words for a kind — truck, three_wheeler, atv, farm, construction — are read as the kind they belong to, with no difference; they are never listed as choices. A value that is still not one of the five is set aside and the vehicle served as though the kind were left out, with the difference vehicle_type, substituted, not-recognised. A kind the vehicle contradicts is set aside, never refused, with the difference vehicle_type, ignored, not-offered.

Each kind's body styles, the first its default when no shape is known:

• car: sedan, hatchback, suv, wagon, minivan, pickup, van, bus, coupe, convertible, microcar, campervan, semi_truck, box_truck, dump_truck, waste_truck, cargo_trike, rickshaw, trike, tadpole, autocycle, utv, quad, sport_utv (no default: a plain generic vehicle)
• motorcycle: standard, sport, cruiser, touring, adventure, scooter, off_road
• boat: bowrider, fishing, console, pontoon, watercraft, cabin_boat, yacht, sailboat, catamaran
• heavy_machine: tractor, crawler, combine, sprayer, paddy, excavator, mini_digger, loader, skid_steer, backhoe, telehandler, bulldozer, grader, hauler
• aircraft: single_prop, twin_prop, turboprop, bizjet, airliner, helicopter

A 17-character vehicle identification number — digits and the letters except I, O and Q — naming the vehicle instead of by make and model or by catalogue identifier. Sent beside asset_id, the id decides and the number is never decoded, with the difference vin, ignored, not-offered. A decoded number sent beside make and model decides, and each of them is reported with the difference ignored, not-offered. A number that cannot be turned into a vehicle, or one failing the character or length check, is served a plain generic vehicle, with the difference vin, substituted, vin-not-decodable; when a make and model came with it, the make and model decide instead. A number the free United States decoder cannot resolve while the worldwide vehicle lookup is off is served a plain generic vehicle, with the difference vin, substituted, vin-outside-united-states-lookup-off. A number is never refused, and never kept.

A colour name on the named-colour list, matched whatever its capitals, or any six-character colour code. Left out, silver. A name not on the list is served silver, with the difference color, substituted, not-recognised. In basic settings the colour becomes silver, black or white — a basic colour is kept — with the difference color, restricted, allowance-used-up.

One of the seven angles: front, front-3q, side, rear-3q, rear, side-right or hero-front. Left out, front-3q — the front three-quarter, from the vehicle's left. imagin.studio's numeric angle values are translated. A word that is not one of ours, or a number we cannot match, is served front-3q, with the difference angle, substituted, not-offered. A real angle this vehicle does not have yet is served the front three-quarter, with the difference angle, substituted, not-in-library-yet, and on a paid plan it is queued. In basic settings the angle becomes the default three-quarter front, with the difference angle, restricted, allowance-used-up. Asking for another angle never costs a new vehicle on its own: every opening-day vehicle carries all seven, so another angle of one of those is never a new vehicle; for a vehicle drawn to order, an angle not yet drawn uses no new vehicle either; and a vehicle never drawn at all is one new vehicle, made at all seven angles together. Every angle costs the same.

The width in pixels. Left out, 1536 — full settings serve up to 3072 on request. Above 3072 in full settings is served 3072, with the difference width, substituted, not-offered. In basic settings the width is capped at 800: any width above 800 is served 800, with the difference width, restricted, allowance-used-up.

webp, png or jpg. Left out, webp. An unrecognised value is served webp, with the difference format, substituted, not-recognised. In basic settings the format is WebP or JPEG: a png is served webp, with the difference format, restricted, allowance-used-up. Never a refusal either way.

transparent or a colour code. Left out, transparent. format=jpg with background=transparent is served white, with the difference background, substituted, not-offered. In basic settings the background becomes white, with the difference background, restricted, allowance-used-up.

Only the literal string true mirrors the picture; left out, the vehicle faces left. Anything else is read as absent, with no difference.

Up to 10 characters — the letters A to Z, digits, spaces and hyphens — drawn on the plate, trimmed of spaces at either end and upper-cased first. Left out or empty, a blank plate. A character outside the list is dropped and the rest served, and text longer than 10 characters is cut to the first 10 — either way with one difference, plate_text, substituted, not-offered. The text is shown back in the live answer and kept nowhere. In basic settings plate text becomes none, with the difference plate_text, restricted, allowance-used-up.

blank — the plate as the picture has it drawn; plain — your text on a plain white plate; custom — a plate design of your own, not offered yet, so it is served the blank plate with the difference plate_style, ignored, not-offered. Left out, blank. An unrecognised value is served blank, with the difference plate_style, substituted, not-recognised. In basic settings the plate style becomes blank, with the difference plate_style, restricted, allowance-used-up.

Your own short label, up to 80 characters, echoed in Hyke-Label and kept on the request's record. Longer is cut to the first 80, with no difference, because a label is not a rendering option; an empty label= is no label.

One of the five kinds. Only makes with a ready vehicle of that kind are listed, and models_ready counts that kind's models; a make that builds several kinds is listed under each. A value that is not one of the five answers an empty list, never a refusal. Left out: every kind.

A make id from GET /v1/makes — honda, toyota, nissan.

One of the five kinds. Narrows the list to that kind; a value that is not one of the five answers an empty list, never a refusal.

A make id from GET /v1/makes.

A model id from GET /v1/makes/{make}/models.

One of the five kinds. Narrows the list to that kind; a value that is not one of the five answers an empty list, never a refusal.

The value the request's own Hyke-Request-Id header carried.