Referenz

Alle Lieferoptionen gebündelt

Holen/api/options

Alles, was Sie anfordern können, plan-gefiltert, in einem Aufruf: Formate, Breiten, Qualität, Verhältnisse, Auflösungen, die color Option und die Modifikator-Flags (Schatten/Transparenz/Boden/Spiegelung/Wasserzeichen) sowie ob Ihr Plan jedes davon zulässt.

API v2 Add-on: Mit dem Add-on wird die Antwort um einen addon Abschnitt erweitert: die Add-on-Formate, jede Add-on-Option, die Ihr Schlüssel verwenden kann, mit ihren Werten (lights, background, color, windows, plate, fit, size, hotspots) und die Gruppen.

Anfragen

curl "https://api.vehicleimagery.com/api/options" \
  -H "x-api-key: YOUR_API_KEY"

200 · Gebündelte Optionen.

{
  "formats": [
    "png",
    "webp",
    "jpeg",
    "avif"
  ],
  "widths": [
    200,
    400,
    800,
    1200,
    1600,
    2000
  ],
  "quality": {
    "min": 40,
    "max": 100,
    "default": 82
  },
  "modifiers": {
    "shadow": {
      "param": "shadow",
      "values": [
        "true",
        "false"
      ],
      "allowed": true
    },
    "mirroring": {
      "param": "mirroring",
      "values": [
        "true",
        "clean"
      ],
      "allowed": true,
      "note": "floor reflection; needs a transparent variant; shadow=false drops the underbody"
    }
  },
  "params": [
    "format",
    "resolution",
    "ratio",
    "width",
    "height",
    "quality",
    "color",
    "shadow",
    "transparency",
    "ground",
    "mirroring"
  ],
  "addon": {
    "formats": [
      "png",
      "webp",
      "jpeg",
      "avif"
    ],
    "options": {
      "lights": {
        "param": "lights",
        "values": [
          "on",
          "off"
        ]
      },
      "windows": {
        "param": "windows",
        "values": [
          "see_through",
          "dark"
        ]
      },
      "size": {
        "param": "size",
        "values": {
          "2k": 2560,
          "1080p": 1920,
          "720p": 1280,
          "540p": 960,
          "360p": 640,
          "thumb": 320
        }
      }
    },
    "groups": [
      "hero",
      "steered",
      "extra",
      "drone",
      "360",
      "lifestyle"
    ]
  }
}

401 · Fehlender oder ungültiger `x-api-key`.

{
  "error": "Invalid API key"
}

403 · Planbeschränkung (Funktion, Format oder Marke nicht erlaubt) oder blockierter Anfrage.

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

404 · Keine Daten für den angeforderten Pfad.

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