Configuration

Select your API key and environment to authenticate playground requests.

Developer Settings

Manage global preferences for your API responses.

Universal Price Adjustment

Automatically increment or decrement all price estimations rendered by the API. This is applied proportionally to itemized breakdowns.

Predict by VIN

Get a repair cost prediction using a vehicle's VIN, zip code, and problem identifier.

POST /api/v1/predict
First 11 characters (VIN mask) used for vehicle lookup.
Request
POST /api/v1/predict

{}
Response
// Submit the form to see the prediction result

Predict by Vehicle Specs

Get a repair cost prediction by selecting year, make, model, trim, and engine - no VIN required.

POST /api/v1/predict/by-specs
Request
POST /api/v1/predict/by-specs

{}
Response
// Select vehicle specs to get a prediction

Plate to VIN Lookup

Resolve a US license plate to a VIN, then automatically create/enrich the vehicle in the system.

POST /api/v1/predict/plate-to-vin
Request
POST /api/v1/predict/plate-to-vin

{}
Response
// Enter a plate number to look up its VIN

VIN Lookup

Decode a VIN to get vehicle details (year, make, model, etc.) without running a prediction.

POST /api/v1/predict/vehicle-lookup
Decodes via NHTSA and returns vehicle information.
Request
POST /api/v1/predict/vehicle-lookup

{}
Response
// Enter a VIN to decode vehicle details

NHTSA Recall Lookup

Fetch open safety recalls from NHTSA for a specific vehicle using its VIN. This involves decoding the VIN and querying the NHTSA Recall API.

GET /api/v1/fleet/compliance/recalls/{vin}
Returns vehicle details and an array of open recalls.
Request
GET /api/v1/fleet/compliance/recalls/{vin}
Response
// Enter a VIN to check for recalls

Vehicle Compliance Update

Update vehicle health signals and compliance status for a fleet vehicle.

POST /api/v1/fleet/vehicles/{vehicle}/compliance
Oil Life Calculator — auto-computes oil_life for the compliance payload
Maintenance History — feeds into service gap & brake scoring
Checked against rotation interval — within threshold = compliant
≤18 mo = 3 pts · ≤30 mo = 1.5 pts · >30 = 0
Codes like P0301 will be sent as an array.
ABS system
Brake fluid condition
Emissions system
Check engine light (MIL)
Oil pressure
Oil temperature
Transmission system
Airbag / SRS
Tire pressure
Active safety systems
Water in fuel
Request
POST /api/v1/fleet/vehicles/{vehicle}/compliance

{}
Response
// Update compliance data to see the result

Extract VIN from Image

Upload a photo of a VIN plate, sticker, or registration document and let AI extract the VIN automatically.

POST /api/v1/predict/extract-vin

Drag & drop an image here or click to browse

Supports JPEG, PNG, WebP (max 10MB)
Request
POST /api/v1/predict/extract-vin

Content-Type: multipart/form-data

{}
Response
// Upload an image to extract VIN

Search Sub-categories

Search across all visible repair sub-categories by name. Returns matches with their parent category and ID.

POST /api/v1/predict/categories/search
Minimum 2 characters. Returns up to 20 results.
Request
POST /api/v1/predict/categories/search

{}
Response
// Type a search query to find sub-categories

Describe Sub-category

Get an AI-generated description of what a repair sub-category involves. Descriptions are cached after first generation.

POST /api/v1/predict/categories/{id}/describe
Request
POST /api/v1/predict/categories/{id}/describe
Response
// Enter a sub-category ID to get its description

AI Repair Recommendation

Describe what's wrong with the vehicle and get AI-powered repair suggestions matched to our database.

POST /api/v1/predict/diagnose
Minimum 10 characters. Be as descriptive as possible.
Request
POST /api/v1/predict/diagnose

{}
Response
// Describe a car problem to get diagnosis

AI Diagnostic Chat

Conversational AI diagnostic — describe symptoms and answer follow-up questions to get an accurate diagnosis.

POST /api/v1/predict/diagnose/start
POST /api/v1/predict/diagnose/reply
POST /api/v1/predict/diagnose/reset
GET /api/v1/predict/diagnose/{session_id}
GET /api/v1/predict/diagnose/history
How it works:
  1. Start — Send a symptom description (+ optional VIN or Image) → AI identifies vehicle & asks a follow-up
  2. Reply — Answer the question (can attach images) → AI asks another or gives diagnosis
  3. Confirmation — When vehicle is identified, the response message will include a formatted spec summary.
  4. Diagnosis — AI returns ranked repairs with confidence scores matched to our database
  5. Retrieve/Reset — GET to fetch full history; POST /reset to clear conversation & vehicle context.
Cost: 1 Gemini API call per turn. Typical session = 4-5 calls. Only the start counts against your quota — replies within a session are free.
1. Start Session
POST /api/v1/predict/diagnose/start
Request Body:
{
"description": "My car makes a grinding noise" // required
"vin": "1FMCU0MN9PU09186" // optional, 17 chars
"image": BinaryData // optional, multipart/form-data
}
Response:
{
"success": true,
"session_id": "uuid-here", // use this for replies
"message": "What kind of noise is it? Grinding, squealing, or clicking?",
"step": 1, "max_steps": 5, "is_complete": false
}
2. Reply
POST /api/v1/predict/diagnose/reply
Request Body:
{
"session_id": "uuid-from-start" // required
"answer": "It is a grinding noise" // required
"image": BinaryData // optional, multipart/form-data
}
Response (follow-up):
{
"message": "Does it happen only at low speeds or also at highway speeds?",
"step": 2, "is_complete": false
}
Response (final diagnosis):
{
"message": "Based on our conversation, here is my diagnosis...",
"is_complete": true,
"diagnosis": [{ "category": "Brake", "subcategory": "Brake Pad Replacement", "confidence": 0.92, "problem_id": 38 }]
}
3. Reset Session
POST /api/v1/predict/diagnose/reset
Request Body: {"session_id": "uuid"}. Clears history and identification.
4. Retrieve Session
GET /api/v1/predict/diagnose/{session_id}
Returns full conversation history + diagnosis.
5. List Chat History
GET /api/v1/predict/diagnose/history
Query Params:
email // filter by email (optional)
status // active | completed (optional)
per_page // default 20
Returns paginated list of sessions with message counts.
Try it — Interactive Chat
API Response
// Start a diagnostic session to begin

Tire Catalog

Browse supported tire brands and their specific models. The catalog is synchronized in real-time with the QuickIQ predictive engine.

GET /api/v1/fleet/tires/brands
(to list brands)

Loading tire brands...

Live Tire Estimation

Calculate predicted tire health and remaining life without saving to the database. Perfect for "Tire Calculator" tools.

POST /api/v1/fleet/tires/estimate
Request
POST /api/v1/fleet/tires/estimate
                            
{}
Visual Health Analysis
JSON Response
// Run estimation to see details

Full Vehicle Health Score

Retrieve the complete 0–100 composite health score for a vehicle, including maintenance, risk, and fault dimensions.

GET /api/v1/fleet/vehicles/{vin}/health
Request
GET /api/v1/fleet/vehicles/{vin}/health
JSON Response
// Enter VIN to calculate full health profile

Vehicle Valuation

Get the current market valuation and historical price trends for a vehicle using its VIN.

GET /api/v1/fleet/vehicles/{vin}/valuation
Request
GET /api/v1/fleet/vehicles/{vin}/valuation
Response
// Enter a VIN to see valuation data

Diagnostic Chat History

Browse all diagnostic sessions. Filter by email or status to narrow results.

GET /api/v1/predict/diagnose/history
Session ID Email Vehicle Status Step Msgs Started Action
Enter an email or click Search to view sessions.
Response
// Click Search to load sessions

Submit Prediction Feedback

Use a session_id from a prediction to submit accuracy feedback.

POST /api/v1/predict/feedback
Request
POST /api/v1/predict/feedback

{}
Response
// Submit feedback to see the result

Repair Lifecycle Prediction

Find out when a specific repair will be needed again, based on historical repeat-repair data for your vehicle's make.

POST /api/v1/predict/repair-lifecycle
Request
POST /api/v1/predict/repair-lifecycle

{}
Response
// Submit the form to see lifecycle prediction

Repair Sequence Prediction

Discover what repairs typically come next after a specific repair, based on historical sequence mining data.

POST /api/v1/predict/repair-sequence
Request
POST /api/v1/predict/repair-sequence

{}
Response
// Submit the form to see what breaks next

Vehicle Connectivity (SmartCar)

Authorize access to vehicle data via SmartCar using the JS SDK. This flow exchanges an authorization code for vehicle tokens.

POST /api/v1/smartcar/exchange

Clicking the button below will fetch the authorization URL for this driver and redirect you to the SmartCar vehicle selector.

Request
GET /api/v1/smartcar/connect
Response
// Click connect to start the OAuth flow

SmartCar VIN Lookup

Retrieve all active vehicle VINs associated with a specific driver email through SmartCar connections.

GET /api/v1/smartcar/vin-lookup
Request
GET /api/v1/smartcar/vin-lookup
Response
// Enter an email to see linked VINs

SmartCar Compliance Sync

Pulls live vehicle data from SmartCar, updates the vehicle record, ingests compliance signals, and recomputes the health score — all in one call.

GET /api/v1/fleet/vehicles/{vin}/smartcar-compliance
The vehicle must have an active SmartCar connection in the system.
What this syncs:
Odometer / Mileage Always
System Status (ABS, etc.) Admin Enabled
Engine Oil Life Admin Enabled
Diagnostic Codes (DTCs) Admin Enabled
Request
GET /api/v1/fleet/vehicles/{vin}/smartcar-compliance
Response
// Enter a VIN to sync SmartCar data

Prediction History

All prediction records. Red flag rows are highlighted.

Date Session VIN Problem Local Avg AI Avg Match Memory Feedback Reason
Loading...

Lifecycle Prediction History

All lifecycle prediction records. Red flag rows are highlighted.

Date Session Vehicle Repair Source Local Days AI Days Local Miles Next Due Flag
Loading...

Your API Keys

Manage your API keys for authentication.

    Vehicle Insurance Risk Analysis

    Fetch real-time safety risk levels, claim risk scores, composite health scores, predicted failures, service gaps, and cost exposure details using a vehicle's VIN.

    GET /api/v1/fleet/vehicles/{vin}/insurance-risk
    Checks vehicle compliance data and failure predictions to calculate insurance risk indicators.
    Request Preview
    {}
    Response
    // Enter a VIN to analyze insurance risk

    List All Service Schedules

    Fetch all maintenance schedules assigned to your fleet manager account.

    GET /api/v1/fleet/service-schedules
    Response
    {}

    Service Schedules by Vehicle

    Filter schedules specifically for a single vehicle ID, with optional status filter.

    GET /api/v1/fleet/service-schedules/vehicle/{id}
    Request Preview
    {}
    Response
    {}

    Get Schedule Detail

    Fetch full details for a specific service schedule ID.

    GET /api/v1/fleet/service-schedules/{id}
    Response
    {}

    Create Service Schedule

    Register a new maintenance appointment for a fleet vehicle.

    POST /api/v1/fleet/service-schedules
    Request Preview
    {}
    Response
    {}

    Update Service Schedule

    Modify an existing schedule's status, date, or notes.

    PUT /api/v1/fleet/service-schedules/{id}
    Response
    {}

    Delete Service Schedule

    Permanently remove a maintenance appointment.

    DELETE /api/v1/fleet/service-schedules/{id}
    Response
    {}