Parameter
vin
optionalExample
1NXBR32E85Z505904
Description
The vehicle identification number
docs / api / images / vehicle-images
The Vehicle Images API provides programmatic access to high-quality, OEM-style rendered vehicle images. It supports use cases such as embedding visuals in reports, marketing content, or consumer-facing applications based on identifiers like VIN, or Spec ID. The API supports customizable rendering through optional parameters like pose, color, background, and format, and implements a watermarking system to protect usage across demo and production environments.
Parameter
vin
optionalExample
1NXBR32E85Z505904
Description
The vehicle identification number
Parameter
key
optionalExample
YOUR_API_KEY_HERE
Description
Your VinAudit API key
Parameter
format
optionalExample
html, json, xml (invalid inputs return error)
Description
The output format (default: json)
Parameter
pose
optionalExample
front_left, front_right, front, back_left, back_right, back, right, left
Description
Controls the image/view angle returned (default: front_right)
Parameter
color
optionalExample
white, black, gray (or grey), silver, blue, red, green, brown, beige, gold, orange, purple, yellow
Description
Requests a specific vehicle color (default: white)
Parameter
background
optionalExample
white, gallery
Description
Sets the image background (default: white)
Parameter
size
optionalExample
Predefined Tiers: - small → 640×480 (thumbnail) - medium → 1280×960 or 1600×1200 (default) - large → 2048×1536 (marketing, social) - xlarge → 3000×2000 (dealership-quality) - full → 6000×4000 (print, archival) - Custom → Explicit dimensions (e.g., size=1920×1080)
Description
Sets the output image size (default: medium)
Parameter
granularity
optionalExample
trim, model
Description
Controls whether images are generated at the trim or model level (default: trim)
Parameter
crop
optionalExample
true, false
Description
Removes image padding (default: false)
Field
id
Type
2024_maserati_mc20_cielo
Description
Unique identifier for the vehicle (year_make_model_trim format)
Field
images
Type
(insert image here)
Description
Array containing image objects with encoded image data
Field
content_type
Type
image/png
Description
File type of the returned image
Field
data
Type
iVBORw0KGgoAAAANSUhEUg...
Description
Base64-encoded binary image data
Field
success
Type
true
Description
Indicates if the request was successful
Field
ymmt
Type
Description
Structured vehicle information object
Field
year
Type
2024
Description
Vehicle model year
Field
make
Type
Maserati
Description
Vehicle manufacturer
Field
model
Type
MC20
Description
Vehicle model
Field
error
Type
invalid_input
Description
Error code if request fails (invalid_input, unauthorized_request, etc.)
Field
error_description
Type
Invalid input or unsupported vehicle configuration
Description
Human-readable explanation of the error