@openrouter/sdk 0.0.1-beta.11 → 0.0.1-beta.14

package/README.md

@@ -86,7 +86,115 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.beta.responses.send({});
+  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: {
+      type: "function",
+      name: "<value>",
+    },
+    parallelToolCalls: true,
+    model: "anthropic/claude-4.5-sonnet-20250929",
+    models: [
+      "<value 1>",
+    ],
+    text: {
+      format: {
+        type: "text",
+      },
+      verbosity: "medium",
+    },
+    reasoning: {
+      effort: "high",
+      summary: "auto",
+      maxTokens: 8661.16,
+      enabled: true,
+    },
+    maxOutputTokens: null,
+    temperature: 0.7,
+    topP: 0.9,
+    topK: 193.77,
+    promptCacheKey: "<value>",
+    previousResponseId: "<id>",
+    prompt: {
+      id: "<id>",
+      variables: {
+        "key": {
+          type: "input_text",
+          text: "Hello, how can I help you?",
+        },
+      },
+    },
+    include: [
+      "reasoning.encrypted_content",
+    ],
+    background: true,
+    safetyIdentifier: "<value>",
+    store: true,
+    serviceTier: "auto",
+    truncation: "auto",
+    provider: {
+      allowFallbacks: null,
+      requireParameters: true,
+      dataCollection: "deny",
+      zdr: true,
+      order: [
+        "OpenAI",
+      ],
+      only: [
+        "OpenAI",
+      ],
+      ignore: null,
+      quantizations: [
+        "fp16",
+      ],
+      sort: "price",
+      maxPrice: {
+        prompt: "1000",
+        completion: 1000,
+        image: 1000,
+        audio: "1000",
+        request: 1000,
+      },
+      experimental: {},
+    },
+    plugins: [
+      {
+        id: "file-parser",
+        maxFiles: 4870.55,
+        pdf: {
+          engine: "mistral-ocr",
+        },
+      },
+    ],
+    user: "Elmer_Yundt72",
+  });
 
   console.log(result);
 }
@@ -116,7 +224,115 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.beta.responses.send({});
+  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: {
+      type: "function",
+      name: "<value>",
+    },
+    parallelToolCalls: true,
+    model: "anthropic/claude-4.5-sonnet-20250929",
+    models: [
+      "<value 1>",
+    ],
+    text: {
+      format: {
+        type: "text",
+      },
+      verbosity: "medium",
+    },
+    reasoning: {
+      effort: "high",
+      summary: "auto",
+      maxTokens: 8661.16,
+      enabled: true,
+    },
+    maxOutputTokens: null,
+    temperature: 0.7,
+    topP: 0.9,
+    topK: 193.77,
+    promptCacheKey: "<value>",
+    previousResponseId: "<id>",
+    prompt: {
+      id: "<id>",
+      variables: {
+        "key": {
+          type: "input_text",
+          text: "Hello, how can I help you?",
+        },
+      },
+    },
+    include: [
+      "reasoning.encrypted_content",
+    ],
+    background: true,
+    safetyIdentifier: "<value>",
+    store: true,
+    serviceTier: "auto",
+    truncation: "auto",
+    provider: {
+      allowFallbacks: null,
+      requireParameters: true,
+      dataCollection: "deny",
+      zdr: true,
+      order: [
+        "OpenAI",
+      ],
+      only: [
+        "OpenAI",
+      ],
+      ignore: null,
+      quantizations: [
+        "fp16",
+      ],
+      sort: "price",
+      maxPrice: {
+        prompt: "1000",
+        completion: 1000,
+        image: 1000,
+        audio: "1000",
+        request: 1000,
+      },
+      experimental: {},
+    },
+    plugins: [
+      {
+        id: "file-parser",
+        maxFiles: 4870.55,
+        pdf: {
+          engine: "mistral-ocr",
+        },
+      },
+    ],
+    user: "Elmer_Yundt72",
+  });
 
   console.log(result);
 }
@@ -136,7 +352,11 @@ const openRouter = new OpenRouter();
 async function run() {
   const result = await openRouter.credits.createCoinbaseCharge({
     bearer: process.env["OPENROUTER_BEARER"] ?? "",
-  }, {});
+  }, {
+    amount: 100,
+    sender: "0x1234567890123456789012345678901234567890",
+    chainId: 1,
+  });
 
   console.log(result);
 }
@@ -197,6 +417,11 @@ run();
 * [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
 
+### [oAuth](docs/sdks/oauth/README.md)
+
+* [exchangeAuthCodeForAPIKey](docs/sdks/oauth/README.md#exchangeauthcodeforapikey) - Exchange authorization code for API key
+* [createAuthCode](docs/sdks/oauth/README.md#createauthcode) - Create authorization code
+
 ### [parameters](docs/sdks/parameters/README.md)
 
 * [getParameters](docs/sdks/parameters/README.md#getparameters) - Get a model's supported parameters and data about which are most popular
@@ -241,6 +466,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`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
+- [`oAuthCreateAuthCode`](docs/sdks/oauth/README.md#createauthcode) - Create authorization code
+- [`oAuthExchangeAuthCodeForAPIKey`](docs/sdks/oauth/README.md#exchangeauthcodeforapikey) - Exchange authorization code for API key
 - [`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
 
@@ -287,6 +514,8 @@ To learn about this feature and how to get started, check
 - [`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
+- [`useOAuthCreateAuthCodeMutation`](docs/sdks/oauth/README.md#createauthcode) - Create authorization code
+- [`useOAuthExchangeAuthCodeForAPIKeyMutation`](docs/sdks/oauth/README.md#exchangeauthcodeforapikey) - Exchange authorization code for API key
 - [`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
 
@@ -310,7 +539,115 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.beta.responses.send({});
+  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: {
+      type: "function",
+      name: "<value>",
+    },
+    parallelToolCalls: true,
+    model: "anthropic/claude-4.5-sonnet-20250929",
+    models: [
+      "<value 1>",
+    ],
+    text: {
+      format: {
+        type: "text",
+      },
+      verbosity: "medium",
+    },
+    reasoning: {
+      effort: "high",
+      summary: "auto",
+      maxTokens: 8661.16,
+      enabled: true,
+    },
+    maxOutputTokens: null,
+    temperature: 0.7,
+    topP: 0.9,
+    topK: 193.77,
+    promptCacheKey: "<value>",
+    previousResponseId: "<id>",
+    prompt: {
+      id: "<id>",
+      variables: {
+        "key": {
+          type: "input_text",
+          text: "Hello, how can I help you?",
+        },
+      },
+    },
+    include: [
+      "reasoning.encrypted_content",
+    ],
+    background: true,
+    safetyIdentifier: "<value>",
+    store: true,
+    serviceTier: "auto",
+    truncation: "auto",
+    provider: {
+      allowFallbacks: null,
+      requireParameters: true,
+      dataCollection: "deny",
+      zdr: true,
+      order: [
+        "OpenAI",
+      ],
+      only: [
+        "OpenAI",
+      ],
+      ignore: null,
+      quantizations: [
+        "fp16",
+      ],
+      sort: "price",
+      maxPrice: {
+        prompt: "1000",
+        completion: 1000,
+        image: 1000,
+        audio: "1000",
+        request: 1000,
+      },
+      experimental: {},
+    },
+    plugins: [
+      {
+        id: "file-parser",
+        maxFiles: 4870.55,
+        pdf: {
+          engine: "mistral-ocr",
+        },
+      },
+    ],
+    user: "Elmer_Yundt72",
+  });
 
   console.log(result);
 }
@@ -337,7 +674,115 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.beta.responses.send({}, {
+  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: {
+      type: "function",
+      name: "<value>",
+    },
+    parallelToolCalls: true,
+    model: "anthropic/claude-4.5-sonnet-20250929",
+    models: [
+      "<value 1>",
+    ],
+    text: {
+      format: {
+        type: "text",
+      },
+      verbosity: "medium",
+    },
+    reasoning: {
+      effort: "high",
+      summary: "auto",
+      maxTokens: 8661.16,
+      enabled: true,
+    },
+    maxOutputTokens: null,
+    temperature: 0.7,
+    topP: 0.9,
+    topK: 193.77,
+    promptCacheKey: "<value>",
+    previousResponseId: "<id>",
+    prompt: {
+      id: "<id>",
+      variables: {
+        "key": {
+          type: "input_text",
+          text: "Hello, how can I help you?",
+        },
+      },
+    },
+    include: [
+      "reasoning.encrypted_content",
+    ],
+    background: true,
+    safetyIdentifier: "<value>",
+    store: true,
+    serviceTier: "auto",
+    truncation: "auto",
+    provider: {
+      allowFallbacks: null,
+      requireParameters: true,
+      dataCollection: "deny",
+      zdr: true,
+      order: [
+        "OpenAI",
+      ],
+      only: [
+        "OpenAI",
+      ],
+      ignore: null,
+      quantizations: [
+        "fp16",
+      ],
+      sort: "price",
+      maxPrice: {
+        prompt: "1000",
+        completion: 1000,
+        image: 1000,
+        audio: "1000",
+        request: 1000,
+      },
+      experimental: {},
+    },
+    plugins: [
+      {
+        id: "file-parser",
+        maxFiles: 4870.55,
+        pdf: {
+          engine: "mistral-ocr",
+        },
+      },
+    ],
+    user: "Elmer_Yundt72",
+  }, {
     retries: {
       strategy: "backoff",
       backoff: {
@@ -376,7 +821,115 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.beta.responses.send({});
+  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: {
+      type: "function",
+      name: "<value>",
+    },
+    parallelToolCalls: true,
+    model: "anthropic/claude-4.5-sonnet-20250929",
+    models: [
+      "<value 1>",
+    ],
+    text: {
+      format: {
+        type: "text",
+      },
+      verbosity: "medium",
+    },
+    reasoning: {
+      effort: "high",
+      summary: "auto",
+      maxTokens: 8661.16,
+      enabled: true,
+    },
+    maxOutputTokens: null,
+    temperature: 0.7,
+    topP: 0.9,
+    topK: 193.77,
+    promptCacheKey: "<value>",
+    previousResponseId: "<id>",
+    prompt: {
+      id: "<id>",
+      variables: {
+        "key": {
+          type: "input_text",
+          text: "Hello, how can I help you?",
+        },
+      },
+    },
+    include: [
+      "reasoning.encrypted_content",
+    ],
+    background: true,
+    safetyIdentifier: "<value>",
+    store: true,
+    serviceTier: "auto",
+    truncation: "auto",
+    provider: {
+      allowFallbacks: null,
+      requireParameters: true,
+      dataCollection: "deny",
+      zdr: true,
+      order: [
+        "OpenAI",
+      ],
+      only: [
+        "OpenAI",
+      ],
+      ignore: null,
+      quantizations: [
+        "fp16",
+      ],
+      sort: "price",
+      maxPrice: {
+        prompt: "1000",
+        completion: 1000,
+        image: 1000,
+        audio: "1000",
+        request: 1000,
+      },
+      experimental: {},
+    },
+    plugins: [
+      {
+        id: "file-parser",
+        maxFiles: 4870.55,
+        pdf: {
+          engine: "mistral-ocr",
+        },
+      },
+    ],
+    user: "Elmer_Yundt72",
+  });
 
   console.log(result);
 }
@@ -411,8 +964,114 @@ const openRouter = new OpenRouter({
 
 async function run() {
   try {
-    const result = await openRouter.analytics.getUserActivity({
-      date: "2025-08-24",
+    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: {
+        type: "function",
+        name: "<value>",
+      },
+      parallelToolCalls: true,
+      model: "anthropic/claude-4.5-sonnet-20250929",
+      models: [
+        "<value 1>",
+      ],
+      text: {
+        format: {
+          type: "text",
+        },
+        verbosity: "medium",
+      },
+      reasoning: {
+        effort: "high",
+        summary: "auto",
+        maxTokens: 8661.16,
+        enabled: true,
+      },
+      maxOutputTokens: null,
+      temperature: 0.7,
+      topP: 0.9,
+      topK: 193.77,
+      promptCacheKey: "<value>",
+      previousResponseId: "<id>",
+      prompt: {
+        id: "<id>",
+        variables: {
+          "key": {
+            type: "input_text",
+            text: "Hello, how can I help you?",
+          },
+        },
+      },
+      include: [
+        "reasoning.encrypted_content",
+      ],
+      background: true,
+      safetyIdentifier: "<value>",
+      store: true,
+      serviceTier: "auto",
+      truncation: "auto",
+      provider: {
+        allowFallbacks: null,
+        requireParameters: true,
+        dataCollection: "deny",
+        zdr: true,
+        order: [
+          "OpenAI",
+        ],
+        only: [
+          "OpenAI",
+        ],
+        ignore: null,
+        quantizations: [
+          "fp16",
+        ],
+        sort: "price",
+        maxPrice: {
+          prompt: "1000",
+          completion: 1000,
+          image: 1000,
+          audio: "1000",
+          request: 1000,
+        },
+        experimental: {},
+      },
+      plugins: [
+        {
+          id: "file-parser",
+          maxFiles: 4870.55,
+          pdf: {
+            engine: "mistral-ocr",
+          },
+        },
+      ],
+      user: "Elmer_Yundt72",
     });
 
     console.log(result);
@@ -425,8 +1084,8 @@ async function run() {
       console.log(error.headers);
 
       // Depending on the method different errors may be thrown
-      if (error instanceof errors.ErrorResponse) {
-        console.log(error.data$.error); // models.ErrorResponseError
+      if (error instanceof errors.BadRequestResponseError) {
+        console.log(error.data$.error); // models.BadRequestResponseErrorData
         console.log(error.data$.userId); // string
       }
     }
@@ -438,10 +1097,11 @@ run();
 ```
 
 ### Error Classes
-**Primary error:**
+**Primary errors:**
 * [`OpenRouterError`](./src/models/errors/openroutererror.ts): The base class for HTTP error responses.
+  * [`InternalServerResponseError`](./src/models/errors/internalserverresponseerror.ts): Internal Server Error - Unexpected server error. Status code `500`. *
 
-<details><summary>Less common errors (9)</summary>
+<details><summary>Less common errors (20)</summary>
 
 <br />
 
@@ -454,9 +1114,20 @@ 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.*
+* [`UnauthorizedResponseError`](./src/models/errors/unauthorizedresponseerror.ts): Unauthorized - Authentication required or invalid credentials. Status code `401`. Applicable to 14 of 22 methods.*
+* [`BadRequestResponseError`](./src/models/errors/badrequestresponseerror.ts): Bad Request - Invalid request parameters or malformed input. Status code `400`. Applicable to 8 of 22 methods.*
+* [`TooManyRequestsResponseError`](./src/models/errors/toomanyrequestsresponseerror.ts): Too Many Requests - Rate limit exceeded. Status code `429`. Applicable to 8 of 22 methods.*
+* [`NotFoundResponseError`](./src/models/errors/notfoundresponseerror.ts): Not Found - Resource does not exist. Status code `404`. Applicable to 7 of 22 methods.*
+* [`ForbiddenResponseError`](./src/models/errors/forbiddenresponseerror.ts): Forbidden - Authentication successful but insufficient permissions. Status code `403`. Applicable to 3 of 22 methods.*
+* [`ChatError`](./src/models/errors/chaterror.ts): Bad request - invalid parameters. Applicable to 2 of 22 methods.*
+* [`PaymentRequiredResponseError`](./src/models/errors/paymentrequiredresponseerror.ts): Payment Required - Insufficient credits or quota to complete request. Status code `402`. Applicable to 2 of 22 methods.*
+* [`BadGatewayResponseError`](./src/models/errors/badgatewayresponseerror.ts): Bad Gateway - Provider/upstream API failure. Status code `502`. Applicable to 2 of 22 methods.*
+* [`EdgeNetworkTimeoutResponseError`](./src/models/errors/edgenetworktimeoutresponseerror.ts): Infrastructure Timeout - Provider request timed out at edge network. Status code `524`. Applicable to 2 of 22 methods.*
+* [`ProviderOverloadedResponseError`](./src/models/errors/provideroverloadedresponseerror.ts): Provider Overloaded - Provider is temporarily overloaded. Status code `529`. Applicable to 2 of 22 methods.*
+* [`RequestTimeoutResponseError`](./src/models/errors/requesttimeoutresponseerror.ts): Request Timeout - Operation exceeded time limit. Status code `408`. Applicable to 1 of 22 methods.*
+* [`PayloadTooLargeResponseError`](./src/models/errors/payloadtoolargeresponseerror.ts): Payload Too Large - Request payload exceeds size limits. Status code `413`. Applicable to 1 of 22 methods.*
+* [`UnprocessableEntityResponseError`](./src/models/errors/unprocessableentityresponseerror.ts): Unprocessable Entity - Semantic validation failure. Status code `422`. Applicable to 1 of 22 methods.*
+* [`ServiceUnavailableResponseError`](./src/models/errors/serviceunavailableresponseerror.ts): Service Unavailable - Service temporarily unavailable. Status code `503`. Applicable to 1 of 22 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.
 
 </details>