API v2 Add-on

Studio group: list its images

GET/api/{brand}/{model}/{year}/{variant}/{trim}/hero

API v2 add-on — keys with v2 access. The images of one studio group. hero stands for any studio group of the car; which ones a car has is in groups on the trim endpoint.

Group	What it shows	Image names (example car)
`hero`	Hero shots: three-quarter views, some taken from ground level	`front_left`, `front_left_ground`, `front_right`, `front_right_ground`, `left_ground`, `rear_left`, `rear_right`, `right_ground` (8)
`steered`	Front wheels turned, from three camera heights	`front_left`, `front_left_eye`, `front_left_high`, `front_left_low`, `front_right`, … (8)
`extra`	More angles: every side and corner from three camera heights, corners also at 30° and 45°	`front_eye`, `front_high`, `front_low`, `front_left_30`, `front_left_30_eye`, `front_left_45_high`, `rear_right_45_low`, `left_eye` … (56)
`drone`	From above: angled shots, steep views and straight from the top	`front_left`, `front_right`, `front_steep`, `rear_left`, `rear_right`, `rear_steep`, `top` (7)

Image names are built from the side (front, front_left, left, rear_right …) plus suffixes: _eye = eye level, _high = camera above, _low = camera low, _ground = at ground level, _30 / _45 = corner view at 30° / 45°, _steep = steep from above, top = straight down. The exact list per car is always in views of this endpoint.

Pick an image from views and resolve it with *Resolve a studio group image*, e.g. GET /api/Audi/Q9/2026/SUV/Default/hero/front_left.

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.

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/hero?version=v1" \
  -H "x-api-key: YOUR_API_KEY"

200 · Images of the group.

[
  {
    "id": 900000003,
    "brand": "Audi",
    "model": "Q9",
    "year": 2026,
    "variant": "SUV",
    "trim": "Default",
    "group": "hero",
    "resolution": "default",
    "format": "png",
    "views": {
      "front_left": true,
      "front_left_ground": true,
      "front_right": true,
      "front_right_ground": true,
      "rear_left": true,
      "rear_right": 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"
    ]
  }
}