API v2 オプション

スタジオグループ画像を解決する

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

API v2アドオン — v2アクセスのキー。 スタジオグループの1枚の画像: hero (ヒーローショット、一部は地面から)、steered (前輪を切った状態)、extra (3つのカメラの高さからのさらに多くの角度、角度は30°と45°)、drone (上空から)。グループとその画像名は *スタジオグループ: その画像をリストする* に説明されています。

GET …/{trim} は車のグループをリストアップします (groups)、GET …/{trim}/{group} は一つのグループの画像をリストアップします (views)。その後、ここで一つを解決します。すべての画像オプション、アドオンオプションを含む (lights、background、ヘックス color、windows、plate、fit、size、hotspots) を受け入れます。

例: GET /api/Audi/Q9/2026/SUV/Default/hero → { group: "hero", views: { front_left: true, front_left_ground: true, … } }, そして GET /api/Audi/Q9/2026/SUV/Default/hero/front_left?color=c8102e&size=1080p&format=webp。

パスパラメータ

名前	タイプ	説明
`brand` 必須	string	ブランド名（オプション車のカタログ名の更新）
`model` 必須	string	モデル名。
`year` 必須	整数	モデル年（4桁）。正確な年が欠落している場合、最も近い利用可能な世代が使用されます（エラーノート `Y01`）
`variant` 必須	string	ボディバリアント。
`trim` 必須	string	トリムレベル
`group` 必須	string	スタジオグループ：ヒーロー、ステアリング、エクストラ、ドローン（トリムエンドポイントの `groups` を参照）
`image` 必須	string	グループの画像（グループの `views` を参照）

クエリパラメータ

名前	タイプ	説明
`format`	string	出力形式。 `pngwebpjpegavifauto`
`ratio`	string	アスペクト比。 `1:14:33:216:916:102:121:95:43:44:52:39:16`
`width`	整数	ピクセル単位の幅
`color`	string	塗装：カタログカラー名、6桁のヘックス、または `<finish>_<hex>`（例：`metallic_315fbf`）。
`color_id`	整数	`/api/colors`からのペイントカラーIDで指定。名前が複数存在する場合に使用：IDはユニークで変わらない。`color`より優先される；`0`はオリジナルのペイント。不明または非アクティブなID → 不明な名前と同じ（デフォルトペイント + エラーノート `F04`）。
`shadow`	string	スタジオの地面の影。`truefalse`
`lights`	string	API v2アドオン: ヘッドライトのオン・オフ。デフォルト`on`: パラメータがないと、画像はライトがついた状態で表示されます。ライトを消したい場合は、`lights=off`を送信してください。ライトのバリエーションがない画像はライトなしで表示されます。`lights=on`を指定すると、エラーノート`L26`も付きます。`onoff`
`background`	string	API v2 アドオン： `white` (デフォルト)、`transparent`、または `f4f4f4` のような 6 桁の 16 進数カラー。スタジオ画像のみ (ライフスタイル → エラーノート `B32`)
`windows`	string	API v2 アドオン： `see_through` = 画像のガラス (デフォルト)、`dark` = 透けないプライバシーガラス。利用不可 → エラーノート `W28`。`see_throughdark`
`plate`	string	API v2 add-on: ナンバープレート — `none` = 画像のまま（デフォルト）、`blank` = 空のプレート、`logo` = プレートにあなたのロゴ（キーに設定済み、ない場合 → 空 + エラーノート `N30`）、`text` = `plate_text` のあなたのテキスト（キーに対して有効にする必要があります、詳細は `/api/me` の `addon.plate_text` を参照、そうでない場合はエラーノート `O31`）。 `noneblanklogotext`
`plate_text`	string	API v2 add-on: `plate=text` のテキスト — 最大10文字: 文字、数字、スペース、および `-` `.` `&`。送信した通りにプレートに書かれます（大文字と小文字が保持されます）、中央揃えでプレートが許す限り大きく表示されます。ない、長すぎる、または他の文字 → `400`。
`fit`	string	API v2 アドオン：車が `ratio` / `size` ボックスをどのように埋めるか — `contain` はパディング (デフォルト)、`cover` はトリミング。ライフスタイル画像は常にカバー。`containcover`
`size`	string	API v2 アドオン：最も長い辺 — `2k` 2560 px、`1080p` 1920 px、`720p` 1280 px、`540p` 960 px、`360p` 640 px、`thumb` 320 px。`width` / `height` は `size` に優先します。`2k1080p720p540p360pthumb`
`hotspots`	string	API v2 アドオン： `hotspots` をレスポンスに追加 — 画像の興味のあるポイント (リム、ヘッドライト …) を 0–1 の分数として。例えば、インタラクティブビューアー用。`true`
`version`	string	1つのバージョンからの結果のみ：`v1` = 標準画像、`v2` = API v2 の追加（標準画像にフォールバックしない）。このパラメータがない場合は、キーが許可するすべてのものが取得されます。キーで許可されていない場合 → `403`。`v1v2`

リクエスト

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_url`を含む画像メタデータ

[
  {
    "id": 900000003,
    "brand": "Audi",
    "model": "Q9",
    "year": 2026,
    "variant": "SUV",
    "trim": "Default",
    "version": "v2",
    "view": "hero/front_left",
    "resolution": "default",
    "ratio": "default",
    "format": "webp",
    "settings": {
      "color": "c8102e",
      "color_id": null,
      "color_manufacture": null,
      "shadow": false,
      "transparency": false,
      "watermark": false,
      "ground": false,
      "mirroring": false,
      "lights": "on",
      "background": "white",
      "windows": "see_through",
      "plate": "none",
      "size": "1080p"
    },
    "image_url": "https://api.vehicleimagery.com/image/3/hero/front-left.webp?color=c8102e&lights=on&h=1920&kid=…&v=…&exp=…&sig=…"
  }
]

401 · `x-api-key` がありませんまたは無効です。

{
  "error": "Invalid API key"
}

403 · プランの制限（機能、フォーマット、またはブランドが許可されていない）またはブロックされたリクエスト。

{
  "error": "Mirroring is not allowed by your plan."
}

404 · 要求されたパスにデータがありません。車両パスの場合、`not_found` は存在しないレベルを示し、`alternatives` は代わりに存在するものをリストします。

{
  "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"
    ]
  }
}