@openrouter/sdk 0.0.0-beta.5 → 0.0.0-beta.7

package/docs/sdks/apikeys/README.md

@@ -24,7 +24,9 @@ List API keys
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -47,7 +49,9 @@ import { apiKeysGetKeys } from "@openrouter/sdk/funcs/apiKeysGetKeys.js";
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -121,7 +125,9 @@ Create a new API key
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -148,7 +154,9 @@ import { apiKeysPostKeys } from "@openrouter/sdk/funcs/apiKeysPostKeys.js";
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -215,7 +223,9 @@ Update an API key
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -246,7 +256,9 @@ import { apiKeysPatchKeysHash } from "@openrouter/sdk/funcs/apiKeysPatchKeysHash
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -317,7 +329,9 @@ Delete an API key
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -342,7 +356,9 @@ import { apiKeysDeleteKeysHash } from "@openrouter/sdk/funcs/apiKeysDeleteKeysHa
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -407,7 +423,9 @@ Get a single API key
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -432,7 +450,9 @@ import { apiKeysGetKeysHash } from "@openrouter/sdk/funcs/apiKeysGetKeysHash.js"
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -508,7 +528,9 @@ Get information on the API key associated with the current authentication sessio
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -531,7 +553,9 @@ import { apiKeysGetKey } from "@openrouter/sdk/funcs/apiKeysGetKey.js";
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -603,7 +627,9 @@ Get information on the API key associated with the current authentication sessio
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -626,7 +652,9 @@ import { apiKeysGetAuthKey } from "@openrouter/sdk/funcs/apiKeysGetAuthKey.js";
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {

package/docs/sdks/chat/README.md

@@ -5,11 +5,11 @@
 
 ### Available Operations
 
-* [send](#send) - Create a chat completion
+* [generateResponse](#generateresponse) - Create a chat completion
 
-## send
+## generateResponse
 
-Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes.
+Creates a model response for the given chat conversation. Supports both streaming and non-streaming modes.
 
 ### Example Usage
 
@@ -18,11 +18,13 @@ Sends a request for a model response for the given chat conversation. Supports b
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
-  const result = await openRouter.chat.send();
+  const result = await openRouter.chat.generateResponse();
 
   console.log(result);
 }
@@ -36,21 +38,23 @@ The standalone function version of this method:
 
 ```typescript
 import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { chatSend } from "@openrouter/sdk/funcs/chatSend.js";
+import { chatGenerateResponse } from "@openrouter/sdk/funcs/chatGenerateResponse.js";
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
-  const res = await chatSend(openRouter);
+  const res = await chatGenerateResponse(openRouter);
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("chatSend failed:", res.error);
+    console.log("chatGenerateResponse failed:", res.error);
   }
 }
 
@@ -70,8 +74,8 @@ associated utilities.
 ```tsx
 import {
   // Mutation hook for triggering the API call.
-  useChatSendMutation
-} from "@openrouter/sdk/react-query/chatSend.js";
+  useChatGenerateResponseMutation
+} from "@openrouter/sdk/react-query/chatGenerateResponse.js";
 ```
 
 ### Parameters
@@ -91,6 +95,6 @@ import {
 
 | Error Type                    | Status Code                   | Content Type                  |
 | ----------------------------- | ----------------------------- | ----------------------------- |
-| errors.ChatError              | 400, 401, 429                 | application/json              |
-| errors.ChatError              | 500                           | application/json              |
+| errors.ChatCompletionError    | 400, 401, 429                 | application/json              |
+| errors.ChatCompletionError    | 500                           | application/json              |
 | errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |

package/docs/sdks/embeddings/README.md

@@ -5,9 +5,9 @@
 
 ### Available Operations
 
-* [generate](#generate) - Submit an embedding request
+* [postEmbeddings](#postembeddings) - Submit an embedding request
 
-## generate
+## postEmbeddings
 
 Submits an embedding request to the embeddings router
 
@@ -18,11 +18,13 @@ Submits an embedding request to the embeddings router
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
-  const result = await openRouter.embeddings.generate({
+  const result = await openRouter.embeddings.postEmbeddings({
     input: [],
     provider: {
       zdr: true,
@@ -41,16 +43,18 @@ The standalone function version of this method:
 
 ```typescript
 import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { embeddingsGenerate } from "@openrouter/sdk/funcs/embeddingsGenerate.js";
+import { embeddingsPostEmbeddings } from "@openrouter/sdk/funcs/embeddingsPostEmbeddings.js";
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
-  const res = await embeddingsGenerate(openRouter, {
+  const res = await embeddingsPostEmbeddings(openRouter, {
     input: [],
     provider: {
       zdr: true,
@@ -60,7 +64,7 @@ async function run() {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("embeddingsGenerate failed:", res.error);
+    console.log("embeddingsPostEmbeddings failed:", res.error);
   }
 }
 
@@ -80,8 +84,8 @@ associated utilities.
 ```tsx
 import {
   // Mutation hook for triggering the API call.
-  useEmbeddingsGenerateMutation
-} from "@openrouter/sdk/react-query/embeddingsGenerate.js";
+  useEmbeddingsPostEmbeddingsMutation
+} from "@openrouter/sdk/react-query/embeddingsPostEmbeddings.js";
 ```
 
 ### Parameters

package/docs/sdks/endpoints/README.md

@@ -19,7 +19,9 @@ List all endpoints for a model
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -45,7 +47,9 @@ import { endpointsGetModelsAuthorSlugEndpoints } from "@openrouter/sdk/funcs/end
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -122,7 +126,9 @@ Preview the impact of ZDR on the available endpoints
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -145,7 +151,9 @@ import { endpointsGetEndpointsZdr } from "@openrouter/sdk/funcs/endpointsGetEndp
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {

package/docs/sdks/generations/README.md

@@ -18,7 +18,9 @@ Get request & usage metadata for a generation
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -43,7 +45,9 @@ import { generationsGetGeneration } from "@openrouter/sdk/funcs/generationsGetGe
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {

package/docs/sdks/models/README.md

@@ -20,7 +20,9 @@ Get total count of available models
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -43,7 +45,9 @@ import { modelsGetModelsCount } from "@openrouter/sdk/funcs/modelsGetModelsCount
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -115,7 +119,9 @@ List all models and their properties
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -138,7 +144,9 @@ import { modelsGetModels } from "@openrouter/sdk/funcs/modelsGetModels.js";
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
 });
 
 async function run() {
@@ -211,12 +219,14 @@ List models filtered by user provider preferences
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
-const openRouter = new OpenRouter();
+const openRouter = new OpenRouter({
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
+});
 
 async function run() {
-  const result = await openRouter.models.getModelsUser({
-    bearer: process.env["OPENROUTER_BEARER"] ?? "",
-  });
+  const result = await openRouter.models.getModelsUser();
 
   console.log(result);
 }
@@ -234,12 +244,14 @@ import { modelsGetModelsUser } from "@openrouter/sdk/funcs/modelsGetModelsUser.j
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const openRouter = new OpenRouterCore();
+const openRouter = new OpenRouterCore({
+  security: {
+    apiKeyAuth: process.env["OPENROUTER_API_KEY_AUTH"] ?? "",
+  },
+});
 
 async function run() {
-  const res = await modelsGetModelsUser(openRouter, {
-    bearer: process.env["OPENROUTER_BEARER"] ?? "",
-  });
+  const res = await modelsGetModelsUser(openRouter);
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -282,7 +294,6 @@ import {
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `security`                                                                                                                                                                     | [operations.GetModelsUserSecurity](../../models/operations/getmodelsusersecurity.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The security requirements 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.                                                                                                               |