Overview

If you prefer a typed experience over calling http endpoints directly, you can use our sdk @unkey/api.

​

Install

• npm
• pnpm
• yarn
• bun

 npm install @unkey/api

​

Unkey Root Key

When creating, revoking or updating resources, you will need your root key — you can create a new one in the settings. Afterwards you need to provide it to the client:

import { Unkey } from "@unkey/api";

const unkey = new Unkey({ rootKey: "<UNKEY_ROOT_KEY>" });

Always keep your root key safe and reset it if you suspect it has been compromised.

​

Response format

Because forgetting to handle thrown errors properly in javascript is often forgotten, we have decided to explicitly return errors to be handled. Fortunately typescript helps us here and everything is typesafe.

Every method returns either an error or a result field, never both and never none.

​

Checking for errors

To check for errors you use the error property, our errors are easy to read and provide a link to our documentation for more information.

import { verifyKey } from "@unkey/api";

const { result, error } = await verifyKey("key_123");

if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}

if (!result.valid) {
  // do not grant access
  return;
}

// process request
console.log(result);

​

Options

The constructor accepts some options to customize the behavior:

​

Base Url

Run all requests against your own instance of unkey hosted on your own infrastructure.

const unkey = new Unkey({
  //...
  baseUrl: "https://my.domain"
})

​

Retries

By default the client will retry on network errors, you can customize this behavior:

const unkey = new Unkey({
  // ...
  retry: {
    attempts: 3,
    backoff: (retryCount) => retryCount * 1000
  }
})

​

Cache

Configure the fetch cache behavior.

const unkey = new Unkey({
  // ...
  cache: "no-cache"
})

​

Disable telemetry

By default, Unkey collects anonymous telemetry data to help us understand which versions of our SDK is being used, and in which environment.

If you wish to disable this, you can do so by passing a boolean flag to the constructor:

const unkey = new Unkey({
  disableTelemetry: true
})