API v2 Add-on

Resolve a studio group image

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

API v2 add-on — keys with v2 access. One image of a studio group: hero (hero shots, some from ground level), steered (front wheels turned), extra (more angles from three camera heights, corners also at 30° and 45°), drone (from above). The groups and their image names are explained on *Studio group: list its images*.

GET …/{trim} lists the groups a car has (groups), GET …/{trim}/{group} lists the images of one group (views). Then resolve one here. Takes every image option, including the add-on options (lights, background, hex color, windows, plate, fit, size, hotspots).

Example: GET /api/Audi/Q9/2026/SUV/Default/hero → { group: "hero", views: { front_left: true, front_left_ground: true, … } }, then GET /api/Audi/Q9/2026/SUV/Default/hero/front_left?color=c8102e&size=1080p&format=webp.

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.
`group` required	string	Studio group: hero, steered, extra, drone (see `groups` on the trim endpoint).
`image` required	string	Image of the group (see `views` of the group).

Query parameters

Name	Type	Description
`format`	string	Delivery format. `pngwebpjpegavifauto`
`ratio`	string	Aspect ratio. `1:14:33:216:916:102:121:95:43:44:52:39:16`
`width`	integer	Width in px.
`color`	string	Paint: catalog colour name or 6-digit hex.
`shadow`	string	Studio ground shadow. `truefalse`
`lights`	string	API v2 add-on: headlights on or off (default `off`). Not available for an image → `off` + errornote `L26`. `onoff`
`background`	string	API v2 add-on: `white` (default), `transparent`, or a 6-digit hex colour like `f4f4f4`. Studio images only (lifestyle → errornote `B32`).
`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`). `noneblanklogo`
`fit`	string	API v2 add-on: how the car fills a `ratio` / `size` box — `contain` pads (default), `cover` crops. Lifestyle images always cover. `containcover`
`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`

Request

curl "https://api.vehicleimagery.com/api/bmw/m4/2024/coupe/base/group/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",
    "view": "hero/front_left",
    "resolution": "default",
    "ratio": "default",
    "format": "webp",
    "settings": {
      "color": "c8102e",
      "shadow": false,
      "transparency": false,
      "watermark": false,
      "ground": false,
      "mirroring": false,
      "lights": "off",
      "background": "white",
      "windows": "see_through",
      "plate": "none",
      "size": "1080p"
    },
    "image_url": "https://api.vehicleimagery.com/image/3/hero/front-left.webp?color=c8102e&h=1920&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.

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