Skip to main content

Quickstart

This walks through the fastest integration: create an inspection, send the customer a link, and receive the finished report by webhook.

1. Get an API key​

Create a key from the dashboard. Keys are scoped to an environment — use a sk_test_… key while you build and a sk_live_… key in production. See Authentication for details.

export GAUZR_API_KEY="sk_test_..."

2. Create an inspection​

Creating an inspection returns a hosted capture link. Send it to the customer by SMS, email, or your own UI — they complete the walkthrough in the browser.

curl https://api.gauzr.com/v1/inspections \
  -H "Authorization: Bearer $GAUZR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "claim_84213",
    "vehicle": { "vin": "1HGCM82633A004352" },
    "notify_url": "https://your-app.com/webhooks/gauzr"
  }'
{
  "id": "insp_3fJ2c9",
  "status": "created",
  "capture_url": "https://go.gauzr.com/i/3fJ2c9",
  "reference": "claim_84213",
  "created_at": "2026-07-21T09:12:04Z"
}

3. The customer captures the vehicle​

Opening capture_url starts the guided walkthrough — angle prompts, lighting checks, and VIN confirmation. When they submit, Gauzr runs detection and grading. The inspection moves created → in_progress → processing → completed.

4. Receive the report​

When the report is ready, Gauzr POSTs an inspection.completed event to your notify_url:

{
  "type": "inspection.completed",
  "data": {
    "id": "insp_3fJ2c9",
    "status": "completed",
    "report_url": "https://api.gauzr.com/v1/inspections/insp_3fJ2c9/report",
    "summary": { "findings": 3, "grade": "moderate" }
  }
}

Fetch the full report at any time:

curl https://api.gauzr.com/v1/inspections/insp_3fJ2c9/report \
  -H "Authorization: Bearer $GAUZR_API_KEY"

See Reports for the finding schema, and Webhooks for verifying and handling events.

Next steps​