Developer documentation · v0.1 MVP

Build on PraxisEdge

One response schema across REST, WebSocket, and MQTT. Start with curl, graduate to a typed SDK, and keep the same mental model either way.

Quickstart

Get your first plate read through `/v1/read` in under a minute — three lines of curl, zero SDKs required.

Start here

REST reference

Current source-defined routes for `/v1/read`, `/v1/read-batch`, `/v1/health`, `/v1/metrics`, and the live OpenAPI schema.

Open reference

Streaming (WS + MQTT)

Coming soon

Open a WebSocket or MQTT session and receive plate reads as they happen. Shared protobuf schema, resumable reconnects, backpressure semantics.

SDKs

Preview Python and TypeScript client libraries for REST + WebSocket. Registry packages are not published yet; install from source.

Open SDK overview

Reference pages

API reference

Static endpoint list plus links to the live FastAPI OpenAPI JSON and docs UI.

Open API docs

Python SDK

Preview `atclpr` imports, source install, and a minimal async read example.

Open Python docs

TypeScript SDK

Preview `@atclpr/client` exports, source install, and a minimal read example.

Open TypeScript docs

While the reference fills in…

The quickstart is the fastest way to see the platform answer a real plate. Once you have a key, the in-app onboarding walks you through sites and cameras. For anything the docs haven't covered yet, email [email protected] — a real engineer reads those.