> ## 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.

# Genderize plugin

> Predict the gender behind a first or full name with Genderize - one name or a batch, each answer scored with a confidence and the number of records behind it.

Use **Genderize** through Corsair: one client, typed API calls.

Copy the API key from your Genderize dashboard. The key travels as the `apikey` **query parameter**, which is where the API expects it, not as a header.

Things to know before you call:

* **A key is optional.** A live probe without one still answered, because Genderize serves a small IP-scoped allowance (10 names per window in a probe on 2026-11-14) before it asks for an account. Passing a key raises the allowance and is what the account is billed against, so configure one for anything beyond a trial. Because a missing key is valid, Corsair does not prompt a tenant for one: connect the key with a connect link or pass `key` to `genderize()`. On a shared server every keyless tenant draws on the same IP allowance.
* **A name it does not know is not an error.** The answer is HTTP 200 with `gender: null`, `probability: 0` and `count: 0`. The name still counts against the monthly quota, so check `gender` rather than relying on the call to fail.
* **A full name is more accurate than a first name.** Every part carries signal: a surname such as Jónsdóttir is used only by women, so `Alex Jónsdóttir` resolves as female even though `Alex` alone leans male. Genderize finds the name parts itself, so `Tanaka Hiroshi` and `Hiroshi Tanaka` give the same answer.
* **Country changes the answer.** `Kim` is mostly female worldwide but overwhelmingly male in Denmark, so pass `country_id` when the country is known.
* **A batch counts each name against the monthly quota.** `batch` sends up to 100 names in one request and answers an array in the same order as the input. Its `country_id` applies to every name in it, not to one.
* **429 means two different things.** It is either the exhausted quota (`Request limit reached`), which the plugin does not retry because it lasts until the window resets, or a short-term throttle (`Request too low to process`), which it retries with backoff.

**What you get:**

* 2 typed API operations

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/genderize 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 { genderize } from '@corsair-dev/genderize';

export const corsair = createCorsair({
	plugins: [
		genderize(),
	],
	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 Genderize API key before the first call: `pnpm corsair setup --plugin=genderize --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}
> genderize()
> ```
>
> 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: 'genderize',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Predict the gender behind a name**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.genderize.api.name.predict({ name: 'peter' });
```

**Write**

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

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

## What's next

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

> [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.