SDKs Overview

npm install @unkey/api

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

const unkey = new Unkey({
  rootKey: process.env.UNKEY_ROOT_KEY!,
});

const { data } = await unkey.keys.verifyKey({
  key: "sk_live_...",
});

if (!data.valid) {
  console.log(`Key invalid: ${data.code}`);
  return;
}

console.log("Key is valid!");
console.log(`Key ID: ${data.keyId}`);

const { data } = await unkey.keys.create({
  apiId: "api_...",
  prefix: "sk_live",
  externalId: "user_123",
  remaining: 1000,
  meta: {
    plan: "pro",
  },
});

console.log("New key:", data.key);
console.log("Key ID:", data.keyId);

import { Ratelimit } from "@unkey/ratelimit";

const limiter = new Ratelimit({
  rootKey: process.env.UNKEY_ROOT_KEY!,
  namespace: "my-app",
  limit: 100,
  duration: "60s",
});

const { success, remaining, reset } = await limiter.limit("user_123");

if (!success) {
  console.log(`Rate limited. Reset at: ${reset}`);
}

await unkey.keys.update({
  keyId: "key_...",
  name: "Updated name",
  enabled: true,
  meta: { plan: "enterprise" },
});

await unkey.keys.delete({
  keyId: "key_...",
});

try {
  const { data } = await unkey.keys.create({
    apiId: "api_...",
  });
  
  console.log("Created:", data.key);
} catch (err) {
  console.error("API Error:", err);
  // Handle error
}