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

package/README.md

@@ -63,7 +63,8 @@ yarn add @tanstack/react-query react react-dom
 ```
 
 > [!NOTE]
-> This package is published with CommonJS and ES Modules (ESM) support.
+> This package is published as an ES Module (ESM) only. For applications using
+> CommonJS, use `await import("@openrouter/sdk")` to import and use this package.
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->
@@ -85,115 +86,7 @@ const openRouter = new OpenRouter({
 });
 
 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",
-  });
+  const result = await openRouter.beta.responses.send({});
 
   console.log(result);
 }
@@ -223,115 +116,7 @@ const openRouter = new OpenRouter({
 });
 
 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",
-  });
+  const result = await openRouter.beta.responses.send({});
 
   console.log(result);
 }
@@ -351,11 +136,7 @@ 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);
 }
@@ -412,9 +193,9 @@ run();
 
 ### [models](docs/sdks/models/README.md)
 
-* [listModelsCount](docs/sdks/models/README.md#listmodelscount) - Get total count of available models
-* [getModels](docs/sdks/models/README.md#getmodels) - List all models and their properties
-* [listModelsUser](docs/sdks/models/README.md#listmodelsuser) - List models filtered by user provider preferences
+* [count](docs/sdks/models/README.md#count) - Get total count of available models
+* [list](docs/sdks/models/README.md#list) - List all models and their properties
+* [listForUser](docs/sdks/models/README.md#listforuser) - List models filtered by user provider preferences
 
 ### [parameters](docs/sdks/parameters/README.md)
 
@@ -457,9 +238,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`endpointsList`](docs/sdks/endpoints/README.md#list) - List all endpoints for a model
 - [`endpointsListZdrEndpoints`](docs/sdks/endpoints/README.md#listzdrendpoints) - Preview the impact of ZDR on the available endpoints
 - [`generationsGetGeneration`](docs/sdks/generations/README.md#getgeneration) - Get request & usage metadata for a generation
-- [`modelsGetModels`](docs/sdks/models/README.md#getmodels) - List all models and their properties
-- [`modelsListModelsCount`](docs/sdks/models/README.md#listmodelscount) - Get total count of available models
-- [`modelsListModelsUser`](docs/sdks/models/README.md#listmodelsuser) - List models filtered by user provider preferences
+- [`modelsCount`](docs/sdks/models/README.md#count) - Get total count of available models
+- [`modelsList`](docs/sdks/models/README.md#list) - List all models and their properties
+- [`modelsListForUser`](docs/sdks/models/README.md#listforuser) - List models filtered by user provider preferences
 - [`parametersGetParameters`](docs/sdks/parameters/README.md#getparameters) - Get a model's supported parameters and data about which are most popular
 - [`providersList`](docs/sdks/providers/README.md#list) - List all providers
 
@@ -503,9 +284,9 @@ To learn about this feature and how to get started, check
 - [`useEndpointsList`](docs/sdks/endpoints/README.md#list) - List all endpoints for a model
 - [`useEndpointsListZdrEndpoints`](docs/sdks/endpoints/README.md#listzdrendpoints) - Preview the impact of ZDR on the available endpoints
 - [`useGenerationsGetGeneration`](docs/sdks/generations/README.md#getgeneration) - Get request & usage metadata for a generation
-- [`useModelsGetModels`](docs/sdks/models/README.md#getmodels) - List all models and their properties
-- [`useModelsListModelsCount`](docs/sdks/models/README.md#listmodelscount) - Get total count of available models
-- [`useModelsListModelsUser`](docs/sdks/models/README.md#listmodelsuser) - List models filtered by user provider preferences
+- [`useModelsCount`](docs/sdks/models/README.md#count) - Get total count of available models
+- [`useModelsList`](docs/sdks/models/README.md#list) - List all models and their properties
+- [`useModelsListForUser`](docs/sdks/models/README.md#listforuser) - List models filtered by user provider preferences
 - [`useParametersGetParameters`](docs/sdks/parameters/README.md#getparameters) - Get a model's supported parameters and data about which are most popular
 - [`useProvidersList`](docs/sdks/providers/README.md#list) - List all providers
 
@@ -529,115 +310,7 @@ const openRouter = new OpenRouter({
 });
 
 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",
-  });
+  const result = await openRouter.beta.responses.send({});
 
   console.log(result);
 }
@@ -664,115 +337,7 @@ const openRouter = new OpenRouter({
 });
 
 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",
-  }, {
+  const result = await openRouter.beta.responses.send({}, {
     retries: {
       strategy: "backoff",
       backoff: {
@@ -811,115 +376,7 @@ const openRouter = new OpenRouter({
 });
 
 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",
-  });
+  const result = await openRouter.beta.responses.send({});
 
   console.log(result);
 }
@@ -954,7 +411,9 @@ const openRouter = new OpenRouter({
 
 async function run() {
   try {
-    const result = await openRouter.providers.list();
+    const result = await openRouter.analytics.getUserActivity({
+      date: "2025-08-24",
+    });
 
     console.log(result);
   } catch (error) {
@@ -966,8 +425,9 @@ async function run() {
       console.log(error.headers);
 
       // Depending on the method different errors may be thrown
-      if (error instanceof errors.InternalServerError) {
-        console.log(error.data$.error); // operations.ErrorT
+      if (error instanceof errors.ErrorResponse) {
+        console.log(error.data$.error); // models.ErrorResponseError
+        console.log(error.data$.userId); // string
       }
     }
   }
@@ -981,7 +441,7 @@ run();
 **Primary error:**
 * [`OpenRouterError`](./src/models/errors/openroutererror.ts): The base class for HTTP error responses.
 
-<details><summary>Less common errors (8)</summary>
+<details><summary>Less common errors (9)</summary>
 
 <br />
 
@@ -994,6 +454,7 @@ run();
 
 
 **Inherit from [`OpenRouterError`](./src/models/errors/openroutererror.ts)**:
+* [`ErrorResponse`](./src/models/errors/errorresponse.ts): Error response. Applicable to 12 of 20 methods.*
 * [`ChatError`](./src/models/errors/chaterror.ts): Bad request - invalid parameters. Applicable to 2 of 20 methods.*
 * [`InternalServerError`](./src/models/errors/internalservererror.ts): Internal Server Error. Status code `500`. Applicable to 1 of 20 methods.*
 * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.

package/esm/funcs/analyticsGetUserActivity.d.ts

@@ -0,0 +1,18 @@
+import { OpenRouterCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { OpenRouterError } from "../models/errors/openroutererror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * Get user activity grouped by endpoint
+ *
+ * @remarks
+ * Returns user activity data grouped by endpoint for the last 30 (completed) UTC days
+ */
+export declare function analyticsGetUserActivity(client: OpenRouterCore, request?: operations.GetUserActivityRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.GetUserActivityResponse, errors.ErrorResponse | OpenRouterError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+//# sourceMappingURL=analyticsGetUserActivity.d.ts.map