API v2 Add-on

Lifestyle: resolve an image

GET/api/{brand}/{model}/{year}/{variant}/{trim}/lifestyle/{scene}/{image}

API v2 add-on — keys with v2 access. One lifestyle image with a signed image_url. Lifestyle images are full scenes: they always fill the frame (fit=cover), a background does not apply (errornote B32). Paint (color), lights, size, ratio and format work as everywhere.

Path parameters

Name	Type	Description
`brand` required	string	Brand name (updated catalog naming for add-on cars).
`model` required	string	Model name.
`year` required	integer	Model year (4-digit). If the exact year is missing, the nearest available generation is used (errornote `Y01`).
`variant` required	string	Body variant.
`trim` required	string	Trim level.
`scene` required	string	Scene.
`image` required	string	Image of the scene (see Lifestyle: images of a scene).

Query parameters

Name	Type	Description
`format`	string	Delivery format. `pngwebpjpegavifauto`
`ratio`	string	Aspect ratio (cropped to fill). `1:14:33:216:916:102:121:95:43:44:52:39:16`
`color`	string	Paint: catalog colour name, 6-digit hex or `<finish>_<hex>` (e.g. `metallic_315fbf`).
`color_id`	integer	Paint color by its id from `/api/colors`. Use it when a name exists more than once: the id is unique and never changes. Takes priority over `color`; `0` is the original paint. Unknown or inactive id → same as an unknown name (default paint + errornote `F04`).
`lights`	string	API v2 add-on: headlights on or off. Default `on`: without the parameter the image comes with the lights on wherever the image has them; send `lights=off` for an image without lights. An image with no light variant simply comes without lights; with `lights=on` it also carries errornote `L26`. `onoff`
`windows`	string	API v2 add-on: `see_through` = glass as in the image (default), `dark` = privacy glass you cannot see through. Not available → errornote `W28`. `see_throughdark`
`plate`	string	API v2 add-on: licence plate — `none` = as in the image (default), `blank` = empty plate, `logo` = your logo on the plate (set up on your key; missing → blank + errornote `N30`), `text` = your own text from `plate_text` (must be enabled for your key, see `addon.plate_text` in `/api/me`; otherwise errornote `O31`). `noneblanklogotext`
`plate_text`	string	API v2 add-on: the text for `plate=text` — up to 10 characters: letters, digits, spaces and `-` `.` `&`. Written on the plate as sent (upper and lower case kept), centred and as large as the plate allows. Missing, too long or other characters → `400`.
`size`	string	API v2 add-on: longest side — `2k` 2560 px, `1080p` 1920 px, `720p` 1280 px, `540p` 960 px, `360p` 640 px, `thumb` 320 px. `width` / `height` win over `size`. `2k1080p720p540p360pthumb`
`hotspots`	string	API v2 add-on: add `hotspots` to the response — points of interest (rims, headlights …) as fractions 0–1 of the image, e.g. for interactive viewers. `true`
`version`	string	Results from one version only: `v1` = standard images, `v2` = API v2 add-on (no fallback to standard images). Without it: everything your key allows. Not allowed for your key → `403`. `v1v2`

Request

curl "https://api.vehicleimagery.com/api/bmw/m4/2024/coupe/base/lifestyle/scene/image?format=png&ratio=1:1" \
  -H "x-api-key: YOUR_API_KEY"

200 · Image metadata including the signed `image_url`.

[
  {
    "id": 900000003,
    "brand": "Audi",
    "model": "Q9",
    "year": 2026,
    "variant": "SUV",
    "trim": "Default",
    "version": "v2",
    "view": "lifestyle/garden_pavilion/front_left_glass_wall",
    "resolution": "default",
    "ratio": "default",
    "format": "jpeg",
    "settings": {
      "color": "default",
      "color_id": null,
      "color_manufacture": null,
      "shadow": false,
      "transparency": false,
      "watermark": false,
      "ground": false,
      "mirroring": false,
      "lights": "on",
      "background": null,
      "windows": "see_through",
      "plate": "none",
      "fit": "cover"
    },
    "image_url": "https://api.vehicleimagery.com/image/3/lifestyle/garden-pavilion/front-left-glass-wall.jpeg?kid=…&v=…&exp=…&sig=…"
  }
]

401 · Missing or invalid `x-api-key`.

{
  "error": "Invalid API key"
}

403 · Plan restriction (feature, format or brand not allowed) or blocked request.

{
  "error": "Mirroring is not allowed by your plan."
}

404 · No data for the requested path. For a car path, `not_found` names the level that does not exist and `alternatives` lists what exists there instead.

{
  "error": "Model '9 series' not found for 'BMW' — check /api/BMW for valid models.",
  "code": "model_not_found",
  "not_found": "model",
  "alternatives": {
    "models": [
      "1 series",
      "2 series",
      "3 series",
      "4 series",
      "5 series"
    ]
  }
}