@openrouter/sdk 0.0.1-beta.2 → 0.0.1-beta.5

package/docs/sdks/parameters/README.md

@@ -1,117 +0,0 @@
-# ParametersT
-(*parameters*)
-
-## Overview
-
-Parameters endpoints
-
-### Available Operations
-
-* [getParameters](#getparameters) - Get a model's supported parameters and data about which are most popular
-
-## getParameters
-
-Get a model's supported parameters and data about which are most popular
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="getParameters" method="get" path="/parameters/{author}/{slug}" -->
-```typescript
-import { OpenRouter } from "@openrouter/sdk";
-
-const openRouter = new OpenRouter();
-
-async function run() {
-  const result = await openRouter.parameters.getParameters({
-    bearer: process.env["OPENROUTER_BEARER"] ?? "",
-  }, {
-    author: "<value>",
-    slug: "<value>",
-    provider: "Google AI Studio",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { parametersGetParameters } from "@openrouter/sdk/funcs/parametersGetParameters.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 parametersGetParameters(openRouter, {
-    bearer: process.env["OPENROUTER_BEARER"] ?? "",
-  }, {
-    author: "<value>",
-    slug: "<value>",
-    provider: "Google AI Studio",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("parametersGetParameters 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.
-  useParametersGetParameters,
-  useParametersGetParametersSuspense,
-
-  // Utility for prefetching data during server-side rendering and in React
-  // Server Components that will be immediately available to client components
-  // using the hooks.
-  prefetchParametersGetParameters,
-  
-  // Utilities to invalidate the query cache for this query in response to
-  // mutations and other user actions.
-  invalidateParametersGetParameters,
-  invalidateAllParametersGetParameters,
-} from "@openrouter/sdk/react-query/parametersGetParameters.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetParametersRequest](../../models/operations/getparametersrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `security`                                                                                                                                                                     | [operations.GetParametersSecurity](../../models/operations/getparameterssecurity.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.GetParametersResponse](../../models/operations/getparametersresponse.md)\>**
-
-### Errors
-
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 4XX                  | application/json     |
-| errors.ErrorResponse | 5XX                  | application/json     |

package/docs/sdks/providers/README.md

@@ -1,106 +0,0 @@
-# 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

@@ -1,312 +0,0 @@
-# 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

@@ -1,134 +0,0 @@
-/*
- * 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);