Laravel - Developer Portal

Documentation Index

Use the sidebar to jump to any endpoint group, or read the overview below to understand authentication, errors, and rate limits before making your first request.

AI Diagnostics & Repair

Path: POST /api/v1/predict

Predict repair costs, analyze VINs, decode vehicle specs, and get AI-powered diagnostic recommendations — the core intelligence layer of the platform.

Prediction & Diagnostics

Predict by VIN — Full repair cost estimate from a VIN
Predict by Specs — Estimate by year/make/model/problem
VIN Market Match — Market-adjusted cost estimate
AI Repair Recommendation — GPT-powered repair guidance
Diagnostic Chat — Conversational diagnosis session
Search Sub-categories — Find repair sub-categories

Vehicle Data

Path: /api/v1/vin, /api/v1/plate

Decode VINs, translate plate numbers, extract VINs from images, and retrieve NHTSA recall safety data.

Decoding & Lookup

VIN Lookup — Full spec decode by VIN
Plate to VIN — Convert a plate number to VIN
Extract VIN from Image — AI image-to-VIN extraction
NHTSA Recall Lookup — Active safety recalls by VIN

Vehicle Intelligence

Path: /api/v1/health, /api/v1/compliance

Score vehicle health, calculate oil life, assess tire specs, run compliance checks, and get market valuations.

Health, Compliance & Valuation

Full Health Score — Multi-dimension VHS scoring
Vehicle Valuation — Market value estimate
Vehicle Compliance — Inspection and compliance sync
Tire Catalog — OEM tire spec lookup
Live Estimation — Real-time tire cost estimate

Body Shop

Path: POST /api/v1/body-shop/match

Match vehicle images to body shops and estimate repair costs using AI image analysis.

Body Shop Image Match — AI damage assessment from photo

Introduction

The QuickMechs API is an AI-powered automotive intelligence platform. It covers repair cost prediction, VIN decoding, vehicle health scoring, fleet maintenance scheduling, NHTSA recall data, AI diagnostics, tire intelligence, and body shop image analysis — all through a single RESTful API surface.

All endpoints share the same base URL (…) and authenticate via a Bearer API key. Generate your key in the Configuration section, select it in the config bar, and every playground request on this page auto-attaches it.

Quick Start

1. Go to Configuration and generate or select your API key.
2. The config bar auto-attaches your key to all playground requests on this page.
3. Toggle between Test and Live environments using the env switch in the config bar.
4. Pick an endpoint from the sidebar, fill in the parameters, and press Send.

Guide Links

Authentication — How your API key becomes a Bearer token
Errors — HTTP status codes and error response format
Rate Limits — Per-plan limits and retry guidance
Configuration — Generate and select your API key
Predict by VIN — Most-used prediction endpoint
Vehicle Health Score — Full VHS scoring

Authentication

All API requests require a Bearer token in the Authorization header. Your Bearer token is your API key — there is no session exchange step required.

Generate a key from the Configuration section, then use it directly in every request. The playgrounds on this page auto-attach the selected key, so you only need to configure it once per browser session.

Required Headers

Header	Value	Required
`Authorization`	`Bearer YOUR_API_KEY`	Yes
`Content-Type`	`application/json`	Yes for POST requests
`Accept`	`application/json`	Recommended

Never expose your API key in client-side code or public repositories. Always make API calls from your backend server. Rotate keys immediately if you suspect a leak.

Environments

Test — Safe sandbox for development. Responses use real logic but won't affect production data or billing.
Live — Production environment with full billing. Switch using the toggle in the config bar.

Errors

The API uses standard HTTP status codes. When a request fails, inspect the status code first, then read the JSON error body for the specific code and message.

Treat 4xx responses as client-side problems you need to fix, and 5xx responses as transient server issues that are safe to retry with backoff.

Error Response Format

{
  "error": {
    "message": "Unauthorized — invalid or missing API key",
    "code": "INVALID_TOKEN",
    "details": {}
  }
}

Common Status Codes

Status	Code	Meaning & Action
400	`INVALID_REQUEST`	Malformed request or missing required parameters — fix before retrying
401	`INVALID_TOKEN`	API key missing, invalid, or revoked — check your key in Configuration
403	`FORBIDDEN`	Key exists but lacks permission — verify your plan supports this endpoint
422	`VALIDATION_ERROR`	Request body failed validation — check the `details` field for field-level errors
429	`RATE_LIMIT_EXCEEDED`	Too many requests — back off and respect the `Retry-After` header
500	`INTERNAL_ERROR`	Server error — safe to retry with exponential backoff

Rate Limits

Rate limits are enforced per API key and vary by plan. Limit details are surfaced in response headers on every request so you can adapt dynamically without guessing.

If you hit a 429, read the Retry-After header and wait that many seconds before retrying. Don't hammer the API — exponential backoff prevents cascading failures.

Rate Limit Headers

Header	Description
`X-RateLimit-Limit`	Maximum requests allowed in the current window
`X-RateLimit-Remaining`	Requests remaining before the window resets
`X-RateLimit-Reset`	Unix timestamp when the window resets
`Retry-After`	Seconds to wait after a 429 response

Best Practices

Cache aggressively — VIN decode, tire catalog, and recall data rarely changes. Cache at the application layer.
Backoff on 429 — Use exponential backoff. Always read the Retry-After header.
Spread fleet requests — If scoring a fleet, spread requests over time rather than bursting.

Need more capacity? Upgrade your plan to unlock higher limits.

Configuration

Select your API key and environment to authenticate playground requests.

API Key

Env

Test

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.

Body Shop Image Match

Upload a photo of vehicle damage and the AI will identify up to 8 relevant body shop services from our catalogue.

POST /api/v1/predict/body-shop/image-match

Request Parameters

Parameter	Type	Required	Description
`image`	file	Yes	Vehicle damage photo. JPEG, PNG, or WebP. Max 10 MB.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/body-shop/image-match \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "image=@/path/to/damage.jpg"

Try it

Vehicle Damage Image

Click or drag an image here

JPG, PNG, WEBP — max 10MB

Request

POST /api/v1/predict/body-shop/image-match

Content-Type: multipart/form-data
Body: { file: <image> }

Response

// Upload an image and click Analyze

Predict VIN Market Match

Get a repair cost prediction using a VIN and a standardised market repair category — no subcategory search needed. Categories are pre-matched to common industry repairs.

POST /api/v1/predict

GET /api/v1/predict/categories/market-match

Request Parameters

Parameter	Type	Required	Description
`vin`	string	Yes	17-character Vehicle Identification Number.
`zip_code`	string	Yes	US ZIP code for the repair location.
`mileage`	integer	No	Current odometer reading. Used for high-mileage oil recommendation.
`problem_identifier`	string	Yes	Category ID (as string) from the market-match list endpoint.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"1HGCM82633A004352","zip_code":"90210","mileage":85000,"problem_identifier":"7"}'

Try it

Vehicle VIN

First 11 characters used for vehicle lookup.

Zip Code

Current Mileage (optional)

Used to recommend high mileage oil for vehicles over 75,000 miles.

Repair Category from market match list

Showing exact + partial matches against industry-standard repair list.

Request

POST /api/v1/predict

{}

Response

// Select a category and submit to see result

Predict by VIN

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

POST /api/v1/predict

Request Parameters

Parameter	Type	Required	Description
`vin`	string	Yes	17-character VIN or 11-character mask. First 11 chars used for vehicle lookup.
`zip_code`	string	Yes	US ZIP code. Affects regional labour and parts pricing.
`mileage`	integer	No	Current odometer reading in miles.
`problem_identifier`	string	Yes	Sub-category slug. Retrieve via the Search Sub-categories endpoint.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"1HGCM82633A004352","zip_code":"90210","mileage":85000,"problem_identifier":"brake-pad-replacement"}'

Try it

Vehicle VIN Extract with AI

First 11 characters (VIN mask) used for vehicle lookup.

Zip Code

Current Mileage (optional)

Used to recommend high mileage oil for vehicles over 75,000 miles.

Problem Category

Problem Sub-category

Or Search Sub-category

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 Parameters

Parameter	Type	Required	Description
`year`	integer	Yes	Vehicle model year (e.g. 2019).
`make`	string	Yes	Vehicle manufacturer (e.g. "Honda").
`model`	string	Yes	Vehicle model (e.g. "Accord").
`trim`	string	No	Trim level. Narrows engine options.
`engine`	string	No	Engine descriptor (e.g. "2.0L 4-cyl").
`drivetrain`	string	No	Drivetrain type (e.g. "FWD").
`transmission`	string	No	Transmission type (e.g. "Automatic").
`zip_code`	string	Yes	US ZIP code for regional pricing.
`problem_identifier`	string	Yes	Sub-category slug or ID.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/by-specs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"year":2019,"make":"Honda","model":"Accord","trim":"EX-L","zip_code":"90210","problem_identifier":"brake-pad-replacement"}'

Try it

Year

Make

Model

Trim (optional)

Engine (optional)

Drivetrain (optional)

Transmission (optional)

Zip Code

Current Mileage (optional)

Problem Category

Problem Sub-category

Or Search Sub-category

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 Parameters

Parameter	Type	Required	Description
`plate`	string	Yes	License plate number. Alphanumeric, no spaces (e.g. "7ABC234").
`state`	string	Yes	2-letter US state abbreviation (e.g. "CA").

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/plate-to-vin \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plate":"7ABC234","state":"CA"}'

Try it

License Plate

State

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

Request Parameters

Parameter	Type	Required	Description
`vin`	string	Yes	17-character Vehicle Identification Number.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/vehicle-lookup \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"1HGCM82633A004352"}'

Try it

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}

Request Parameters

Parameter	Type	Required	Description
`vin`	string	Yes	Path param. 17-character VIN to query NHTSA for open recalls.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/compliance/recalls/1HGCM82633A004352" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

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

Request Parameters

Parameter	Type	Required	Description
`vehicle`	string	Yes	Path param. Vehicle ID or VIN.
`email`	string	Yes	Owner's email address for record linking.
`registration_status`	string	No	Registration status (e.g. "active", "expired").
`open_recalls`	integer	No	Number of currently open safety recalls.
`closed_recalls`	integer	No	Number of previously resolved recalls.
`oil_type`	string	No	Oil specification (e.g. "5W-30 Full Synthetic").
`oil_months`	integer	No	Months since the last oil change.
`oil_life`	integer	No	Remaining oil life percentage (0-100).
`last_tire_rotation`	integer	No	Months since the last tire rotation.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/vehicles/42/compliance \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"owner@example.com","registration_status":"active","open_recalls":0,"oil_type":"5W-30 Full Synthetic","oil_months":3}'

Try it

Vehicle ID or VIN

Owner Email (optional — links VIN to email for fleet tracking)

One email can be linked to many VINs. Use the Fleet Lookup endpoint to retrieve all VINs for an email.

Registration Status

Open Recalls

Closed Recalls

Oil Life Calculator — auto-computes oil_life for the compliance payload

Oil Type

Months Since Last Change

Maintenance History — feeds into service gap & brake scoring

Last Tire Rotation (months ago)

Checked against rotation interval — within threshold = compliant

Last Brake Pad Replace (months ago)

≤18 mo = 3 pts · ≤30 mo = 1.5 pts · >30 = 0

Diagnostic Codes (Comma separated)

Codes like P0301 will be sent as an array.

Status Signals (OK / ALERT)

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

Vehicle History & Title — applies risk multipliers and title score caps to VHS

Number of Owners

Usage Type

Title Status

Leave blank to keep existing values. These are saved to the vehicle record and used by the health score engine.

Request

POST /api/v1/fleet/vehicles/{vehicle}/compliance

{}

Response

// Update compliance data to see the result

Fleet — Lookup VINs by Email

Retrieve all VINs associated with an owner email address. VINs are linked automatically when an email is submitted with a compliance update.

GET /api/v1/fleet/emails/{email}/vehicles

Request Parameters

Parameter	Type	Required	Description
`email`	string	Yes	Path param. Owner email to look up linked VINs.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/emails/owner%40example.com/vehicles" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Request

GET /api/v1/fleet/emails/{email}/vehicles

Response

// Enter an email to retrieve linked VINs

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

Request Parameters

Parameter	Type	Required	Description
`image`	file	Yes	Image containing a VIN plate or label. JPEG, PNG, or WebP.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/extract-vin \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "image=@/path/to/vin-plate.jpg"

Try it

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

Request Parameters

Parameter	Type	Required	Description
`query`	string	Yes	Free-text search term (e.g. "brake pad", "oil change").
`limit`	integer	No	Max results to return. Default: 10. Max: 50.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/categories/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"brake pad","limit":10}'

Try it

Search Query

Minimum 2 characters. Returns up to 20 results.

Limit (optional, default 20, max 50)

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 Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Path param. Sub-category ID from the search endpoint.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/categories/7/describe \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Search Sub-category

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

Request Parameters

Parameter	Type	Required	Description
`symptom`	string	Yes	Plain-language vehicle symptom or complaint.
`vin`	string	No	Vehicle VIN. Adds vehicle-specific context to the AI recommendation.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/diagnose \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"symptom":"Car shakes when braking at highway speed","vin":"1HGCM82633A004352"}'

Try it

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:

Start — Send a symptom description (+ optional VIN or Image) → AI identifies vehicle & asks a follow-up
Reply — Answer the question (can attach images) → AI asks another or gives diagnosis
Confirmation — When vehicle is identified, the response message will include a formatted spec summary.
Diagnosis — AI returns ranked repairs with confidence scores matched to our database
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.

Request Parameters

Parameter	Type	Required	Description
`problem`	string	Yes	(Start) Initial symptom to open the diagnostic session.
`vin`	string	No	(Start) Vehicle VIN for session context.
`email`	string	No	(Start) Customer email for session linking and history.
`image`	file	No	(Start) Optional vehicle photo for visual context.
`message`	string	Yes	(Reply) Follow-up message in the active session.
`session_id`	string	Yes	(Reply / Reset) Active session ID returned from the start call.

Example Request

# Start a session
curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/diagnose/start \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "problem=Engine misfires on cold start" \
  -F "vin=1HGCM82633A004352" \
  -F "email=customer@example.com"

# Continue the session
curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/diagnose/reply \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message":"It only happens below 40F","session_id":"sess_abc123"}'

Try it

Describe the Problem

VIN (optional)

Email (optional)

Vehicle Image (optional)

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)

Example Request

curl -X GET https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/tires/brands \
  -H "Authorization: Bearer YOUR_API_KEY"

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 Parameters

Parameter	Type	Required	Description
`current_mileage`	integer	Yes	Current vehicle odometer reading in miles.
`install_mileage`	integer	Yes	Odometer at time of tire installation.
`brand`	string	Yes	Tire brand name (from the Tire Catalog).
`model`	string	Yes	Tire model name (from the Tire Catalog).
`treadwear`	integer	No	UTQG treadwear rating (e.g. 500).
`initial_depth`	number	No	New tread depth in 32nds of an inch (e.g. 10.5).
`warranty`	integer	No	Manufacturer mileage warranty in miles.
`vin`	string	No	Vehicle VIN for fitment validation.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/tires/estimate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"current_mileage":62000,"install_mileage":45000,"brand":"Michelin","model":"Defender T+H","treadwear":800,"initial_depth":10.5,"warranty":80000}'

Try it

Current Mileage

Installation Mileage

Tire Brand

Tire Model

Treadwear (UTQG)

Init. Depth (32nds)

Warranty (Miles)

Vehicle VIN (optional)

Request

POST /api/v1/fleet/tires/estimate
                            
{}

Visual Health Analysis

Maintenance Compliance

0/25

TIRES

0/15

RECALLS

0/10

OIL LIFE

0/5

EMISSIONS

0/5

BRAKE FLUID

0/5

ABS

0/5

Tread Depth

-

Life Remaining

-%

Data Source: -

JSON Response

// Run estimation to see details

Save Tire Data

Associate tire information with a specific vehicle to track health over time. Recomputes the Vehicle Health Score (VHS).

POST /api/v1/fleet/vehicles/{id}/tires

Request Parameters

Parameter	Type	Required	Description
`vehicle_id`	integer	Yes	Database ID of the vehicle record.
`current_mileage`	integer	Yes	Current odometer reading in miles.
`installation_mileage`	integer	Yes	Odometer reading when tires were installed.
`tire_brand`	string	Yes	Tire brand name.
`tire_model`	string	Yes	Tire model name.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/vehicles/42/tires \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vehicle_id":42,"current_mileage":62000,"installation_mileage":45000,"tire_brand":"Michelin","tire_model":"Defender T+H"}'

Try it

Vehicle ID

The database ID of the vehicle record.

Current Mileage

Installation Mileage

Tire Brand

Tire Model

Request

POST /api/v1/fleet/vehicles/{id}/tires
                            
{}

Response

// Save data to see the updated VHS

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 Parameters

Parameter	Type	Required	Description
`vin`	string	Yes	Path param. 17-character VIN.
`include_ai`	boolean	No	Query param. true to include AI narrative summary in response.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/vehicles/1HGCM82633A004352/health?include_ai=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

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 Parameters

Parameter	Type	Required	Description
`vin`	string	Yes	Path param. 17-character VIN.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/vehicles/1HGCM82633A004352/valuation" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

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

Request Parameters

Parameter	Type	Required	Description
`email`	string	No	Query param. Filter sessions by customer email.
`status`	string	No	Query param. Filter by status: active, resolved.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/predict/diagnose/history?email=customer%40example.com" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Email (optional)

Status

Session ID	Email	Vehicle	Status	Step	Msgs	Started	Action
Enter an email or click Search to view sessions.

Response

// Click Search to load sessions

Link Customer Email

Associate a customer's email address with an existing prediction session for follow-up.

POST /api/v1/predict/link-email

Request Parameters

Parameter	Type	Required	Description
`session_id`	string	Yes	Active diagnostic session ID to link.
`email`	string	Yes	Customer email address to associate with the session.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/link-email \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"session_id":"sess_abc123","email":"customer@example.com"}'

Try it

Request

POST /api/v1/predict/link-email

{}

Response

// Link an email to a prediction session

Submit Prediction Feedback

Use a session_id from a prediction to submit accuracy feedback.

POST /api/v1/predict/feedback

Request Parameters

Parameter	Type	Required	Description
`session_id`	string	Yes	Prediction or diagnostic session ID to rate.
`rating`	integer	Yes	Score from 1 (poor) to 5 (excellent).
`comment`	string	No	Optional free-text feedback comment.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/feedback \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"session_id":"sess_abc123","rating":4,"comment":"Accurate estimate, very helpful."}'

Try it

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 Parameters

Parameter	Type	Required	Description
`vin`	string	Yes	Vehicle VIN.
`make`	string	Yes	Vehicle make (e.g. "Honda").
`model`	string	Yes	Vehicle model (e.g. "Accord").
`year`	integer	Yes	Model year (e.g. 2019).
`repair_category_id`	integer	Yes	Category ID for the repair type.
`repair_subcategory_id`	integer	Yes	Sub-category ID for the specific repair.
`repair_date`	date	Yes	Date the repair was performed (YYYY-MM-DD).
`current_mileage`	integer	Yes	Current odometer reading in miles.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/repair-lifecycle \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"1HGCM82633A004352","make":"Honda","model":"Accord","year":2019,"repair_category_id":3,"repair_subcategory_id":14,"repair_date":"2024-03-15","current_mileage":72000}'

Try it

VIN (optional — auto-resolves make/model/year)

Make

Model (opt)

Year (opt)

Repair Category

Repair Sub-category

Repair Date (opt)

Current Mileage (opt)

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 Parameters

Parameter	Type	Required	Description
`vin`	string	Yes	Vehicle VIN.
`make`	string	Yes	Vehicle make.
`model`	string	Yes	Vehicle model.
`year`	integer	Yes	Model year.
`repair_category_id`	integer	Yes	Repair category ID.
`repair_subcategory_id`	integer	Yes	Repair sub-category ID.
`limit`	integer	No	Max sequenced repairs to return. Default: 5.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/predict/repair-sequence \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vin":"1HGCM82633A004352","make":"Honda","model":"Accord","year":2019,"repair_category_id":3,"repair_subcategory_id":14,"limit":5}'

Try it

VIN (optional — auto-resolves make/model/year)

Make

Model (opt)

Year (opt)

Repair Category

Repair Sub-category

Max Results (optional)

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

Request Parameters

Parameter	Type	Required	Description
`driver_email`	string	Yes	Email of the driver to initiate SmartCar OAuth for.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/smartcar/exchange \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"driver_email":"driver@example.com"}'

Try it

Driver Email

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 Parameters

Parameter	Type	Required	Description
`email`	string	Yes	Query param. Driver email to look up connected VINs for.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/smartcar/vin-lookup?email=driver%40example.com" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

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

Request Parameters

Parameter	Type	Required	Description
`vin`	string	Yes	Path param. 17-character VIN to sync SmartCar compliance data for.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/vehicles/1HGCM82633A004352/smartcar-compliance" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

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.

Request Parameters

Parameter	Type	Required	Description
`per_page`	integer	No	Query param. Results per page. Default: 20. Max: 100.
`page`	integer	No	Query param. Page number. Default: 1.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/predict/history?per_page=20&page=1" \
  -H "Authorization: Bearer YOUR_API_KEY"

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.

Request Parameters

Parameter	Type	Required	Description
`per_page`	integer	No	Query param. Results per page. Default: 20.
`page`	integer	No	Query param. Page number. Default: 1.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/predict/repair-lifecycle/history?per_page=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

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

Request Parameters

Parameter	Type	Required	Description
`vin`	string	Yes	Path param. 17-character VIN to compute insurance risk score for.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/vehicles/1HGCM82633A004352/insurance-risk" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

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

Request Parameters

Parameter	Type	Required	Description
`status`	string	No	Query param. Filter by status: pending, completed, overdue.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/service-schedules" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Action

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 Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Path param. Vehicle ID to list schedules for.
`status`	string	No	Query param. Filter by schedule status.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/service-schedules/vehicle/42" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Request Preview

{}

Response

{}

Get Schedule Detail

Fetch full details for a specific service schedule ID.

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

Request Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Path param. Unique ID of the service schedule to retrieve.

Example Request

curl -X GET "https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/service-schedules/17" \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Schedule ID

Response

{}

Create Service Schedule

Register a new maintenance appointment for a fleet vehicle.

POST /api/v1/fleet/service-schedules

Request Parameters

Parameter	Type	Required	Description
`vehicle_id`	integer	Yes	Database ID of the vehicle.
`service_type`	string	Yes	Type of service (e.g. "Oil Change", "Brake Inspection").
`workshop_id`	integer	No	ID of the workshop to assign the schedule to.
`due_date`	date	Yes	Scheduled service date in YYYY-MM-DD format.
`due_mileage`	integer	No	Mileage threshold that triggers the service.
`notes`	string	No	Additional notes for the technician.

Example Request

curl -X POST https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/service-schedules \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vehicle_id":42,"service_type":"Oil Change","due_date":"2024-09-15","due_mileage":75000,"notes":"Use full synthetic 5W-30"}'

Try it

Vehicle ID

Service Type

Workshop ID (Optional)

Due Date

Due Mileage

Notes

Request Preview

{}

Response

{}

Update Service Schedule

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

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

Request Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Path param. ID of the schedule to update.
`status`	string	No	New status: pending, completed, cancelled.
`scheduled_date`	date	No	Updated service date (YYYY-MM-DD).
`notes`	string	No	Updated notes.

Example Request

curl -X PUT https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/service-schedules/17 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"completed","notes":"Completed ahead of schedule"}'

Try it

Schedule ID

Status

Update Date

Update Notes

Response

{}

Delete Service Schedule

Permanently remove a maintenance appointment.

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

Request Parameters

Parameter	Type	Required	Description
`id`	integer	Yes	Path param. ID of the service schedule to permanently delete.

Example Request

curl -X DELETE https://dev.api.aiadmin.quickmechs.com/api/v1/fleet/service-schedules/17 \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Schedule ID

Response

{}

QuickMechs API Dashboard

Documentation Index

AI Diagnostics & Repair

Prediction & Diagnostics

Vehicle Data

Decoding & Lookup

Vehicle Intelligence

Health, Compliance & Valuation

Fleet Management

Schedules & Fleet

Body Shop

Introduction

Quick Start

Guide Links

Authentication

Required Headers

Keep Your API Key Secure

Environments

Errors

Error Response Format

Common Status Codes

Rate Limits

Rate Limit Headers

Best Practices

Configuration

Developer Settings

Universal Price Adjustment

Body Shop Image Match

Request Parameters

Example Request

Predict VIN Market Match

Request Parameters

Example Request

Predict by VIN

Request Parameters

Example Request

Predict by Vehicle Specs

Request Parameters

Example Request

Plate to VIN Lookup

Request Parameters

Example Request

VIN Lookup

Request Parameters

Example Request

NHTSA Recall Lookup

Request Parameters

Example Request

Vehicle Compliance Update

Request Parameters

Example Request

Fleet — Lookup VINs by Email

Request Parameters

Example Request

Extract VIN from Image

Request Parameters

Example Request

Search Sub-categories

Request Parameters

Example Request

Describe Sub-category

Request Parameters

Example Request

AI Repair Recommendation

Request Parameters

Example Request

AI Diagnostic Chat

Request Parameters

Example Request

Tire Catalog

Example Request

Live Tire Estimation

Request Parameters

Example Request

Save Tire Data

Request Parameters

Example Request

Full Vehicle Health Score

Request Parameters

Example Request