@unkey/api 2.0.0-alpha.7 → 2.0.0

package/dist/esm/sdk/ratelimit.js

@@ -9,20 +9,88 @@ import { ratelimitSetOverride } from "../funcs/ratelimitSetOverride.js";
 import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "../types/fp.js";
 export class Ratelimit extends ClientSDK {
-    async limit(request, options) {
-        return unwrapAsync(ratelimitLimit(this, request, options));
-    }
-    async setOverride(request, options) {
-        return unwrapAsync(ratelimitSetOverride(this, request, options));
+    /**
+     * Delete ratelimit override
+     *
+     * @remarks
+     * Permanently remove a rate limit override. Affected identifiers immediately revert to the namespace default.
+     *
+     * Use this to remove temporary overrides, reset identifiers to standard limits, or clean up outdated rules.
+     *
+     * **Important:** Deletion is immediate and permanent. The override cannot be recovered and must be recreated if needed again.
+     *
+     * **Permissions:** Requires `ratelimit.*.delete_override` or `ratelimit.<namespace_id>.delete_override`
+     */
+    async deleteOverride(request, options) {
+        return unwrapAsync(ratelimitDeleteOverride(this, request, options));
     }
+    /**
+     * Get ratelimit override
+     *
+     * @remarks
+     * Retrieve the configuration of a specific rate limit override by its identifier.
+     *
+     * Use this to inspect override configurations, audit rate limiting policies, or debug rate limiting behavior.
+     *
+     * **Important:** The identifier must match exactly as specified when creating the override, including wildcard patterns.
+     *
+     * **Permissions:** Requires `ratelimit.*.read_override` or `ratelimit.<namespace_id>.read_override`
+     */
     async getOverride(request, options) {
         return unwrapAsync(ratelimitGetOverride(this, request, options));
     }
+    /**
+     * Apply rate limiting
+     *
+     * @remarks
+     * Check and enforce rate limits for any identifier (user ID, IP address, API client, etc.).
+     *
+     * Use this for rate limiting beyond API keys - limit users by ID, IPs by address, or any custom identifier. Supports namespace organization, variable costs, and custom overrides.
+     *
+     * **Important**: Always returns HTTP 200. Check the `success` field to determine if the request should proceed.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `ratelimit.*.limit` (to check limits in any namespace)
+     * - `ratelimit.<namespace_id>.limit` (to check limits in a specific namespace)
+     *
+     * **Side Effects**
+     *
+     * Records rate limit metrics for analytics and monitoring, updates rate limit counters with sliding window algorithm, and optionally triggers override matching for custom limits.
+     */
+    async limit(request, options) {
+        return unwrapAsync(ratelimitLimit(this, request, options));
+    }
+    /**
+     * List ratelimit overrides
+     *
+     * @remarks
+     * Retrieve a paginated list of all rate limit overrides in a namespace.
+     *
+     * Use this to audit rate limiting policies, build admin dashboards, or manage override configurations.
+     *
+     * **Important:** Results are paginated. Use the cursor parameter to retrieve additional pages when more results are available.
+     *
+     * **Permissions:** Requires `ratelimit.*.read_override` or `ratelimit.<namespace_id>.read_override`
+     */
     async listOverrides(request, options) {
         return unwrapAsync(ratelimitListOverrides(this, request, options));
     }
-    async deleteOverride(request, options) {
-        return unwrapAsync(ratelimitDeleteOverride(this, request, options));
+    /**
+     * Set ratelimit override
+     *
+     * @remarks
+     * Create or update a custom rate limit for specific identifiers, bypassing the namespace default.
+     *
+     * Use this to create premium tiers with higher limits, apply stricter limits to specific users, or implement emergency throttling.
+     *
+     * **Important:** Overrides take effect immediately and completely replace the default limit for matching identifiers. Use wildcard patterns (e.g., `premium_*`) to match multiple identifiers.
+     *
+     * **Permissions:** Requires `ratelimit.*.set_override` or `ratelimit.<namespace_id>.set_override`
+     */
+    async setOverride(request, options) {
+        return unwrapAsync(ratelimitSetOverride(this, request, options));
     }
 }
 //# sourceMappingURL=ratelimit.js.map

package/dist/esm/sdk/ratelimit.js.map

@@ -1 +1 @@
-{"version":3,"file":"ratelimit.js","sourceRoot":"","sources":["../../../src/sdk/ratelimit.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC,KAAK,CAAC,KAAK,CACT,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,WAAW,CACf,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,WAAW,CACf,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,OAAuD,EACvD,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"ratelimit.js","sourceRoot":"","sources":["../../../src/sdk/ratelimit.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,cAAc,CAClB,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,WAAW,CACf,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,KAAK,CACT,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CACjB,OAAuD,EACvD,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,WAAW,CACf,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/sdk.d.ts

@@ -1,16 +1,19 @@
 import { ClientSDK } from "../lib/sdks.js";
 import { Apis } from "./apis.js";
 import { Identities } from "./identities.js";
-import { Liveness } from "./liveness.js";
+import { Keys } from "./keys.js";
+import { Permissions } from "./permissions.js";
 import { Ratelimit } from "./ratelimit.js";
 export declare class Unkey extends ClientSDK {
-    private _ratelimit?;
-    get ratelimit(): Ratelimit;
-    private _identities?;
-    get identities(): Identities;
     private _apis?;
     get apis(): Apis;
-    private _liveness?;
-    get liveness(): Liveness;
+    private _identities?;
+    get identities(): Identities;
+    private _keys?;
+    get keys(): Keys;
+    private _permissions?;
+    get permissions(): Permissions;
+    private _ratelimit?;
+    get ratelimit(): Ratelimit;
 }
 //# sourceMappingURL=sdk.d.ts.map

package/dist/esm/sdk/sdk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,qBAAa,KAAM,SAAQ,SAAS;IAClC,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED,OAAO,CAAC,WAAW,CAAC,CAAa;IACjC,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,OAAO,CAAC,SAAS,CAAC,CAAW;IAC7B,IAAI,QAAQ,IAAI,QAAQ,CAEvB;CACF"}
+{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,qBAAa,KAAM,SAAQ,SAAS;IAClC,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,OAAO,CAAC,WAAW,CAAC,CAAa;IACjC,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;CACF"}

package/dist/esm/sdk/sdk.js

@@ -4,20 +4,24 @@
 import { ClientSDK } from "../lib/sdks.js";
 import { Apis } from "./apis.js";
 import { Identities } from "./identities.js";
-import { Liveness } from "./liveness.js";
+import { Keys } from "./keys.js";
+import { Permissions } from "./permissions.js";
 import { Ratelimit } from "./ratelimit.js";
 export class Unkey extends ClientSDK {
-    get ratelimit() {
-        return (this._ratelimit ?? (this._ratelimit = new Ratelimit(this._options)));
+    get apis() {
+        return (this._apis ?? (this._apis = new Apis(this._options)));
     }
     get identities() {
         return (this._identities ?? (this._identities = new Identities(this._options)));
     }
-    get apis() {
-        return (this._apis ?? (this._apis = new Apis(this._options)));
+    get keys() {
+        return (this._keys ?? (this._keys = new Keys(this._options)));
+    }
+    get permissions() {
+        return (this._permissions ?? (this._permissions = new Permissions(this._options)));
     }
-    get liveness() {
-        return (this._liveness ?? (this._liveness = new Liveness(this._options)));
+    get ratelimit() {
+        return (this._ratelimit ?? (this._ratelimit = new Ratelimit(this._options)));
     }
 }
 //# sourceMappingURL=sdk.js.map

package/dist/esm/sdk/sdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,OAAO,KAAM,SAAQ,SAAS;IAElC,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;IAGD,IAAI,UAAU;QACZ,OAAO,CAAC,IAAI,CAAC,WAAW,KAAhB,IAAI,CAAC,WAAW,GAAK,IAAI,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC9D,CAAC;IAGD,IAAI,IAAI;QACN,OAAO,CAAC,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClD,CAAC;IAGD,IAAI,QAAQ;QACV,OAAO,CAAC,IAAI,CAAC,SAAS,KAAd,IAAI,CAAC,SAAS,GAAK,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC1D,CAAC;CACF"}
+{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,OAAO,KAAM,SAAQ,SAAS;IAElC,IAAI,IAAI;QACN,OAAO,CAAC,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClD,CAAC;IAGD,IAAI,UAAU;QACZ,OAAO,CAAC,IAAI,CAAC,WAAW,KAAhB,IAAI,CAAC,WAAW,GAAK,IAAI,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC9D,CAAC;IAGD,IAAI,IAAI;QACN,OAAO,CAAC,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClD,CAAC;IAGD,IAAI,WAAW;QACb,OAAO,CAAC,IAAI,CAAC,YAAY,KAAjB,IAAI,CAAC,YAAY,GAAK,IAAI,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAChE,CAAC;IAGD,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;CACF"}

package/dist/esm/types/constdatetime.js

@@ -5,6 +5,6 @@ import * as z from "zod";
 export function constDateTime(val) {
     return z.custom((v) => {
         return (typeof v === "string" && new Date(v).getTime() === new Date(val).getTime());
-    }, `Value must be equivelant to ${val}`);
+    }, `Value must be equivalent to ${val}`);
 }
 //# sourceMappingURL=constdatetime.js.map

package/docs/sdks/apis/README.md

@@ -3,27 +3,44 @@
 
 ## Overview
 
+API management operations
+
 ### Available Operations
 
-* [createApi](#createapi)
+* [createApi](#createapi) - Create API namespace
+* [deleteApi](#deleteapi) - Delete API namespace
+* [getApi](#getapi) - Get API namespace
+* [listKeys](#listkeys) - List API keys
 
 ## createApi
 
+Create an API namespace for organizing keys by environment, service, or product.
+
+Use this to separate production from development keys, isolate different services, or manage multiple products. Each API gets a unique identifier and dedicated infrastructure for secure key operations.
+
+**Important**: API names must be unique within your workspace and cannot be changed after creation.
+
+**Required Permissions**
+
+Your root key must have one of the following permissions:
+- `api.*.create_api` (to create APIs in any workspace)
+
+
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createApi" method="post" path="/v2/apis.createApi" -->
 ```typescript
 import { Unkey } from "@unkey/api";
 
 const unkey = new Unkey({
-  rootKey: "UNKEY_ROOT_KEY",
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
 });
 
 async function run() {
   const result = await unkey.apis.createApi({
-    name: "my-api",
+    name: "payment-service-production",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -41,39 +58,311 @@ import { apisCreateApi } from "@unkey/api/funcs/apisCreateApi.js";
 // Use `UnkeyCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const unkey = new UnkeyCore({
-  rootKey: "UNKEY_ROOT_KEY",
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
 });
 
 async function run() {
   const res = await apisCreateApi(unkey, {
-    name: "my-api",
+    name: "payment-service-production",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("apisCreateApi failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V2ApisCreateApiRequestBody](../../models/components/v2apiscreateapirequestbody.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.V2ApisCreateApiResponseBody](../../models/components/v2apiscreateapiresponsebody.md)\>**
+
+### Errors
+
+| Error Type                         | Status Code                        | Content Type                       |
+| ---------------------------------- | ---------------------------------- | ---------------------------------- |
+| errors.BadRequestErrorResponse     | 400                                | application/json                   |
+| errors.UnauthorizedErrorResponse   | 401                                | application/json                   |
+| errors.ForbiddenErrorResponse      | 403                                | application/json                   |
+| errors.InternalServerErrorResponse | 500                                | application/json                   |
+| errors.APIError                    | 4XX, 5XX                           | \*/\*                              |
+
+## deleteApi
+
+Permanently delete an API namespace and immediately invalidate all associated keys.
+
+Use this for cleaning up development environments, retiring deprecated services, or removing unused resources. All keys in the namespace are immediately marked as deleted and will fail verification with `code=NOT_FOUND`.
+
+**Important**: This operation is immediate and permanent. Verify you have the correct API ID before deletion. If delete protection is enabled, disable it first through the dashboard or API configuration.
+
+**Required Permissions**
+
+Your root key must have one of the following permissions:
+- `api.*.delete_api` (to delete any API)
+- `api.<api_id>.delete_api` (to delete a specific API)
+
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="deleteApi" method="post" path="/v2/apis.deleteApi" -->
+```typescript
+import { Unkey } from "@unkey/api";
+
+const unkey = new Unkey({
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await unkey.apis.deleteApi({
+    apiId: "api_1234abcd",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { UnkeyCore } from "@unkey/api/core.js";
+import { apisDeleteApi } from "@unkey/api/funcs/apisDeleteApi.js";
+
+// Use `UnkeyCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const unkey = new UnkeyCore({
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await apisDeleteApi(unkey, {
+    apiId: "api_1234abcd",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("apisDeleteApi failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V2ApisDeleteApiRequestBody](../../models/components/v2apisdeleteapirequestbody.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.V2ApisDeleteApiResponseBody](../../models/components/v2apisdeleteapiresponsebody.md)\>**
+
+### Errors
+
+| Error Type                             | Status Code                            | Content Type                           |
+| -------------------------------------- | -------------------------------------- | -------------------------------------- |
+| errors.BadRequestErrorResponse         | 400                                    | application/json                       |
+| errors.UnauthorizedErrorResponse       | 401                                    | application/json                       |
+| errors.ForbiddenErrorResponse          | 403                                    | application/json                       |
+| errors.NotFoundErrorResponse           | 404                                    | application/json                       |
+| errors.PreconditionFailedErrorResponse | 412                                    | application/json                       |
+| errors.InternalServerErrorResponse     | 500                                    | application/json                       |
+| errors.APIError                        | 4XX, 5XX                               | \*/\*                                  |
+
+## getApi
+
+Retrieve basic information about an API namespace including its ID and name.
+
+Use this to verify an API exists before performing operations, get the human-readable name when you only have the API ID, or confirm access to a specific namespace. For detailed key information, use the `listKeys` endpoint instead.
+
+**Required Permissions**
+
+Your root key must have one of the following permissions:
+- `api.*.read_api` (to read any API)
+- `api.<api_id>.read_api` (to read a specific API)
+
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getApi" method="post" path="/v2/apis.getApi" -->
+```typescript
+import { Unkey } from "@unkey/api";
+
+const unkey = new Unkey({
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await unkey.apis.getApi({
+    apiId: "api_1234abcd",
   });
 
-  if (!res.ok) {
-    throw res.error;
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { UnkeyCore } from "@unkey/api/core.js";
+import { apisGetApi } from "@unkey/api/funcs/apisGetApi.js";
+
+// Use `UnkeyCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const unkey = new UnkeyCore({
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await apisGetApi(unkey, {
+    apiId: "api_1234abcd",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("apisGetApi failed:", res.error);
   }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V2ApisGetApiRequestBody](../../models/components/v2apisgetapirequestbody.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
 
-  const { value: result } = res;
+**Promise\<[components.V2ApisGetApiResponseBody](../../models/components/v2apisgetapiresponsebody.md)\>**
+
+### Errors
+
+| Error Type                         | Status Code                        | Content Type                       |
+| ---------------------------------- | ---------------------------------- | ---------------------------------- |
+| errors.BadRequestErrorResponse     | 400                                | application/json                   |
+| errors.UnauthorizedErrorResponse   | 401                                | application/json                   |
+| errors.ForbiddenErrorResponse      | 403                                | application/json                   |
+| errors.NotFoundErrorResponse       | 404                                | application/json                   |
+| errors.InternalServerErrorResponse | 500                                | application/json                   |
+| errors.APIError                    | 4XX, 5XX                           | \*/\*                              |
+
+## listKeys
+
+Retrieve a paginated list of API keys for dashboard and administrative interfaces.
+
+Use this to build key management dashboards, filter keys by user with `externalId`, or retrieve key details for administrative purposes. Each key includes status, metadata, permissions, and usage limits.
+
+**Important**: Set `decrypt: true` only in secure contexts to retrieve plaintext key values from recoverable keys.
+
+**Required Permissions**
+
+Your root key must have one of the following permissions for basic key listing:
+- `api.*.read_key` (to read keys from any API)
+- `api.<api_id>.read_key` (to read keys from a specific API)
+
+Additionally, you need read access to the API itself:
+- `api.*.read_api` or `api.<api_id>.read_api`
+
+Additional permission required for decrypt functionality:
+- `api.*.decrypt_key` or `api.<api_id>.decrypt_key`
+
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="listKeys" method="post" path="/v2/apis.listKeys" -->
+```typescript
+import { Unkey } from "@unkey/api";
+
+const unkey = new Unkey({
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await unkey.apis.listKeys({
+    apiId: "api_1234abcd",
+    cursor: "cursor_eyJsYXN0S2V5SWQiOiJrZXlfMjNld3MiLCJsYXN0Q3JlYXRlZEF0IjoxNjcyNTI0MjM0MDAwfQ==",
+    externalId: "user_1234abcd",
+  });
 
-  // Handle the result
   console.log(result);
 }
 
 run();
 ```
 
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { UnkeyCore } from "@unkey/api/core.js";
+import { apisListKeys } from "@unkey/api/funcs/apisListKeys.js";
+
+// Use `UnkeyCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const unkey = new UnkeyCore({
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await apisListKeys(unkey, {
+    apiId: "api_1234abcd",
+    cursor: "cursor_eyJsYXN0S2V5SWQiOiJrZXlfMjNld3MiLCJsYXN0Q3JlYXRlZEF0IjoxNjcyNTI0MjM0MDAwfQ==",
+    externalId: "user_1234abcd",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("apisListKeys failed:", res.error);
+  }
+}
+
+run();
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2ApisCreateApiRequestBody](../../models/components/v2apiscreateapirequestbody.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.V2ApisListKeysRequestBody](../../models/components/v2apislistkeysrequestbody.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.V2ApisCreateApiResponseBody](../../models/components/v2apiscreateapiresponsebody.md)\>**
+**Promise\<[components.V2ApisListKeysResponseBody](../../models/components/v2apislistkeysresponsebody.md)\>**
 
 ### Errors
 
@@ -82,5 +371,6 @@ run();
 | errors.BadRequestErrorResponse     | 400                                | application/json                   |
 | errors.UnauthorizedErrorResponse   | 401                                | application/json                   |
 | errors.ForbiddenErrorResponse      | 403                                | application/json                   |
+| errors.NotFoundErrorResponse       | 404                                | application/json                   |
 | errors.InternalServerErrorResponse | 500                                | application/json                   |
 | errors.APIError                    | 4XX, 5XX                           | \*/\*                              |