@openrouter/sdk 0.0.0-beta.9 → 0.0.1-beta.0

package/docs/sdks/chat/README.md

@@ -13,7 +13,7 @@ Sends a request for a model response for the given chat conversation. Supports b
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="post_/chat/completions" method="post" path="/chat/completions" -->
+<!-- UsageSnippet language="typescript" operationID="sendChatCompletionRequest" method="post" path="/chat/completions" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
@@ -22,7 +22,53 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.chat.send();
+  const result = await openRouter.chat.send({
+    messages: [],
+    model: "Charger",
+    frequencyPenalty: 8689.88,
+    logitBias: {
+      "key": 4876.54,
+      "key1": 7346.88,
+    },
+    logprobs: false,
+    topLogprobs: 2140.15,
+    maxCompletionTokens: 89.43,
+    maxTokens: 7392.4,
+    metadata: {
+      "key": "<value>",
+      "key1": "<value>",
+      "key2": "<value>",
+    },
+    presencePenalty: 9132.54,
+    reasoning: {
+      effort: "medium",
+      summary: null,
+    },
+    responseFormat: {
+      type: "grammar",
+      grammar: "<value>",
+    },
+    seed: null,
+    stop: [],
+    streamOptions: {
+      includeUsage: true,
+    },
+    toolChoice: "<value>",
+    tools: [
+      {
+        type: "function",
+        function: {
+          name: "<value>",
+          description: "pro even bank rewarding ha modulo aboard mentor",
+          parameters: {
+            "key": "<value>",
+          },
+          strict: null,
+        },
+      },
+    ],
+    user: "Francesco.Bartell",
+  });
 
   console.log(result);
 }
@@ -45,7 +91,53 @@ const openRouter = new OpenRouterCore({
 });
 
 async function run() {
-  const res = await chatSend(openRouter);
+  const res = await chatSend(openRouter, {
+    messages: [],
+    model: "Charger",
+    frequencyPenalty: 8689.88,
+    logitBias: {
+      "key": 4876.54,
+      "key1": 7346.88,
+    },
+    logprobs: false,
+    topLogprobs: 2140.15,
+    maxCompletionTokens: 89.43,
+    maxTokens: 7392.4,
+    metadata: {
+      "key": "<value>",
+      "key1": "<value>",
+      "key2": "<value>",
+    },
+    presencePenalty: 9132.54,
+    reasoning: {
+      effort: "medium",
+      summary: null,
+    },
+    responseFormat: {
+      type: "grammar",
+      grammar: "<value>",
+    },
+    seed: null,
+    stop: [],
+    streamOptions: {
+      includeUsage: true,
+    },
+    toolChoice: "<value>",
+    tools: [
+      {
+        type: "function",
+        function: {
+          name: "<value>",
+          description: "pro even bank rewarding ha modulo aboard mentor",
+          parameters: {
+            "key": "<value>",
+          },
+          strict: null,
+        },
+      },
+    ],
+    user: "Francesco.Bartell",
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -85,7 +177,7 @@ import {
 
 ### Response
 
-**Promise\<[operations.PostChatCompletionsResponse](../../models/operations/postchatcompletionsresponse.md)\>**
+**Promise\<[operations.SendChatCompletionRequestResponse](../../models/operations/sendchatcompletionrequestresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/completions/README.md

@@ -13,7 +13,7 @@ Creates a completion for the provided prompt and parameters. Supports both strea
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="post_/completions" method="post" path="/completions" -->
+<!-- UsageSnippet language="typescript" operationID="createCompletions" method="post" path="/completions" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
@@ -22,7 +22,42 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.completions.generate();
+  const result = await openRouter.completions.generate({
+    model: "Model T",
+    prompt: "<value>",
+    bestOf: 163488,
+    echo: true,
+    frequencyPenalty: 27.55,
+    logitBias: {
+      "key": 9064.25,
+      "key1": 7698.06,
+      "key2": 6481.8,
+    },
+    logprobs: 482258,
+    maxTokens: null,
+    n: 629532,
+    presencePenalty: 5430.28,
+    seed: 853393,
+    stop: [
+      "<value 1>",
+      "<value 2>",
+    ],
+    stream: true,
+    streamOptions: {
+      includeUsage: false,
+    },
+    suffix: "<value>",
+    temperature: null,
+    topP: 5229.98,
+    user: "Anita53",
+    metadata: {
+      "key": "<value>",
+      "key1": "<value>",
+    },
+    responseFormat: {
+      type: "text",
+    },
+  });
 
   console.log(result);
 }
@@ -45,7 +80,42 @@ const openRouter = new OpenRouterCore({
 });
 
 async function run() {
-  const res = await completionsGenerate(openRouter);
+  const res = await completionsGenerate(openRouter, {
+    model: "Model T",
+    prompt: "<value>",
+    bestOf: 163488,
+    echo: true,
+    frequencyPenalty: 27.55,
+    logitBias: {
+      "key": 9064.25,
+      "key1": 7698.06,
+      "key2": 6481.8,
+    },
+    logprobs: 482258,
+    maxTokens: null,
+    n: 629532,
+    presencePenalty: 5430.28,
+    seed: 853393,
+    stop: [
+      "<value 1>",
+      "<value 2>",
+    ],
+    stream: true,
+    streamOptions: {
+      includeUsage: false,
+    },
+    suffix: "<value>",
+    temperature: null,
+    topP: 5229.98,
+    user: "Anita53",
+    metadata: {
+      "key": "<value>",
+      "key1": "<value>",
+    },
+    responseFormat: {
+      type: "text",
+    },
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -85,12 +155,12 @@ import {
 
 ### Response
 
-**Promise\<[operations.PostCompletionsResponse](../../models/operations/postcompletionsresponse.md)\>**
+**Promise\<[models.CompletionResponse](../../models/completionresponse.md)\>**
 
 ### Errors
 
 | Error Type                    | Status Code                   | Content Type                  |
 | ----------------------------- | ----------------------------- | ----------------------------- |
-| errors.CompletionError        | 400, 401, 429                 | application/json              |
-| errors.CompletionError        | 500                           | application/json              |
+| errors.ChatError              | 400, 401, 429                 | application/json              |
+| errors.ChatError              | 500                           | application/json              |
 | errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |

package/docs/sdks/credits/README.md

@@ -3,10 +3,12 @@
 
 ## Overview
 
+Credit management endpoints
+
 ### Available Operations
 
-* [getCredits](#getcredits) - Get total credits purchased and used for the authenticated user
-* [postCreditsCoinbase](#postcreditscoinbase) - Create a Coinbase charge for crypto payment
+* [getCredits](#getcredits) - Get remaining credits
+* [createCoinbaseCharge](#createcoinbasecharge) - Create a Coinbase charge for crypto payment
 
 ## getCredits
 
@@ -14,7 +16,7 @@ Get total credits purchased and used for the authenticated user
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="get_/credits" method="get" path="/credits" -->
+<!-- UsageSnippet language="typescript" operationID="getCredits" method="get" path="/credits" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
@@ -101,24 +103,27 @@ import {
 
 | Error Type                    | Status Code                   | Content Type                  |
 | ----------------------------- | ----------------------------- | ----------------------------- |
-| errors.ErrorResponse          | 4XX                           | application/json              |
-| errors.OpenRouterDefaultError | 5XX                           | \*/\*                         |
+| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |
 
-## postCreditsCoinbase
+## createCoinbaseCharge
 
 Create a Coinbase charge for crypto payment
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="post_/credits/coinbase" method="post" path="/credits/coinbase" -->
+<!-- UsageSnippet language="typescript" operationID="createCoinbaseCharge" method="post" path="/credits/coinbase" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter();
 
 async function run() {
-  const result = await openRouter.credits.postCreditsCoinbase({
+  const result = await openRouter.credits.createCoinbaseCharge({
     bearer: process.env["OPENROUTER_BEARER"] ?? "",
+  }, {
+    amount: 711.16,
+    sender: "<value>",
+    chainId: 1,
   });
 
   console.log(result);
@@ -133,21 +138,25 @@ The standalone function version of this method:
 
 ```typescript
 import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { creditsPostCreditsCoinbase } from "@openrouter/sdk/funcs/creditsPostCreditsCoinbase.js";
+import { creditsCreateCoinbaseCharge } from "@openrouter/sdk/funcs/creditsCreateCoinbaseCharge.js";
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore();
 
 async function run() {
-  const res = await creditsPostCreditsCoinbase(openRouter, {
+  const res = await creditsCreateCoinbaseCharge(openRouter, {
     bearer: process.env["OPENROUTER_BEARER"] ?? "",
+  }, {
+    amount: 711.16,
+    sender: "<value>",
+    chainId: 1,
   });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("creditsPostCreditsCoinbase failed:", res.error);
+    console.log("creditsCreateCoinbaseCharge failed:", res.error);
   }
 }
 
@@ -167,27 +176,26 @@ associated utilities.
 ```tsx
 import {
   // Mutation hook for triggering the API call.
-  useCreditsPostCreditsCoinbaseMutation
-} from "@openrouter/sdk/react-query/creditsPostCreditsCoinbase.js";
+  useCreditsCreateCoinbaseChargeMutation
+} from "@openrouter/sdk/react-query/creditsCreateCoinbaseCharge.js";
 ```
 
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PostCreditsCoinbaseRequest](../../models/operations/postcreditscoinbaserequest.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `security`                                                                                                                                                                     | [operations.PostCreditsCoinbaseSecurity](../../models/operations/postcreditscoinbasesecurity.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The security requirements to use for the request.                                                                                                                              |
+| `request`                                                                                                                                                                      | [operations.CreateCoinbaseChargeRequest](../../models/operations/createcoinbasechargerequest.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.CreateCoinbaseChargeSecurity](../../models/operations/createcoinbasechargesecurity.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.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.PostCreditsCoinbaseResponse](../../models/operations/postcreditscoinbaseresponse.md)\>**
+**Promise\<[operations.CreateCoinbaseChargeResponse](../../models/operations/createcoinbasechargeresponse.md)\>**
 
 ### Errors
 
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 4XX                  | application/json     |
-| errors.ErrorResponse | 5XX                  | application/json     |
+| Error Type                    | Status Code                   | Content Type                  |
+| ----------------------------- | ----------------------------- | ----------------------------- |
+| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |

package/docs/sdks/endpoints/README.md

@@ -3,18 +3,20 @@
 
 ## Overview
 
+Endpoint information
+
 ### Available Operations
 
-* [getModelsAuthorSlugEndpoints](#getmodelsauthorslugendpoints) - List all endpoints for a model
-* [getEndpointsZdr](#getendpointszdr) - Preview the impact of ZDR on the available endpoints
+* [list](#list) - List all endpoints for a model
+* [listZdrEndpoints](#listzdrendpoints) - Preview the impact of ZDR on the available endpoints
 
-## getModelsAuthorSlugEndpoints
+## list
 
 List all endpoints for a model
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="get_/models/{author}/{slug}/endpoints" method="get" path="/models/{author}/{slug}/endpoints" -->
+<!-- UsageSnippet language="typescript" operationID="listEndpoints" method="get" path="/models/{author}/{slug}/endpoints" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
@@ -23,7 +25,7 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.endpoints.getModelsAuthorSlugEndpoints({
+  const result = await openRouter.endpoints.list({
     author: "<value>",
     slug: "<value>",
   });
@@ -40,7 +42,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { endpointsGetModelsAuthorSlugEndpoints } from "@openrouter/sdk/funcs/endpointsGetModelsAuthorSlugEndpoints.js";
+import { endpointsList } from "@openrouter/sdk/funcs/endpointsList.js";
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -49,7 +51,7 @@ const openRouter = new OpenRouterCore({
 });
 
 async function run() {
-  const res = await endpointsGetModelsAuthorSlugEndpoints(openRouter, {
+  const res = await endpointsList(openRouter, {
     author: "<value>",
     slug: "<value>",
   });
@@ -57,7 +59,7 @@ async function run() {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("endpointsGetModelsAuthorSlugEndpoints failed:", res.error);
+    console.log("endpointsList failed:", res.error);
   }
 }
 
@@ -77,48 +79,47 @@ associated utilities.
 ```tsx
 import {
   // Query hooks for fetching data.
-  useEndpointsGetModelsAuthorSlugEndpoints,
-  useEndpointsGetModelsAuthorSlugEndpointsSuspense,
+  useEndpointsList,
+  useEndpointsListSuspense,
 
   // Utility for prefetching data during server-side rendering and in React
   // Server Components that will be immediately available to client components
   // using the hooks.
-  prefetchEndpointsGetModelsAuthorSlugEndpoints,
+  prefetchEndpointsList,
   
   // Utilities to invalidate the query cache for this query in response to
   // mutations and other user actions.
-  invalidateEndpointsGetModelsAuthorSlugEndpoints,
-  invalidateAllEndpointsGetModelsAuthorSlugEndpoints,
-} from "@openrouter/sdk/react-query/endpointsGetModelsAuthorSlugEndpoints.js";
+  invalidateEndpointsList,
+  invalidateAllEndpointsList,
+} from "@openrouter/sdk/react-query/endpointsList.js";
 ```
 
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetModelsAuthorSlugEndpointsRequestRequest](../../models/operations/getmodelsauthorslugendpointsrequestrequest.md)                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.ListEndpointsRequest](../../models/operations/listendpointsrequest.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\<[operations.GetModelsAuthorSlugEndpointsResponse](../../models/operations/getmodelsauthorslugendpointsresponse.md)\>**
+**Promise\<[operations.ListEndpointsResponse](../../models/operations/listendpointsresponse.md)\>**
 
 ### Errors
 
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 4XX                  | application/json     |
-| errors.ErrorResponse | 5XX                  | application/json     |
+| Error Type                    | Status Code                   | Content Type                  |
+| ----------------------------- | ----------------------------- | ----------------------------- |
+| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |
 
-## getEndpointsZdr
+## listZdrEndpoints
 
 Preview the impact of ZDR on the available endpoints
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="get_/endpoints/zdr" method="get" path="/endpoints/zdr" -->
+<!-- UsageSnippet language="typescript" operationID="listEndpointsZdr" method="get" path="/endpoints/zdr" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
@@ -127,7 +128,7 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.endpoints.getEndpointsZdr();
+  const result = await openRouter.endpoints.listZdrEndpoints();
 
   console.log(result);
 }
@@ -141,7 +142,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { endpointsGetEndpointsZdr } from "@openrouter/sdk/funcs/endpointsGetEndpointsZdr.js";
+import { endpointsListZdrEndpoints } from "@openrouter/sdk/funcs/endpointsListZdrEndpoints.js";
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -150,12 +151,12 @@ const openRouter = new OpenRouterCore({
 });
 
 async function run() {
-  const res = await endpointsGetEndpointsZdr(openRouter);
+  const res = await endpointsListZdrEndpoints(openRouter);
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("endpointsGetEndpointsZdr failed:", res.error);
+    console.log("endpointsListZdrEndpoints failed:", res.error);
   }
 }
 
@@ -175,18 +176,18 @@ associated utilities.
 ```tsx
 import {
   // Query hooks for fetching data.
-  useEndpointsGetEndpointsZdr,
-  useEndpointsGetEndpointsZdrSuspense,
+  useEndpointsListZdrEndpoints,
+  useEndpointsListZdrEndpointsSuspense,
 
   // Utility for prefetching data during server-side rendering and in React
   // Server Components that will be immediately available to client components
   // using the hooks.
-  prefetchEndpointsGetEndpointsZdr,
+  prefetchEndpointsListZdrEndpoints,
   
   // Utility to invalidate the query cache for this query in response to
   // mutations and other user actions.
-  invalidateAllEndpointsGetEndpointsZdr,
-} from "@openrouter/sdk/react-query/endpointsGetEndpointsZdr.js";
+  invalidateAllEndpointsListZdrEndpoints,
+} from "@openrouter/sdk/react-query/endpointsListZdrEndpoints.js";
 ```
 
 ### Parameters
@@ -199,11 +200,10 @@ import {
 
 ### Response
 
-**Promise\<[operations.GetEndpointsZdrResponse](../../models/operations/getendpointszdrresponse.md)\>**
+**Promise\<[operations.ListEndpointsZdrResponse](../../models/operations/listendpointszdrresponse.md)\>**
 
 ### Errors
 
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 4XX                  | application/json     |
-| errors.ErrorResponse | 5XX                  | application/json     |
+| Error Type                    | Status Code                   | Content Type                  |
+| ----------------------------- | ----------------------------- | ----------------------------- |
+| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |

package/docs/sdks/generations/README.md

@@ -3,6 +3,8 @@
 
 ## Overview
 
+Generation history endpoints
+
 ### Available Operations
 
 * [getGeneration](#getgeneration) - Get request & usage metadata for a generation
@@ -13,7 +15,7 @@ Get request & usage metadata for a generation
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="get_/generation" method="get" path="/generation" -->
+<!-- UsageSnippet language="typescript" operationID="getGeneration" method="get" path="/generation" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
@@ -104,7 +106,6 @@ import {
 
 ### Errors
 
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 4XX                  | application/json     |
-| errors.ErrorResponse | 5XX                  | application/json     |
+| Error Type                    | Status Code                   | Content Type                  |
+| ----------------------------- | ----------------------------- | ----------------------------- |
+| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |