@unkey/api 2.0.0-alpha.7 → 2.0.0

package/docs/sdks/ratelimit/README.md

@@ -3,34 +3,43 @@
 
 ## Overview
 
+Rate limiting operations
+
 ### Available Operations
 
-* [limit](#limit)
-* [setOverride](#setoverride)
-* [getOverride](#getoverride)
-* [listOverrides](#listoverrides)
-* [deleteOverride](#deleteoverride)
+* [deleteOverride](#deleteoverride) - Delete ratelimit override
+* [getOverride](#getoverride) - Get ratelimit override
+* [limit](#limit) - Apply rate limiting
+* [listOverrides](#listoverrides) - List ratelimit overrides
+* [setOverride](#setoverride) - Set ratelimit override
+
+## deleteOverride
+
+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`
 
-## limit
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ratelimit.deleteOverride" method="post" path="/v2/ratelimit.deleteOverride" -->
 ```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.ratelimit.limit({
-    namespace: "sms.sign_up",
-    duration: 711276,
-    identifier: "<value>",
-    limit: 581877,
+  const result = await unkey.ratelimit.deleteOverride({
+    namespace: "<value>",
+    identifier: "premium_user_123",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -43,30 +52,25 @@ The standalone function version of this method:
 
 ```typescript
 import { UnkeyCore } from "@unkey/api/core.js";
-import { ratelimitLimit } from "@unkey/api/funcs/ratelimitLimit.js";
+import { ratelimitDeleteOverride } from "@unkey/api/funcs/ratelimitDeleteOverride.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 ratelimitLimit(unkey, {
-    namespace: "sms.sign_up",
-    duration: 711276,
-    identifier: "<value>",
-    limit: 581877,
+  const res = await ratelimitDeleteOverride(unkey, {
+    namespace: "<value>",
+    identifier: "premium_user_123",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ratelimitDeleteOverride failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -76,14 +80,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2RatelimitLimitRequestBody](../../models/components/v2ratelimitlimitrequestbody.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.V2RatelimitDeleteOverrideRequestBody](../../models/components/v2ratelimitdeleteoverriderequestbody.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.V2RatelimitLimitResponseBody](../../models/components/v2ratelimitlimitresponsebody.md)\>**
+**Promise\<[components.V2RatelimitDeleteOverrideResponseBody](../../models/components/v2ratelimitdeleteoverrideresponsebody.md)\>**
 
 ### Errors
 
@@ -96,25 +100,33 @@ run();
 | errors.InternalServerErrorResponse | 500                                | application/json                   |
 | errors.APIError                    | 4XX, 5XX                           | \*/\*                              |
 
-## setOverride
+## getOverride
+
+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`
+
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ratelimit.getOverride" method="post" path="/v2/ratelimit.getOverride" -->
 ```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.ratelimit.setOverride({
-    duration: 629394,
-    identifier: "<value>",
-    limit: 925291,
+  const result = await unkey.ratelimit.getOverride({
+    namespace: "<value>",
+    identifier: "premium_user_123",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -127,29 +139,25 @@ The standalone function version of this method:
 
 ```typescript
 import { UnkeyCore } from "@unkey/api/core.js";
-import { ratelimitSetOverride } from "@unkey/api/funcs/ratelimitSetOverride.js";
+import { ratelimitGetOverride } from "@unkey/api/funcs/ratelimitGetOverride.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 ratelimitSetOverride(unkey, {
-    duration: 629394,
-    identifier: "<value>",
-    limit: 925291,
+  const res = await ratelimitGetOverride(unkey, {
+    namespace: "<value>",
+    identifier: "premium_user_123",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ratelimitGetOverride failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -159,14 +167,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2RatelimitSetOverrideRequestBody](../../models/components/v2ratelimitsetoverriderequestbody.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.V2RatelimitGetOverrideRequestBody](../../models/components/v2ratelimitgetoverriderequestbody.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.V2RatelimitSetOverrideResponseBody](../../models/components/v2ratelimitsetoverrideresponsebody.md)\>**
+**Promise\<[components.V2RatelimitGetOverrideResponseBody](../../models/components/v2ratelimitgetoverrideresponsebody.md)\>**
 
 ### Errors
 
@@ -179,23 +187,44 @@ run();
 | errors.InternalServerErrorResponse | 500                                | application/json                   |
 | errors.APIError                    | 4XX, 5XX                           | \*/\*                              |
 
-## getOverride
+## limit
+
+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.
+
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ratelimit.limit" method="post" path="/v2/ratelimit.limit" -->
 ```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.ratelimit.getOverride({
-    identifier: "<value>",
+  const result = await unkey.ratelimit.limit({
+    namespace: "api.requests",
+    cost: 5,
+    duration: 60000,
+    identifier: "user_abc123",
+    limit: 100,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -208,27 +237,28 @@ The standalone function version of this method:
 
 ```typescript
 import { UnkeyCore } from "@unkey/api/core.js";
-import { ratelimitGetOverride } from "@unkey/api/funcs/ratelimitGetOverride.js";
+import { ratelimitLimit } from "@unkey/api/funcs/ratelimitLimit.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 ratelimitGetOverride(unkey, {
-    identifier: "<value>",
+  const res = await ratelimitLimit(unkey, {
+    namespace: "api.requests",
+    cost: 5,
+    duration: 60000,
+    identifier: "user_abc123",
+    limit: 100,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ratelimitLimit failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -238,14 +268,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2RatelimitGetOverrideRequestBody](../../models/components/v2ratelimitgetoverriderequestbody.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.V2RatelimitLimitRequestBody](../../models/components/v2ratelimitlimitrequestbody.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.V2RatelimitGetOverrideResponseBody](../../models/components/v2ratelimitgetoverrideresponsebody.md)\>**
+**Promise\<[components.V2RatelimitLimitResponseBody](../../models/components/v2ratelimitlimitresponsebody.md)\>**
 
 ### Errors
 
@@ -260,19 +290,31 @@ run();
 
 ## listOverrides
 
+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`
+
+
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ratelimit.listOverrides" method="post" path="/v2/ratelimit.listOverrides" -->
 ```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.ratelimit.listOverrides({});
+  const result = await unkey.ratelimit.listOverrides({
+    namespace: "<value>",
+    limit: 20,
+  });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -290,20 +332,20 @@ import { ratelimitListOverrides } from "@unkey/api/funcs/ratelimitListOverrides.
 // 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 ratelimitListOverrides(unkey, {});
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await ratelimitListOverrides(unkey, {
+    namespace: "<value>",
+    limit: 20,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ratelimitListOverrides failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -333,23 +375,35 @@ run();
 | errors.InternalServerErrorResponse | 500                                | application/json                   |
 | errors.APIError                    | 4XX, 5XX                           | \*/\*                              |
 
-## deleteOverride
+## setOverride
+
+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`
+
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ratelimit.setOverride" method="post" path="/v2/ratelimit.setOverride" -->
 ```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.ratelimit.deleteOverride({
-    identifier: "<value>",
+  const result = await unkey.ratelimit.setOverride({
+    namespace: "<value>",
+    duration: 60000,
+    identifier: "premium_user_123",
+    limit: 1000,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -362,27 +416,27 @@ The standalone function version of this method:
 
 ```typescript
 import { UnkeyCore } from "@unkey/api/core.js";
-import { ratelimitDeleteOverride } from "@unkey/api/funcs/ratelimitDeleteOverride.js";
+import { ratelimitSetOverride } from "@unkey/api/funcs/ratelimitSetOverride.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 ratelimitDeleteOverride(unkey, {
-    identifier: "<value>",
+  const res = await ratelimitSetOverride(unkey, {
+    namespace: "<value>",
+    duration: 60000,
+    identifier: "premium_user_123",
+    limit: 1000,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ratelimitSetOverride failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -392,14 +446,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2RatelimitDeleteOverrideRequestBody](../../models/components/v2ratelimitdeleteoverriderequestbody.md)                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.V2RatelimitSetOverrideRequestBody](../../models/components/v2ratelimitsetoverriderequestbody.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.V2RatelimitDeleteOverrideResponseBody](../../models/components/v2ratelimitdeleteoverrideresponsebody.md)\>**
+**Promise\<[components.V2RatelimitSetOverrideResponseBody](../../models/components/v2ratelimitsetoverrideresponsebody.md)\>**
 
 ### Errors
 

package/docs/sdks/unkey/README.md

@@ -2,4 +2,81 @@
 
 ## Overview
 
+Unkey API: Unkey's API provides programmatic access for all resources within our platform.
+
+
+### Authentication
+#
+This API uses HTTP Bearer authentication with root keys. Most endpoints require specific permissions associated with your root key. When making requests, include your root key in the `Authorization` header:
+```
+Authorization: Bearer unkey_xxxxxxxxxxx
+```
+
+All responses follow a consistent envelope structure that separates operational metadata from actual data. This design provides several benefits:
+- Debugging: Every response includes a unique requestId for tracing issues
+- Consistency: Predictable response format across all endpoints
+- Extensibility: Easy to add new metadata without breaking existing integrations
+- Error Handling: Unified error format with actionable information
+
+### Success Response Format:
+```json
+{
+  "meta": {
+    "requestId": "req_123456"
+  },
+  "data": {
+    // Actual response data here
+  }
+}
+```
+
+The meta object contains operational information:
+- `requestId`: Unique identifier for this request (essential for support)
+
+The data object contains the actual response data specific to each endpoint.
+
+### Paginated Response Format:
+```json
+{
+  "meta": {
+    "requestId": "req_123456"
+  },
+  "data": [
+    // Array of results
+  ],
+  "pagination": {
+    "cursor": "next_page_token",
+    "hasMore": true
+  }
+}
+```
+
+The pagination object appears on list endpoints and contains:
+- `cursor`: Token for requesting the next page
+- `hasMore`: Whether more results are available
+
+### Error Response Format:
+```json
+{
+  "meta": {
+    "requestId": "req_2c9a0jf23l4k567"
+  },
+  "error": {
+    "detail": "The resource you are attempting to modify is protected and cannot be changed",
+    "status": 403,
+    "title": "Forbidden",
+    "type": "https://unkey.com/docs/errors/unkey/application/protected_resource"
+  }
+}
+```
+
+Error responses include comprehensive diagnostic information:
+- `title`: Human-readable error summary
+- `detail`: Specific description of what went wrong
+- `status`: HTTP status code
+- `type`: Link to error documentation
+- `errors`: Array of validation errors (for 400 responses)
+
+This structure ensures you always have the context needed to debug issues and take corrective action.
+
 ### Available Operations

package/examples/README.md

@@ -0,0 +1,31 @@
+# @unkey/api Examples
+
+This directory contains example scripts demonstrating how to use the @unkey/api SDK.
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
+
+## Setup
+
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
+
+2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
+
+## Running the Examples
+
+To run an example file from the examples directory:
+
+```bash
+npm run build && npx tsx example.ts
+```
+
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
+
+

package/examples/apisCreateApi.example.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import dotenv from "dotenv";
+dotenv.config();
+/**
+ * Example usage of the @unkey/api SDK
+ *
+ * To run this example from the examples directory:
+ * npm run build && npx tsx apisCreateApi.ts
+ */
+
+import { Unkey } from "@unkey/api";
+
+const unkey = new Unkey({
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
+});
+
+async function main() {
+  const result = await unkey.createApi({
+    name: "payment-service-production",
+  });
+
+  console.log(result);
+}
+
+main().catch(console.error);