@openrouter/sdk 0.0.1-beta.0 → 0.0.1-beta.10

package/docs/sdks/chat/README.md

@@ -1,188 +0,0 @@
-# Chat
-(*chat*)
-
-## Overview
-
-### Available Operations
-
-* [send](#send) - Create a chat completion
-
-## send
-
-Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="sendChatCompletionRequest" method="post" path="/chat/completions" -->
-```typescript
-import { OpenRouter } from "@openrouter/sdk";
-
-const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
-});
-
-async function run() {
-  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);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { chatSend } from "@openrouter/sdk/funcs/chatSend.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"] ?? "",
-});
-
-async function run() {
-  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);
-  } else {
-    console.log("chatSend failed:", res.error);
-  }
-}
-
-run();
-```
-
-### React hooks and utilities
-
-This method can be used in React components through the following hooks and
-associated utilities.
-
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-
-[hook-guide]: ../../../REACT_QUERY.md
-
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useChatSendMutation
-} from "@openrouter/sdk/react-query/chatSend.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [models.ChatGenerationParams](../../models/chatgenerationparams.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.SendChatCompletionRequestResponse](../../models/operations/sendchatcompletionrequestresponse.md)\>**
-
-### Errors
-
-| Error Type                    | Status Code                   | Content Type                  |
-| ----------------------------- | ----------------------------- | ----------------------------- |
-| errors.ChatError              | 400, 401, 429                 | application/json              |
-| errors.ChatError              | 500                           | application/json              |
-| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |

package/docs/sdks/completions/README.md

@@ -1,166 +0,0 @@
-# Completions
-(*completions*)
-
-## Overview
-
-### Available Operations
-
-* [generate](#generate) - Create a completion
-
-## generate
-
-Creates a completion for the provided prompt and parameters. Supports both streaming and non-streaming modes.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="createCompletions" method="post" path="/completions" -->
-```typescript
-import { OpenRouter } from "@openrouter/sdk";
-
-const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
-});
-
-async function run() {
-  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);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { completionsGenerate } from "@openrouter/sdk/funcs/completionsGenerate.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"] ?? "",
-});
-
-async function run() {
-  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);
-  } else {
-    console.log("completionsGenerate failed:", res.error);
-  }
-}
-
-run();
-```
-
-### React hooks and utilities
-
-This method can be used in React components through the following hooks and
-associated utilities.
-
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-
-[hook-guide]: ../../../REACT_QUERY.md
-
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useCompletionsGenerateMutation
-} from "@openrouter/sdk/react-query/completionsGenerate.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [models.CompletionCreateParams](../../models/completioncreateparams.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\<[models.CompletionResponse](../../models/completionresponse.md)\>**
-
-### Errors
-
-| Error Type                    | Status Code                   | Content Type                  |
-| ----------------------------- | ----------------------------- | ----------------------------- |
-| errors.ChatError              | 400, 401, 429                 | application/json              |
-| errors.ChatError              | 500                           | application/json              |
-| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |

package/docs/sdks/credits/README.md

@@ -1,201 +0,0 @@
-# Credits
-(*credits*)
-
-## Overview
-
-Credit management endpoints
-
-### Available Operations
-
-* [getCredits](#getcredits) - Get remaining credits
-* [createCoinbaseCharge](#createcoinbasecharge) - Create a Coinbase charge for crypto payment
-
-## getCredits
-
-Get total credits purchased and used for the authenticated user
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="getCredits" method="get" path="/credits" -->
-```typescript
-import { OpenRouter } from "@openrouter/sdk";
-
-const openRouter = new OpenRouter({
-  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await openRouter.credits.getCredits();
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { creditsGetCredits } from "@openrouter/sdk/funcs/creditsGetCredits.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"] ?? "",
-});
-
-async function run() {
-  const res = await creditsGetCredits(openRouter);
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("creditsGetCredits failed:", res.error);
-  }
-}
-
-run();
-```
-
-### React hooks and utilities
-
-This method can be used in React components through the following hooks and
-associated utilities.
-
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-
-[hook-guide]: ../../../REACT_QUERY.md
-
-```tsx
-import {
-  // Query hooks for fetching data.
-  useCreditsGetCredits,
-  useCreditsGetCreditsSuspense,
-
-  // Utility for prefetching data during server-side rendering and in React
-  // Server Components that will be immediately available to client components
-  // using the hooks.
-  prefetchCreditsGetCredits,
-  
-  // Utility to invalidate the query cache for this query in response to
-  // mutations and other user actions.
-  invalidateAllCreditsGetCredits,
-} from "@openrouter/sdk/react-query/creditsGetCredits.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `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.GetCreditsResponse](../../models/operations/getcreditsresponse.md)\>**
-
-### Errors
-
-| Error Type                    | Status Code                   | Content Type                  |
-| ----------------------------- | ----------------------------- | ----------------------------- |
-| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |
-
-## createCoinbaseCharge
-
-Create a Coinbase charge for crypto payment
-
-### Example Usage
-
-<!-- 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.createCoinbaseCharge({
-    bearer: process.env["OPENROUTER_BEARER"] ?? "",
-  }, {
-    amount: 711.16,
-    sender: "<value>",
-    chainId: 1,
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { OpenRouterCore } from "@openrouter/sdk/core.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 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("creditsCreateCoinbaseCharge failed:", res.error);
-  }
-}
-
-run();
-```
-
-### React hooks and utilities
-
-This method can be used in React components through the following hooks and
-associated utilities.
-
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-
-[hook-guide]: ../../../REACT_QUERY.md
-
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useCreditsCreateCoinbaseChargeMutation
-} from "@openrouter/sdk/react-query/creditsCreateCoinbaseCharge.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `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.CreateCoinbaseChargeResponse](../../models/operations/createcoinbasechargeresponse.md)\>**
-
-### Errors
-
-| Error Type                    | Status Code                   | Content Type                  |
-| ----------------------------- | ----------------------------- | ----------------------------- |
-| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |