Catalog

Views for a config

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

Which views exist for this exact car. true = available, "not_allowed" = the view exists but your key may not use it. Feed a view name into the image endpoint.

API v2 add-on: for a car with add-on images a key with the add-on also gets groups — the studio groups, 360 and lifestyle with their number of images (see *API v2 Add-on*), e.g. groups: [{ group: "hero", images: 8 }, { group: "360", images: 64 }, { group: "lifestyle", images: 14 }].

Path parameters

Name	Type	Description
`brand` required	string	Brand name or alias (case-insensitive).
`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?version=v1" \
  -H "x-api-key: YOUR_API_KEY"

200 · Views map.

[
  {
    "id": 911,
    "brand": "Abarth",
    "model": "124_Spider_Abarth",
    "year": 2016,
    "variant": "Basis",
    "trim": "base",
    "resolution": "default",
    "format": "png",
    "views": {
      "front": true,
      "front_left": true,
      "left": true,
      "rear_left": true,
      "rear": true,
      "rear_right": true,
      "right": true,
      "front_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.

{
  "error": "Brand 'Xyz' not found — check /api/brands for valid brands."
}