TypeScript SDK reference
The `@atclpr/client` package source is in `sdk/typescript` and exports typed REST, streaming, events, and error APIs. It is not published to npm yet.
Install
Source package install only until npm publication.
# Preview: @atclpr/client is not published to npm yet.
# Install from the repo source package until registry publication.
git clone <repo-url> praxisedge-lpr
cd praxisedge-lpr/sdk/typescript
npm install # preview: install SDK dependencies from source
npm run build
npm pack
npm install ./atclpr-client-0.1.0.tgz # preview: install local source packageMinimal read
Import `ApiClient` from the package root export.
import { readFile } from "node:fs/promises";
import { ApiClient } from "@atclpr/client";
const api = new ApiClient({
baseUrl: "https://praxisedge.ai",
apiKey: process.env.PRAXISEDGE_API_KEY!,
});
const reply = await api.read(await readFile("plate.jpg"));
console.log(reply.plate, reply.decision, reply.requestId);Public exports
Names re-exported by `sdk/typescript/src/index.ts`.
REST client
Streaming client
Events client
Errors
ApiClient surface
Current methods from `sdk/typescript/src/api/client.ts`.
read(image)
Calls `/v1/read` for one plate crop and returns `ReadResponse`.
readBatch(items)
Calls `/v1/read-batch` with `Uint8Array` or `BatchItem` values.
detect(image)
Calls `/v1/detect` when a detector origin is available.
health()
Reads `/v1/health` and returns status, model version, and device.
usageDaily({ start, end })
Reads billing rollups when the deployment exposes usage endpoints.
iterRead(images)
Async generator for concurrent REST reads over image iterables.
Start with the raw API contract
The quickstart shows the underlying `/v1/read` request before you add the preview SDK.