Imagem

Resolva uma URL de imagem assinada

GET/api/{brand}/{model}/{year}/{variant}/{trim}/{view}

O endpoint principal. Retorna metadados mais um image_url assinado que você insere diretamente em um <img>.

Adicione qualquer opção como parâmetro de consulta. Qualquer coisa não disponível para o carro ou não permitida pelo seu plano recai no valor válido mais próximo e é relatada em errornotes (em vez de falhar).

Exemplos

?format=webp&width=1200 — WebP, 1200 px wide.
?ratio=16:9&format=jpeg — padded to 16:9.
?mirroring=true — car on a reflective showroom floor.
?transparency=true&format=png — cut-out on transparent background.
?color=wine_red — repainted in the wine_red house color.
?color=Racing%20Red&shadow=true — Kia catalog paint plus studio shadow.

Adicionar ao API v2: para carros com imagens adicionais, as opções extras abaixo se aplicam (lights, background, hex color, windows, plate, fit, size, hotspots), por exemplo, ?color=c8102e&windows=dark&size=1080p. Com o adicionar ao API, {view} também pode ser um grupo de estúdio (hero, steered, extra, drone): isso lista as imagens do grupo. Veja *Adicionar ao API v2*.

Parâmetros de caminho

Nome	Tipo	Descrição
`brand` obrigatório	string	Nome da marca ou apelido (insensível a maiúsculas e minúsculas).
`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.
`view` obrigatório	string	Nome da vista, veja /api/views (por exemplo, frente, frente_esquerda, traseira).

Parâmetros de consulta

Nome	Tipo	Descrição
`format`	string	Formato de entrega. `auto` escolhe WebP. Original é PNG. `pngwebpjpegavifauto`
`resolution`	string	Preset de tamanho/qualidade (sobreposto por largura/qualidade explícita). `defaultthumbsmallmediumlargefull`
`ratio`	string	Preencher uma proporção de aspecto. `default` = nativo. `1:14:33:216:916:102:121:95:43:44:52:39:16`
`width`	integer.	Largura explícita em px (ajustada à escada de largura).
`height`	integer.	Altura explícita em px.
`quality`	integer.	Qualidade do codificador (40–100).
`color`	string	Cor de pintura pelo nome (sem diferenciação entre maiúsculas e minúsculas; codifique espaços em URL, por exemplo, `Racing%20Red`). O carro é repintado sob demanda — acabamento verdadeiro, reflexos e acabamento preservados. A lista de `/colors` de um carro mostra seu conjunto exibido (cores da casa + as cores da marca do carro); qualquer cor ativa de `/api/colors` pode ser solicitada. Cor desconhecida → pintura padrão + nota de erro `F04`. Combina com todas as outras opções. Adicional da API v2: cores do catálogo vêm com seu acabamento real (metálico, perolado, fosco, acetinado, cromado, alumínio, carbono). Também qualquer cor de pintura hexadecimal de 6 dígitos, por exemplo, `c8102e` (brilhante), ou uma cor hexadecimal com um acabamento: `<finish>_<hex>`, por exemplo, `metallic_315fbf`, `matte_283b56`, `carbon_545454`, `chrome_eac972`; metálico, perolado e acetinado aceitam uma segunda cor opcional para o efeito, por exemplo, `metallic_315fbf_5693f9`. Acabamentos: `solid`, `metallic`, `pearl`, `satin`, `matte` (também `matt`), `chrome`, `aluminium`, `carbon`.
`shadow`	string	Sombra do solo do estúdio, produzida no momento da entrega, disponível para todas as vistas externas. Com `mirroring=true` isso controla a sombra do baixo do veículo. `truefalse`
`transparency`	string	Fundo recortado transparente — disponível para todas as vistas externas (use com PNG/WebP). `truefalse`
`ground`	string	Coloque o carro no chão (precisa de uma variante transparente). `true`
`mirroring`	string	Piso refletivo. `true` = com sombra do subchassi, `clean` = reflexo apenas. Precisa de uma variante transparente. `trueclean`
`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/front?format=png&resolution=default" \
  -H "x-api-key: YOUR_API_KEY"

200 · Metadados de imagem incluindo a `image_url` assinada.

[
  {
    "id": 47456,
    "brand": "Abarth",
    "model": "124_Spider_Abarth",
    "year": 2016,
    "variant": "Basis",
    "trim": "base",
    "view": "front_left",
    "resolution": "default",
    "ratio": "default",
    "format": "webp",
    "settings": {
      "color": "default",
      "shadow": false,
      "transparency": false,
      "watermark": false,
      "ground": false,
      "mirroring": false,
      "width": 800
    },
    "image_url": "https://cdn.vehicleimagery.com/source/01KVJC5S0S639G46CASP7EK8HG?f=webp&q=82&w=800&verify=…&expire=…"
  }
]

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 · Nenhum dado para o caminho solicitado.

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