@openrouter/sdk 0.0.0-beta.4 → 0.0.0-beta.41

package/docs/sdks/providers/README.md

@@ -0,0 +1,106 @@
+# Providers
+(*providers*)
+
+## Overview
+
+Provider information endpoints
+
+### Available Operations
+
+* [list](#list) - List all providers
+
+## list
+
+List all providers
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="listProviders" method="get" path="/providers" -->
+```typescript
+import { OpenRouter } from "@openrouter/sdk";
+
+const openRouter = new OpenRouter({
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await openRouter.providers.list();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OpenRouterCore } from "@openrouter/sdk/core.js";
+import { providersList } from "@openrouter/sdk/funcs/providersList.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 providersList(openRouter);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("providersList 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.
+  useProvidersList,
+  useProvidersListSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchProvidersList,
+  
+  // Utility to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateAllProvidersList,
+} from "@openrouter/sdk/react-query/providersList.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.ListProvidersResponse](../../models/operations/listprovidersresponse.md)\>**
+
+### Errors
+
+| Error Type                    | Status Code                   | Content Type                  |
+| ----------------------------- | ----------------------------- | ----------------------------- |
+| errors.InternalServerError    | 500                           | application/json              |
+| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |

package/docs/sdks/responses/README.md

@@ -0,0 +1,312 @@
+# Responses
+(*beta.responses*)
+
+## Overview
+
+beta.responses endpoints
+
+### Available Operations
+
+* [send](#send) - Create a response
+
+## send
+
+Creates a streaming or non-streaming response using OpenResponses API format
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="createApiAlphaResponses" method="post" path="/api/alpha/responses" -->
+```typescript
+import { OpenRouter } from "@openrouter/sdk";
+
+const openRouter = new OpenRouter({
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await openRouter.beta.responses.send({
+    input: [
+      {
+        type: "message",
+        role: "user",
+        content: "Hello, how are you?",
+      },
+    ],
+    instructions: "<value>",
+    metadata: {
+      "user_id": "123",
+      "session_id": "abc-def-ghi",
+    },
+    tools: [
+      {
+        type: "function",
+        name: "get_current_weather",
+        description: "Get the current weather in a given location",
+        strict: true,
+        parameters: {
+          "type": "object",
+          "properties": {
+            "location": {
+              "type": "string",
+            },
+          },
+        },
+      },
+    ],
+    toolChoice: "auto",
+    parallelToolCalls: false,
+    model: "anthropic/claude-4.5-sonnet-20250929",
+    models: [
+      "<value 1>",
+    ],
+    text: {
+      format: {
+        type: "text",
+      },
+      verbosity: "medium",
+    },
+    reasoning: {
+      effort: "medium",
+      summary: "auto",
+      maxTokens: 6415.05,
+      enabled: true,
+    },
+    maxOutputTokens: 5270.85,
+    temperature: 0.7,
+    topP: 0.9,
+    topK: 5913.88,
+    promptCacheKey: "<value>",
+    previousResponseId: "<id>",
+    prompt: {
+      id: "prompt-abc123",
+      variables: {
+        "name": {
+          type: "input_text",
+          text: "John",
+        },
+      },
+    },
+    include: [
+      "message.input_image.image_url",
+    ],
+    background: false,
+    safetyIdentifier: "<value>",
+    store: false,
+    serviceTier: "auto",
+    truncation: "auto",
+    stream: false,
+    provider: {
+      allowFallbacks: false,
+      requireParameters: true,
+      dataCollection: "deny",
+      zdr: true,
+      order: [
+        "Moonshot AI",
+      ],
+      only: [
+        "<value>",
+      ],
+      ignore: [
+        "<value>",
+      ],
+      quantizations: [
+        "bf16",
+      ],
+      sort: "price",
+      maxPrice: {
+        prompt: "<value>",
+        completion: 4351.98,
+        image: "https://loremflickr.com/916/1698?lock=7420998995259402",
+        audio: "<value>",
+        request: "<value>",
+      },
+      experimental: {},
+    },
+    plugins: [
+      {
+        id: "file-parser",
+        maxFiles: 3555.38,
+        pdf: {
+          engine: "pdf-text",
+        },
+      },
+    ],
+    user: "Parker.OKeefe",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OpenRouterCore } from "@openrouter/sdk/core.js";
+import { betaResponsesSend } from "@openrouter/sdk/funcs/betaResponsesSend.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 betaResponsesSend(openRouter, {
+    input: [
+      {
+        type: "message",
+        role: "user",
+        content: "Hello, how are you?",
+      },
+    ],
+    instructions: "<value>",
+    metadata: {
+      "user_id": "123",
+      "session_id": "abc-def-ghi",
+    },
+    tools: [
+      {
+        type: "function",
+        name: "get_current_weather",
+        description: "Get the current weather in a given location",
+        strict: true,
+        parameters: {
+          "type": "object",
+          "properties": {
+            "location": {
+              "type": "string",
+            },
+          },
+        },
+      },
+    ],
+    toolChoice: "auto",
+    parallelToolCalls: false,
+    model: "anthropic/claude-4.5-sonnet-20250929",
+    models: [
+      "<value 1>",
+    ],
+    text: {
+      format: {
+        type: "text",
+      },
+      verbosity: "medium",
+    },
+    reasoning: {
+      effort: "medium",
+      summary: "auto",
+      maxTokens: 6415.05,
+      enabled: true,
+    },
+    maxOutputTokens: 5270.85,
+    temperature: 0.7,
+    topP: 0.9,
+    topK: 5913.88,
+    promptCacheKey: "<value>",
+    previousResponseId: "<id>",
+    prompt: {
+      id: "prompt-abc123",
+      variables: {
+        "name": {
+          type: "input_text",
+          text: "John",
+        },
+      },
+    },
+    include: [
+      "message.input_image.image_url",
+    ],
+    background: false,
+    safetyIdentifier: "<value>",
+    store: false,
+    serviceTier: "auto",
+    truncation: "auto",
+    stream: false,
+    provider: {
+      allowFallbacks: false,
+      requireParameters: true,
+      dataCollection: "deny",
+      zdr: true,
+      order: [
+        "Moonshot AI",
+      ],
+      only: [
+        "<value>",
+      ],
+      ignore: [
+        "<value>",
+      ],
+      quantizations: [
+        "bf16",
+      ],
+      sort: "price",
+      maxPrice: {
+        prompt: "<value>",
+        completion: 4351.98,
+        image: "https://loremflickr.com/916/1698?lock=7420998995259402",
+        audio: "<value>",
+        request: "<value>",
+      },
+      experimental: {},
+    },
+    plugins: [
+      {
+        id: "file-parser",
+        maxFiles: 3555.38,
+        pdf: {
+          engine: "pdf-text",
+        },
+      },
+    ],
+    user: "Parker.OKeefe",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("betaResponsesSend 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.
+  useBetaResponsesSendMutation
+} from "@openrouter/sdk/react-query/betaResponsesSend.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.OpenResponsesRequest](../../models/openresponsesrequest.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.CreateApiAlphaResponsesResponse](../../models/operations/createapialpharesponsesresponse.md)\>**
+
+### Errors
+
+| Error Type                    | Status Code                   | Content Type                  |
+| ----------------------------- | ----------------------------- | ----------------------------- |
+| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |

package/examples/betaResponsesSend.example.ts

@@ -0,0 +1,134 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import dotenv from "dotenv";
+dotenv.config();
+/**
+ * Example usage of the @openrouter/sdk SDK
+ *
+ * To run this example from the examples directory:
+ * npm run build && npx tsx betaResponsesSend.example.ts
+ */
+
+import { OpenRouter } from "@openrouter/sdk";
+
+const openRouter = new OpenRouter({
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+});
+
+async function main() {
+  const result = await openRouter.beta.responses.send({
+    input: [
+      {
+        type: "message",
+        role: "user",
+        content: "Hello, how are you?",
+      },
+    ],
+    instructions: "<value>",
+    metadata: {
+      "user_id": "123",
+      "session_id": "abc-def-ghi",
+    },
+    tools: [
+      {
+        type: "function",
+        name: "get_current_weather",
+        description: "Get the current weather in a given location",
+        strict: true,
+        parameters: {
+          "type": "object",
+          "properties": {
+            "location": {
+              "type": "string",
+            },
+          },
+        },
+      },
+    ],
+    toolChoice: "auto",
+    parallelToolCalls: false,
+    model: "anthropic/claude-4.5-sonnet-20250929",
+    models: [
+      "<value 1>",
+    ],
+    text: {
+      format: {
+        type: "text",
+      },
+      verbosity: "medium",
+    },
+    reasoning: {
+      effort: "medium",
+      summary: "auto",
+      maxTokens: 6415.05,
+      enabled: true,
+    },
+    maxOutputTokens: 5270.85,
+    temperature: 0.7,
+    topP: 0.9,
+    topK: 5913.88,
+    promptCacheKey: "<value>",
+    previousResponseId: "<id>",
+    prompt: {
+      id: "prompt-abc123",
+      variables: {
+        "name": {
+          type: "input_text",
+          text: "John",
+        },
+      },
+    },
+    include: [
+      "message.input_image.image_url",
+    ],
+    background: false,
+    safetyIdentifier: "<value>",
+    store: false,
+    serviceTier: "auto",
+    truncation: "auto",
+    stream: false,
+    provider: {
+      allowFallbacks: false,
+      requireParameters: true,
+      dataCollection: "deny",
+      zdr: true,
+      order: [
+        "Moonshot AI",
+      ],
+      only: [
+        "<value>",
+      ],
+      ignore: [
+        "<value>",
+      ],
+      quantizations: [
+        "bf16",
+      ],
+      sort: "price",
+      maxPrice: {
+        prompt: "<value>",
+        completion: 4351.98,
+        image: "https://loremflickr.com/916/1698?lock=7420998995259402",
+        audio: "<value>",
+        request: "<value>",
+      },
+      experimental: {},
+    },
+    plugins: [
+      {
+        id: "file-parser",
+        maxFiles: 3555.38,
+        pdf: {
+          engine: "pdf-text",
+        },
+      },
+    ],
+    user: "Parker.OKeefe",
+  });
+
+  console.log(result);
+}
+
+main().catch(console.error);

package/examples/chatCompletions.example.ts

@@ -12,8 +12,7 @@ dotenv.config();
  */
 
 import { OpenRouter } from "@openrouter/sdk";
-import type { EventStream } from "@openrouter/sdk/lib/event-streams.js";
-import type { ChatStreamingResponseChunk } from "@openrouter/sdk/models/index.js";
+
 
 if (!process.env["OPENROUTER_API_KEY"]) {
   throw new Error("Missing OPENROUTER_API_KEY environment variable");
@@ -62,8 +61,7 @@ async function streamingExample() {
   });
 
   if (result && typeof result === "object" && Symbol.asyncIterator in result) {
-    const stream = result as EventStream<ChatStreamingResponseChunk>;
-
+    const stream = result
     console.log("Streaming response:");
     let fullContent = "";
 

package/examples/nextjs-example/README.md

@@ -0,0 +1,118 @@
+# OpenRouter SDK Next.js Demo
+
+This is a demonstration application that shows how to create a chat interface
+using the [OpenRouter SDK](https://github.com/openrouterteam/typescript-sdk). The
+app implements OAuth 2.0 authentication flow and provides a complete chat
+experience with multiple AI models.
+
+> **⚠️ Security Notice**: This demo application stores API keys in localStorage
+> for demonstration purposes only. **Do not use this approach in production
+> applications**.
+
+## Features
+
+- **OAuth 2.0 Integration**: Secure authentication flow with OpenRouter
+- **Multi-Model Chat**: Access to various AI models (GPT-4, Claude, Gemini, etc.)
+- **Real-time Streaming**: Live response streaming for better user experience
+- **Modern UI**: Clean interface built with Tailwind CSS and shadcn/ui components
+- **TypeScript**: Full type safety with the OpenRouter SDK
+
+## Prerequisites
+
+- Node.js 18 or later
+- An [OpenRouter account](https://openrouter.ai)
+- OpenRouter application configured with OAuth callback
+
+## Installation
+
+1. Clone the repository and navigate to the example directory:
+```bash
+git clone <repository-url>
+cd typescript-sdk/examples/nextjs-example
+```
+
+2. Install dependencies:
+```bash
+npm install
+```
+
+3. Start the development server:
+```bash
+npm run dev
+```
+
+4. Open [http://localhost:3000](http://localhost:3000) in your browser
+
+## Configuration
+
+### OAuth Setup
+
+The application is pre-configured to use `http://localhost:3000/` as the OAuth
+callback URL. If you need to change this:
+
+1. Update the `OAUTH_CALLBACK_URL` in `src/lib/config.ts`
+2. Configure your OpenRouter application with the matching callback URL
+
+### Environment Variables
+
+No environment variables are required for this demo, as it uses client-side
+OAuth flow.
+
+## Usage
+
+1. **Connect Your Account**: Click "Connect OpenRouter Account" to authenticate
+   via OAuth
+2. **Start Chatting**: Once connected, navigate to the chat interface
+3. **Select Models**: Choose from available AI models using the dropdown menu
+4. **Send Messages**: Type your message and press Enter to send
+
+## Project Structure
+
+```
+src/
+├── app/
+│   ├── page.tsx              # Home page with OAuth flow
+│   ├── chat/page.tsx         # Chat interface
+│   └── oauth/callback/       # OAuth callback handler
+├── components/ui/            # Reusable UI components
+├── lib/
+│   ├── config.ts            # OAuth and app configuration
+│   └── hooks/               # Custom React hooks
+└── ...
+```
+
+## Key Implementation Details
+
+### OAuth Flow
+
+- Uses OpenRouter's OAuth 2.0 implementation
+- Handles authorization codes and token exchange
+- Stores credentials in localStorage (demo only)
+
+### Chat Integration
+
+- Implements streaming responses using the OpenRouter SDK
+- Supports multiple AI models through a single interface
+- Real-time message updates with proper state management
+
+### SDK Usage
+
+```typescript
+import { OpenRouterCore } from "@openrouter/sdk/core";
+import { chatSend } from "@openrouter/sdk/funcs/chatSend";
+
+const openRouter = new OpenRouterCore({ apiKey });
+const result = await chatSend(openRouter, {
+  model: "openai/gpt-4o",
+  messages: conversationHistory,
+  stream: true
+});
+```
+
+## Development Commands
+
+- `npm run dev` - Start development server
+- `npm run build` - Build for production
+- `npm run start` - Start production server
+- `npm run lint` - Run ESLint
+