\r \r

CarsXE Skill\r

\r CarsXE provides a REST API for comprehensive vehicle data. All endpoints are at\r https://api.carsxe.com and require an API key passed as ?key=YOUR_API_KEY.\r \r

API Key setup: The user must have a CarsXE API key from https://api.carsxe.com/dashboard/developer.\r If no key is configured, ask the user to provide it before making any API calls.\r \r See references/api-reference.md for full endpoint details, parameters, and response formats.\r \r ---\r \r

Quick API Map\r

\r | User intent | Endpoint | Parameters |\r |---|---|---|\r | Decode a VIN / get specs | GET /specs | vin |\r | Decode a license plate | GET /platedecoder | plate, country (required), state (optional) |\r | Market value | GET /marketvalue | vin |\r | Vehicle history report | GET /history | vin |\r | Vehicle images | GET /images | make, model + optional filters |\r | Safety recalls | GET /recalls | vin |\r | Lien & theft check | GET /lientheft | vin |\r | International VIN | GET /internationalvin | vin |\r | Year/Make/Model lookup | GET /ymm | year, make, model, optional trim |\r | OBD code diagnosis | GET /obd | code |\r | VIN OCR from image | POST /vinocr | imageUrl in JSON body |\r | Plate OCR from image | POST /platerecognition | imageUrl in JSON body |\r \r ---\r \r

Workflow\r

\r

1. Authenticate\r

Always confirm or ask for the API key before making requests. The key is passed as a query param:\r

https://api.carsxe.com/specs?key=USER_API_KEY&vin=WBAFR7C57CC811956\r
```\r
\r
### 2. Choose the right endpoint\r
Match the user's query to the table above. When context is ambiguous:\r
- VIN provided → prefer `/specs` first, then chain to other endpoints as needed\r
- Plate provided → use `/platedecoder` to resolve VIN, then chain if needed\r
- Make/Model/Year only → use `/ymm` or `/images`\r
- OBD code (P/C/B/U + digits) → use `/obd`\r
- Image URL provided → use `/vinocr` or `/platerecognition` (POST)\r
\r
### 3. Chain requests when helpful\r
A common power workflow: plate → VIN → specs + history + recalls in parallel.\r
Example: *"Is this plate stolen and does it have open recalls?"*\r
1. `GET /platedecoder` → extract VIN\r
2. In parallel: `GET /lientheft` + `GET /recalls`\r
\r
### 4. Present results\r
Format output clearly with sections per API call. Use Markdown tables or lists for specs,\r
highlight important findings (open recalls, theft records, salvage titles) prominently.\r
\r
---\r
\r
## Error Handling\r
\r
| HTTP Status | Meaning | Action |\r
|---|---|---|\r
| 401 / `invalid key` | Bad or missing API key | Ask user to check their key |\r
| 404 / `no results` | VIN/plate not found in database | Inform user, suggest double-checking |\r
| 429 | Rate limit exceeded | Wait and retry, inform user |\r
| 5xx | Server error | Retry once, then report error |\r
\r
Always check the `error` field in JSON responses — CarsXE sometimes returns HTTP 200 with an error body.\r
\r
---\r
\r
## Examples\r
\r
**"What are the specs for VIN WBAFR7C57CC811956?"**\r
→ `GET https://api.carsxe.com/specs?key=KEY&vin=WBAFR7C57CC811956`\r
\r
**"Decode California plate 7XER187"**\r
→ `GET https://api.carsxe.com/platedecoder?key=KEY&plate=7XER187&state=CA&country=US`\r
\r
**"What's my car worth? VIN WBAFR7C57CC811956"**\r
→ `GET https://api.carsxe.com/marketvalue?key=KEY&vin=WBAFR7C57CC811956`\r
\r
**"Does this car have any recalls? 1C4JJXR64PW696340"**\r
→ `GET https://api.carsxe.com/recalls?key=KEY&vin=1C4JJXR64PW696340`\r
\r
**"My check engine light shows P0300"**\r
→ `GET https://api.carsxe.com/obd?key=KEY&code=P0300`\r
\r
**"Extract the VIN from this photo: https://example.com/vin.jpg"**\r
→ `POST https://api.carsxe.com/vinocr?key=KEY` with body `{"imageUrl":"https://example.com/vin.jpg"}`\r
\r
---\r
\r
## Reference Files\r
\r
- `references/api-reference.md` — Full parameter lists, response field descriptions, and edge cases for all 11 endpoints. Read this when you need exact field names or want to use optional filters.