```bash npm install @unkey/api ```
@unkey/api is a TypeScript client for Unkey. If you prefer a typed experience over calling HTTP endpoints directly, this SDK is for you.``bash`
npm install @unkey/api
1. Create a new Unkey Root Key in the settings.
2. Use the root key to initialize the client:
`ts
import { Unkey } from "@unkey/api";
const unkey = new Unkey({ rootKey: "
`
Important: Always keep your root key safe and reset it if you suspect it has been compromised.
`ts
import { verifyKey } from "@unkey/api";
const { result, error } = await verifyKey("key_123");
if (error) {
console.error(error.message);
// Handle potential network or bad request error
// A link to our docs will be in the error.docs field
return;
}
if (!result.valid) {
// Do not grant access
return;
}
// Process request
console.log(result);
`
All methods return either an error or a result field, never both and never none. This approach helps with proper error handling.
`ts`
{
result: T; // The result depends on what method you called
}
`ts`
{
error: {
message: string;
docs: string; // URL to relevant documentation
}
}
You can customize the base URL for all requests:
`ts`
const unkey = new Unkey({
rootKey: "
baseUrl: "https://my.domain",
});
Configure retry behavior for network errors:
`ts`
const unkey = new Unkey({
rootKey: "
retry: {
attempts: 3,
backoff: (retryCount) => retryCount * 1000,
},
});
To opt out of anonymous telemetry data collection:
`ts``
const unkey = new Unkey({
rootKey: "
disableTelemetry: true,
});