@openrouter/sdk 0.0.0-beta.1 → 0.0.0-beta.17

package/docs/sdks/responses/README.md

@@ -0,0 +1,103 @@
+# Responses
+(*alpha.responses*)
+
+## Overview
+
+### Available Operations
+
+* [send2](#send2) - Submit a response request
+
+## send2
+
+Submits a request to the Responses API (beta)
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="post_/api/alpha/responses" 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.alpha.responses.send2({
+    provider: {
+      zdr: true,
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OpenRouterCore } from "@openrouter/sdk/core.js";
+import { alphaResponsesSend2 } from "@openrouter/sdk/funcs/alphaResponsesSend2.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 alphaResponsesSend2(openRouter, {
+    provider: {
+      zdr: true,
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("alphaResponsesSend2 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.
+  useAlphaResponsesSend2Mutation
+} from "@openrouter/sdk/react-query/alphaResponsesSend2.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.PostApiAlphaResponsesRequest](../../models/operations/postapialpharesponsesrequest.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.PostApiAlphaResponsesResponse](../../models/operations/postapialpharesponsesresponse.md)\>**
+
+### Errors
+
+| Error Type           | Status Code          | Content Type         |
+| -------------------- | -------------------- | -------------------- |
+| errors.ErrorResponse | 4XX                  | application/json     |
+| errors.ErrorResponse | 5XX                  | application/json     |

package/examples/{getCredits.example.ts → alphaResponsesSend2.example.ts}

@@ -8,19 +8,21 @@ dotenv.config();
  * Example usage of the @openrouter/sdk SDK
  *
  * To run this example from the examples directory:
- * npm run build && npx tsx getCredits.example.ts
+ * npm run build && npx tsx alphaResponsesSend2.example.ts
  */
 
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter({
-  security: {
-    apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
-  },
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function main() {
-  const result = await openRouter.getCredits();
+  const result = await openRouter.alpha.responses.send2({
+    provider: {
+      zdr: true,
+    },
+  });
 
   console.log(result);
 }

package/examples/chatCompletions.example.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import dotenv from "dotenv";
+dotenv.config();
+/**
+ * Example usage of the @openrouter/sdk SDK for chat completions
+ *
+ * To run this example from the examples directory with Bun:
+ * bun run chatCompletions.example.ts
+ */
+
+import { OpenRouter } from "@openrouter/sdk";
+
+
+if (!process.env["OPENROUTER_API_KEY"]) {
+  throw new Error("Missing OPENROUTER_API_KEY environment variable");
+}
+const openRouter = new OpenRouter({
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
+  debugLogger: console
+});
+
+async function nonStreamingExample() {
+  console.log("=== Non-Streaming Example ===\n");
+
+  const result = await openRouter.chat.send({
+    model: "qwen/qwen3-max",
+    messages: [
+      {
+        role: "user",
+        content: "Tell me a short joke about programming",
+      },
+    ],
+    stream: false,
+  });
+
+  if ("choices" in result) {
+    console.log("Model:", result.model);
+    console.log("Response:", result.choices[0].message.content);
+    console.log("Usage:", result.usage);
+  }
+}
+
+async function streamingExample() {
+  console.log("\n=== Streaming Example ===\n");
+
+  const result = await openRouter.chat.send({
+    model: "qwen/qwen3-max",
+    messages: [
+      {
+        role: "user",
+        content: "Write a haiku about TypeScript",
+      },
+    ],
+    stream: true,
+    streamOptions: {
+      includeUsage: true,
+    },
+  });
+
+  if (result && typeof result === "object" && Symbol.asyncIterator in result) {
+    const stream = result
+    console.log("Streaming response:");
+    let fullContent = "";
+
+    for await (const chunk of stream) {
+      if (chunk.data.choices && chunk.data.choices[0]?.delta?.content) {
+        const content = chunk.data.choices[0].delta.content;
+        process.stdout.write(content);
+        fullContent += content;
+      }
+
+      if (chunk.data.usage) {
+        console.log("\n\nStream usage:", chunk.data.usage);
+      }
+    }
+
+    console.log("\n\nFull response:", fullContent);
+  }
+}
+
+async function main() {
+  try {
+    await nonStreamingExample();
+    await streamingExample();
+  } catch (error) {
+    console.error("Error:", error);
+  }
+}
+
+main();

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@openrouter/sdk",
-  "version": "0.0.0-beta.1",
+  "version": "0.0.0-beta.17",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openrouter/sdk",
-  "version": "0.0.0-beta.1",
+  "version": "0.0.0-beta.17",
   "author": "OpenRouter",
   "type": "module",
   "tshy": {
@@ -20,6 +20,10 @@
     }
   },
   "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OpenRouterTeam/typescript-sdk.git"
+  },
   "scripts": {
     "lint": "eslint --cache --max-warnings=0 src",
     "build": "tshy",

package/src/funcs/alphaResponsesSend2.ts

@@ -0,0 +1,231 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OpenRouterCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { EventStream } from "../lib/event-streams.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export enum Send2AcceptEnum {
+  applicationJson = "application/json",
+  textEventStream = "text/event-stream",
+}
+
+/**
+ * Submit a response request
+ *
+ * @remarks
+ * Submits a request to the Responses API (beta)
+ */
+export function alphaResponsesSend2(
+  client: OpenRouterCore,
+  request: operations.PostApiAlphaResponsesRequest & { stream?: false },
+  options?: RequestOptions & { acceptHeaderOverride?: Send2AcceptEnum },
+): APIPromise<
+  Result<
+    operations.PostApiAlphaResponsesResponseBody,
+    | errors.ErrorResponse
+    | OpenRouterError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+>;
+export function alphaResponsesSend2(
+  client: OpenRouterCore,
+  request: operations.PostApiAlphaResponsesRequest & { stream: true },
+  options?: RequestOptions & { acceptHeaderOverride?: Send2AcceptEnum },
+): APIPromise<
+  Result<
+    EventStream<any>,
+    | errors.ErrorResponse
+    | OpenRouterError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+>;
+export function alphaResponsesSend2(
+  client: OpenRouterCore,
+  request: operations.PostApiAlphaResponsesRequest,
+  options?: RequestOptions & { acceptHeaderOverride?: Send2AcceptEnum },
+): APIPromise<
+  Result<
+    operations.PostApiAlphaResponsesResponse,
+    | errors.ErrorResponse
+    | OpenRouterError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+>;
+export function alphaResponsesSend2(
+  client: OpenRouterCore,
+  request: operations.PostApiAlphaResponsesRequest,
+  options?: RequestOptions & { acceptHeaderOverride?: Send2AcceptEnum },
+): APIPromise<
+  Result<
+    operations.PostApiAlphaResponsesResponse,
+    | errors.ErrorResponse
+    | OpenRouterError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OpenRouterCore,
+  request: operations.PostApiAlphaResponsesRequest,
+  options?: RequestOptions & { acceptHeaderOverride?: Send2AcceptEnum },
+): Promise<
+  [
+    Result<
+      operations.PostApiAlphaResponsesResponse,
+      | errors.ErrorResponse
+      | OpenRouterError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.PostApiAlphaResponsesRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/api/alpha/responses")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: options?.acceptHeaderOverride
+      || "application/json;q=1, text/event-stream;q=0",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "post_/api/alpha/responses",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.PostApiAlphaResponsesResponse,
+    | errors.ErrorResponse
+    | OpenRouterError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.PostApiAlphaResponsesResponse$inboundSchema),
+    M.sse(200, operations.PostApiAlphaResponsesResponse$inboundSchema),
+    M.jsonErr("4XX", errors.ErrorResponse$inboundSchema),
+    M.jsonErr("5XX", errors.ErrorResponse$inboundSchema),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/analyticsGetActivity.ts

@@ -17,6 +17,7 @@ import {
   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";
@@ -37,6 +38,7 @@ export function analyticsGetActivity(
 ): APIPromise<
   Result<
     operations.GetActivityResponse,
+    | errors.ErrorResponse
     | OpenRouterError
     | ResponseValidationError
     | ConnectionError
@@ -62,6 +64,7 @@ async function $do(
   [
     Result<
       operations.GetActivityResponse,
+      | errors.ErrorResponse
       | OpenRouterError
       | ResponseValidationError
       | ConnectionError
@@ -96,7 +99,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -107,7 +111,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -141,8 +145,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
     operations.GetActivityResponse,
+    | errors.ErrorResponse
     | OpenRouterError
     | ResponseValidationError
     | ConnectionError
@@ -153,10 +162,9 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, operations.GetActivityResponse$inboundSchema),
-    M.fail("4XX"),
-    M.fail("5XX"),
-    M.json("default", operations.GetActivityResponse$inboundSchema),
-  )(response, req);
+    M.jsonErr("4XX", errors.ErrorResponse$inboundSchema),
+    M.jsonErr("5XX", errors.ErrorResponse$inboundSchema),
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/apiKeysDeleteKeysHash.ts

@@ -17,6 +17,7 @@ import {
   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";
@@ -34,6 +35,7 @@ export function apiKeysDeleteKeysHash(
 ): APIPromise<
   Result<
     operations.DeleteKeysHashResponse,
+    | errors.ErrorResponse
     | OpenRouterError
     | ResponseValidationError
     | ConnectionError
@@ -59,6 +61,7 @@ async function $do(
   [
     Result<
       operations.DeleteKeysHashResponse,
+      | errors.ErrorResponse
       | OpenRouterError
       | ResponseValidationError
       | ConnectionError
@@ -95,7 +98,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -106,7 +110,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -139,8 +143,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
     operations.DeleteKeysHashResponse,
+    | errors.ErrorResponse
     | OpenRouterError
     | ResponseValidationError
     | ConnectionError
@@ -151,10 +160,9 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, operations.DeleteKeysHashResponse$inboundSchema),
-    M.fail("4XX"),
-    M.fail("5XX"),
-    M.json("default", operations.DeleteKeysHashResponse$inboundSchema),
-  )(response, req);
+    M.jsonErr("4XX", errors.ErrorResponse$inboundSchema),
+    M.jsonErr("5XX", errors.ErrorResponse$inboundSchema),
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/apiKeysGetAuthKey.ts

@@ -15,6 +15,7 @@ import {
   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";
@@ -34,6 +35,7 @@ export function apiKeysGetAuthKey(
 ): APIPromise<
   Result<
     operations.GetAuthKeyResponse,
+    | errors.ErrorResponse
     | OpenRouterError
     | ResponseValidationError
     | ConnectionError
@@ -57,6 +59,7 @@ async function $do(
   [
     Result<
       operations.GetAuthKeyResponse,
+      | errors.ErrorResponse
       | OpenRouterError
       | ResponseValidationError
       | ConnectionError
@@ -75,7 +78,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -86,7 +90,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -118,8 +122,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
     operations.GetAuthKeyResponse,
+    | errors.ErrorResponse
     | OpenRouterError
     | ResponseValidationError
     | ConnectionError
@@ -130,10 +139,9 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, operations.GetAuthKeyResponse$inboundSchema),
-    M.fail("4XX"),
-    M.fail("5XX"),
-    M.json("default", operations.GetAuthKeyResponse$inboundSchema),
-  )(response, req);
+    M.jsonErr("4XX", errors.ErrorResponse$inboundSchema),
+    M.jsonErr("5XX", errors.ErrorResponse$inboundSchema),
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }