> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Plate Recognizer plugin

> Read license plates (with optional make, model and color) and text identifiers such as VINs, trailer ids and odometers from images, and check usage. Requests send Authorization Token.

Use **Plate Recognizer** through Corsair: one client, typed API calls, local DB sync.

Auth is `Authorization: Token <key>`, not Bearer; the key is on the Snapshot Cloud dashboard. A missing or wrong token returns HTTP 403. Each `plates.read` uses one Snapshot lookup and each `ocr.read` one OCR call from the plan's monthly allowance. Plate text is not stored, because a plate is not a stable id. Snapshot usage is stored per year and month.

OCR is a separate Plate Recognizer product: an account without it gets `403` from `ocr.read`.

**What you get:**

* 4 typed API operations
* 1 synced entity (`usage`) for fast `.search()` / `.list()`

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/platerecognizer better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/platerecognizer better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/platerecognizer better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/platerecognizer better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { platerecognizer } from '@corsair-dev/platerecognizer';

export const corsair = createCorsair({
	plugins: [
		platerecognizer(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Plate Recognizer API key before the first call: `pnpm corsair setup --plugin=platerecognizer --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> platerecognizer()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'platerecognizer',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Read the plates in an image by URL**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.platerecognizer.api.plates.read({
	uploadUrl: 'https://app.platerecognizer.com/static/demo.jpg',
	regions: ['us-ca'],
});
```

**Write**

*No write-style endpoint inferred; pick any operation from the [API](https://docs.corsair.dev/plugins/platerecognizer/api.md) reference.*

See the full list on the [API](https://docs.corsair.dev/plugins/platerecognizer/api.md) page.

## Query synced data

Synced entities support `tenant.platerecognizer.db.<entity>.search()` and `.list()`: `usage`.

See [Database](https://docs.corsair.dev/plugins/platerecognizer/database.md) for filters and operators.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/platerecognizer/api.md)
>
> Every `platerecognizer.api.*` operation with input and output types.

> [card] [Database](https://docs.corsair.dev/plugins/platerecognizer/database.md)
>
> Synced entities, search filters, and operators.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.