Navigation

Documentation

Complete reference for the Vehicle Imagery API v1. Integrate studio-quality visuals in minutes.

Vehicle Imagery API

Versions

We provide the v1 API version.

v1: current, structured hierarchy designed for programmatic browsing and modern integrations.

Base URL

All endpoints are served under https://api.vehicleimagery.com/api/. The API is optimized for global CDN delivery.

Authentication

All API requests are authenticated using an API key. The key must be sent in the request header. Requests without a valid key will be rejected.

Header name

x-api-key

Header value

your personal API key

Example

x-api-key: YOUR_API_KEY_HERE

Query parameters (global)

Many endpoints accept optional query parameters to filter by image format and resolution. If omitted, defaults are used.

resolution – default: default. Use GET /api/resolutions to list available values.
format – default: png. Use GET /api/formats to list available values.

Example: /api/brands?format=png&resolution=default

Debug mode

Add ?debug=true (or oneauto, test, customer, api) to enable debug output. If your subscription has debug enabled, the response includes a debug_report with step-by-step details.

Formats

Responses are JSON. Image formats (e.g. PNG) are configurable via the format query parameter; use GET /api/formats to list available formats.