API Reference (Swagger)
Full endpoint specs and interactive try-it-out.
API Reference (Swagger)
This page points you to the Swagger UI where you can explore all VehiCore endpoints, see request/response schemas, and send test requests from your browser.
Where to find it
| Environment | Swagger UI |
|---|---|
| Staging | Api Documentation |
| Production | Update when live |
Open the link for your environment to get:
- Endpoint list — All available operations (OCR, damage recognition, car-side recognition, etc.).
- Includes: OCR, damage recognition, car-side recognition, image classification, normalize, valuation, and more.
- Parameters & bodies — Required and optional fields, types, and examples.
- Responses — Response schemas and status codes.
- Try it out — Send real requests from the browser (add your
X-API-Keyin Swagger’s Authorize or per-request headers).
Authentication in Swagger
- Open Authorize (or the lock icon) in Swagger UI.
- Enter your API key in the X-API-Key (or apiKey) field.
- Authorize once; Swagger will send the key on every Try it out request.
Your key is the same one you use in code. To get a key, register and purchase at vehicore.pro/api-keys (see Get Started).
Error responses
All VehiCore API endpoints return errors in a consistent shape:
{
"message": "Human-readable error message",
"code": "OPTIONAL_CODE"
}| Status | Code | Description |
|---|---|---|
| 400 | VALIDATION_ERROR | Bad Request — invalid input or validation failed (e.g. missing required field, invalid format). |
| 401 | UNAUTHORIZED | Unauthorized — missing or invalid authentication (e.g. missing X-API-Key, invalid or expired token). |
| 402 | INSUFFICIENT_CREDITS | Payment Required — insufficient credits for this product. Purchase more from the Billing page. |
| 403 | FORBIDDEN | Forbidden — valid credentials but not allowed to perform this action. |
| 404 | NOT_FOUND | Not Found — resource does not exist. |
| 500 | — | Internal Server Error — unexpected server error; retry later. |
Full request/response schemas and per-endpoint error details are in Swagger.
OpenAPI spec
If you need the raw OpenAPI (Swagger) spec (e.g. for codegen or tooling):