API v2 Add-on

Lifestyle: images of a scene

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

API v2 add-on — keys with v2 access. The images of one lifestyle scene (views). Resolve one with *Lifestyle: resolve an image*.

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 (see Lifestyle: scenes).

Query parameters

Name	Type	Description
`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?version=v1" \
  -H "x-api-key: YOUR_API_KEY"

200 · Images of the scene.

[
  {
    "id": 900000003,
    "brand": "Audi",
    "model": "Q9",
    "year": 2026,
    "variant": "SUV",
    "trim": "Default",
    "group": "lifestyle",
    "scene": "garden_pavilion",
    "resolution": "default",
    "format": "png",
    "views": {
      "front_left_glass_wall": true,
      "front_left_leaves": true,
      "front_right_leaves": true,
      "front_rocks": true
    }
  }
]

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"
    ]
  }
}