Cargoimg
API

Images

GET a signed image_url for a make, model, year, view, and render options.

curl -H "x-api-key: YOUR_KEY" \
  "$APP_URL/v1/makes/{make}/models/{model}/{year}/{view}?color=red&shadow=true&plate=AB-CD-123&format=webp&width=1200"

With multiple variants for that year, insert the variant slug:

/v1/makes/{make}/models/{model}/{year}/{variant}/{view}

{view} must be a published id from the nine studio views (see Catalog).

The API returns JSON, not the image. Use image_url to download pixels.

Query parameters

ParamDefaultNotes
colorwhite (#F5F5F5)Named color or hex (#C41E3A or C41E3A, 3- or 6-digit)
shadowtruetrue / 1 or false / 0
plateomittedEU-style registration text drawn on the mapped plate quad
formatwebpwebp, png, or jpeg — must be in the contract
width1600Clamped to 200–2400

Invalid color or format400 bad_request. Format not in the contract, or vehicle category not in the contract → 403 forbidden. Unknown or unpublished view → 404 not_found.

Response

{
  "vehicle": {
    "id": "…",
    "make": "DAF",
    "model": "XF",
    "year": 2022,
    "variant": null,
    "category": "truck",
    "category_id": "…"
  },
  "view": "front_left",
  "options": {
    "color": "#C41E3A",
    "color_name": "red",
    "shadow": true,
    "plate": "AB-CD-123",
    "format": "webp",
    "width": 1200
  },
  "image_url": "https://…/i/…",
  "warnings": []
}

color_name is the named color when you passed one; null for a custom hex.

Warnings

The render still succeeds. Clients should read warnings:

CodeMeaning
SHADOW_UNAVAILABLEshadow=true but this view has no studio shadow
PLATE_UNMAPPEDplate was set but this view has no plate quad

Named colors

red, blue, green, white, black, silver, yellow, orange — full hex table on Catalog.

On this page