Catalog

Fuzzy search brands + models

GET/api/search

Fuzzy-match a free-text query against all brand model combinations. Pure worker + database — never starts the image container. Returns ranked matches with a ready path to drill in.

API v2 add-on: with the add-on, models that exist only as add-on cars are found too (e.g. ?q=q9 → /api/Audi/Q9).

Query parameters

Name	Type	Description
`q` required	string	Free-text query, e.g. `bmw 3` or `mercedes c`.
`limit`	integer	Max results (1–50, default 10).
`version`	string	Results from one version only: `v1` = standard images, `v2` = API v2 add-on (no fallback to standard images). Without it: everything your key allows. Not allowed for your key → `403`. `v1v2`

Request

curl "https://api.vehicleimagery.com/api/search?q=bmw 3&version=v1" \
  -H "x-api-key: YOUR_API_KEY"

200 · Ranked matches.

{
  "query": "bmw 3",
  "count": 2,
  "results": [
    {
      "brand": "BMW",
      "model": "3",
      "score": 0.95,
      "path": "/api/BMW/3"
    },
    {
      "brand": "BMW",
      "model": "320i",
      "score": 0.8,
      "path": "/api/BMW/320i"
    }
  ]
}

401 · Missing or invalid `x-api-key`.

{
  "error": "Invalid API key"
}

403 · Plan restriction (feature, format or brand not allowed) or blocked request.

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

404 · No data for the requested path.

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