Cargoimg

Getting started

Create an API key, call /v1/me, then request a signed view URL.

You need an organization with an active contract. Invite-only accounts sign in at /login. Admins can also create keys for an organization from the admin console.

The secret is shown once. Store it in your backend. Never ship it in a browser or mobile app.

1. Create a key

In the dashboard, open API keys, name the key, and copy the value. It starts with cimg_live_.

Admins can create a key for any organization under API keys.

2. Confirm the account

Replace $APP_URL with your host (for local development, http://localhost:3000).

curl -H "x-api-key: YOUR_KEY" \
  "$APP_URL/v1/me"

You should see the organization, key prefix, contract (monthly quota, RPM, allowed formats), remaining usage, and allowed vehicle categories.

Unauthenticated calls return 401 with { "error": "unauthorized", "message": "…" }.

3. Request a view

Walk the catalog until you have a make slug, model slug, year, and view id. Then:

curl -H "x-api-key: YOUR_KEY" \
  "$APP_URL/v1/makes/daf/models/xf/2022/front_left?color=red&shadow=true&plate=AB-CD-123&format=webp&width=1200"

The JSON includes image_url (signed) and warnings. Open or download that URL to get the image. Do not treat image_url as a stable CDN path — it is a signed render token.

Search if you do not know the slugs:

curl -H "x-api-key: YOUR_KEY" \
  "$APP_URL/v1/search?q=daf+xf+2022"

On this page