Adicional da API v2

Resolver uma imagem de grupo de estúdio

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

API v2 add-on — chaves com acesso v2. Uma imagem de um grupo de estúdio: hero (fotos principais, algumas do nível do chão), steered (rodas dianteiras viradas), extra (mais ângulos de três alturas de câmera, cantos também a 30° e 45°), drone (de cima). Os grupos e os nomes das imagens são explicados em *Grupo de estúdio: lista suas imagens*.

GET …/{trim} lista os grupos que um carro possui (groups), GET …/{trim}/{group} lista as imagens de um grupo (views). Em seguida, resolva uma aqui. Aceita todas as opções de imagem, incluindo as opções do add-on (lights, background, cor hex color, windows, plate, fit, size, hotspots).

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

Parâmetros de caminho

Nome	Tipo	Descrição
`brand` obrigatório	string	Nome da marca (nomenclatura de catálogo atualizada para carros adicionais).
`model` obrigatório	string	Nome do modelo
`year` obrigatório	integer.	Ano do modelo (4 dígitos). Se o ano exato estiver ausente, a geração mais próxima disponível é usada (nota de erro `Y01`).
`variant` obrigatório	string	Variante de carroceria.
`trim` obrigatório	string	Nível de acabamento.
`group` obrigatório	string	Grupo de estúdio: hero, dirigido, extra, drone (veja `groups` no endpoint de trim).
`image` obrigatório	string	Imagem do grupo (veja `views` do grupo).

Parâmetros de consulta

Nome	Tipo	Descrição
`format`	string	Formato de entrega. `pngwebpjpegavifauto`
`ratio`	string	Proporção de aspecto. `1:14:33:216:916:102:121:95:43:44:52:39:16`
`width`	integer.	Largura em px.
`color`	string	Pintura: nome da cor do catálogo, hexadecimal de 6 dígitos ou `<finish>_<hex>` (por exemplo, `metallic_315fbf`).
`color_id`	integer.	Cor de tinta pelo seu id de `/api/colors`. Use quando um nome existe mais de uma vez: o id é único e nunca muda. Tem prioridade sobre `color`; `0` é a tinta original. Id desconhecido ou inativo → mesmo que um nome desconhecido (tinta padrão + nota de erro `F04`).
`shadow`	string	Sombra do estúdio no chão. `truefalse`
`lights`	string	Adicional da API v2: faróis ligados ou desligados. Padrão `on`: sem o parâmetro a imagem vem com as luzes acesas onde a imagem as tiver; envie `lights=off` para uma imagem sem luzes. Uma imagem sem variante de luz simplesmente vem sem luzes; com `lights=on` ela também carrega o erro `L26`. `onoff`
`background`	string	API v2 add-on: `white` (padrão), `transparent`, ou uma cor hexadecimal de 6 dígitos como `f4f4f4`. Apenas imagens de estúdio (lifestyle → erro `B32`).
`windows`	string	API v2 add-on: `see_through` = vidro como na imagem (padrão), `dark` = vidro privativo que não se vê através. Não disponível → erro `W28`. `see_throughdark`
`plate`	string	API v2 add-on: placa de licença — `none` = como na imagem (padrão), `blank` = placa vazia, `logo` = seu logo na placa (configurado em sua chave; ausente → branco + notanota de erro `N30`), `text` = seu próprio texto de `plate_text` (deve ser habilitado para sua chave, veja `addon.plate_text` em `/api/me`; caso contrário, notanota de erro `O31`). `noneblanklogotext`
`plate_text`	string	API v2 add-on: o texto para `plate=text` — até 10 caracteres: letras, dígitos, espaços e `-` `.` `&`. Escrito na placa conforme enviado (maiúsculas e minúsculas mantidas), centralizado e tão grande quanto a placa permite. Ausente, muito longo ou outros caracteres → `400`.
`fit`	string	API v2 add-on: como o carro preenche uma caixa `ratio` / `size` — `contain` preenche (padrão), `cover` recorta. Imagens lifestyle sempre cobrem. `containcover`
`size`	string	Adicionar ao API v2: lado mais longo: `2k` 2560 px, `1080p` 1920 px, `720p` 1280 px, `540p` 960 px, `360p` 640 px, `thumb` 320 px. `width` / `height` prevalecem sobre `size`. `2k1080p720p540p360pthumb`
`hotspots`	string	API v2 add-on: adicione `hotspots` à resposta — pontos de interesse (rodas, faróis ...) como frações 0–1 da imagem, por exemplo, para visualizadores interativos. `true`
`version`	string	Resultados de apenas uma versão: `v1` = imagens padrão, `v2` = add-on da API v2 (sem recair nas imagens padrão). Sem ele: tudo o que sua chave permite. Não permitido para sua chave → `403`. `v1v2`

Solicitar

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 · Metadados de imagem incluindo a `image_url` assinada.

[
  {
    "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` ausente ou inválida.

{
  "error": "Invalid API key"
}

403 · Restrição de plano (recurso, formato ou marca não permitido) ou solicitação bloqueada.

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

404 · Sem dados para o caminho solicitado. Para um caminho de carro, `not_found` nomeia o nível que não existe e `alternatives` lista o que existe lá em vez disso.

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