SDKs - Unkey Docs

Use an SDK to call the Unkey API from your code. We publish clients for TypeScript, Go, and Python that cover every endpoint, plus smaller TypeScript packages for one job each, such as verifying keys in a Hono route. The community maintains a Nuxt module. Every package that calls the API needs a root key.

You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys, and pass it as Authorization: Bearer <root key>. See Permission reference for every permission.

Packages

Package	Language	Current version
@unkey/api	TypeScript	Generated client for the whole API
@unkey/ratelimit	TypeScript	Standalone rate limiting with timeouts and fallbacks
@unkey/hono	TypeScript	Hono middleware that verifies the bearer key
@unkey/nextjs	TypeScript	`withUnkey` wrapper for Next.js route handlers
@unkey/cache	TypeScript	Typed tiered cache with stale-while-revalidate
Go SDK	Go	Generated client, module `github.com/unkeyed/sdks/api/go/v3`
Python SDK	Python	Generated client `unkey.py`, sync and async
Nuxt module	TypeScript	Community-maintained Nuxt integration

The TypeScript, Go, and Python clients match the API reference, so method names and fields line up across languages. The Python client () covers API Management only. The TypeScript and Go clients also cover Compute.

Which package to use

@unkey/api, the Go SDK, or the Python SDK when you call several endpoints or want full types.
@unkey/hono or @unkey/nextjs when you only need to check incoming requests for a valid key. They call keys.verifyKey and give your handler the result.
@unkey/ratelimit to rate limit user IDs or IP addresses without issuing keys. It adds a timeout and fallback so a network problem can’t block your function.
@unkey/cache for typed caching in your own services. It doesn’t call the Unkey API.

One client, both products

The TypeScript and Go clients cover Compute too, so the same Unkey instance that a key can create a deployment for a Compute . The Go SDK page shows the same pair in Go. From Python, call Compute endpoints over HTTP. The endpoints are keys.verifyKey and deployments.createDeploymentV3.

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

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

const result = await unkey.keys.verifyKey({ key: "prod_abc123" });

if (!result.data.valid) {
  // result.data.code says why: NOT_FOUND, DISABLED, EXPIRED, RATE_LIMITED, ...
}

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

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

const result = await unkey.deployments.createDeploymentV3({
  project: "my-project",
  app: "api",
  environment: "production",
  oci: { image: "ghcr.io/acme/api:v1.0.0" },
});

console.log(result.data.deploymentId);

For Compute concepts such as projects, apps, and , see Projects, apps, and environments.

Response shape

Every successful response has meta.requestId (quote it when you contact support) and data, the result. Errors are thrown or returned as typed errors per HTTP status. Each SDK page shows how to catch them. See API overview for the raw format.

Next steps

@unkey/api

Install, construct, verify and create keys, handle errors.

Go SDK

go get the v3 module the CLI uses.

Python SDK

unkey.py with sync and async clients.

​Packages

​Which package to use

​One client, both products

​Response shape

​Next steps

@unkey/api

Go SDK

Python SDK

Packages

Which package to use

One client, both products

Response shape

Next steps