OpenAPI reference
The checked-in OpenAPI artifact planned for this docs route is not in the repo yet. Until then, this page lists the v1 routes from `api/src/atc_lpr_api/main.py` and links to the live generated schema.
Live OpenAPI JSON
FastAPI emits the current schema from the running service at `/v1/openapi.json`.
FastAPI docs UI
The service also exposes FastAPI's generated docs UI at `/v1/docs`.
Source-defined endpoints
/v1/read
Requires X-API-KeyReads one tight plate crop and returns OCR confidence detail.
Request
multipart/form-data with image file field `image`; optional `tier_threshold` query parameter.
Response
`ReadResponse`: plate, ACCEPT / RETRY / NO_READ decision, calibrated confidence, per-character alternatives, grammar result, model tags, and request_id.
/v1/read-batch
Requires X-API-KeyReads a bounded batch of base64-encoded plate crops.
Request
JSON body with `items`, each carrying `image_base64` and optional caller `id`; optional body-level `tier_threshold`.
Response
`ReadBatchResponse`: request metadata plus per-item success responses or isolated per-item errors.
/v1/health
OpenHealth check for load balancers and readiness probes.
Request
No request body.
Response
`HealthResponse`: status, model version, calibration version, weights hash, device, uptime, and API version.
/v1/metrics
OpenPrometheus metrics scrape endpoint.
Request
No request body.
Response
Prometheus text exposition format.
First request
`POST /v1/read` is the shortest path to a live plate read.
curl -X POST https://praxisedge.ai/v1/read \
-H 'X-API-Key: pe_live_replace_with_your_key' \
-F '[email protected]'Roadmap
An auto-generated interactive reference is still planned.
The build-time `api/openapi.json` file described in the web UI plan does not exist yet. When that artifact is generated, this route can switch from static route cards to a generated schema view without adding a client-side OpenAPI renderer.
Quickstart