feat: rename bearer auth to apikey (#3)

mfbx9da4 · web-flow · commit 602525ed4f59 · 2025-09-07T08:18:30.000+01:00
diff --git a/.speakeasy/OAS_files/chat-completions-openapi.yaml b/.speakeasy/OAS_files/chat-completions-openapi.yaml
@@ -17,7 +17,7 @@ servers:
         default: openrouter.ai
     description: Production server
 security:
-  - BearerAuth: []
+  - ApiKey: []
 tags:
   - name: Chat
     description: Chat completion operations
@@ -26,7 +26,7 @@ externalDocs:
   url: https://openrouter.ai/docs
 components:
   securitySchemes:
-    BearerAuth:
+    ApiKey:
       type: http
       scheme: bearer
       description: API key as bearer token in Authorization header
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 53e6e641-e7b6-4f11-8e15-1d930a684b2b
 management:
-  docChecksum: b163f9f41b3d71f314b6facfd6e73920
+  docChecksum: 94a9004b4eb9d74143f6acdb06982dd9
   docVersion: 1.0.0
   speakeasyVersion: 1.611.0
   generationVersion: 2.694.1
-  releaseVersion: 0.5.2
-  configChecksum: 26a6d90117542e88807eeb93978d6ae1
+  releaseVersion: 0.5.3
+  configChecksum: 86f9fc17e898d37ca28f113762f1344a
   repoURL: https://github.com/speakeasy-sdks/openrouter-typescript-sdk.git
   installationURL: https://github.com/speakeasy-sdks/openrouter-typescript-sdk
 features:
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -25,7 +25,7 @@ generation:
     generateNewTests: true
     skipResponseBodyAssertions: false
 typescript:
-  version: 0.5.2
+  version: 0.5.3
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
diff --git a/.speakeasy/out.openapi.yaml b/.speakeasy/out.openapi.yaml
@@ -17,7 +17,7 @@ servers:
         default: openrouter.ai
     description: Production server
 security:
-  - BearerAuth: []
+  - ApiKey: []
 tags:
   - name: Chat
     description: Chat completion operations
@@ -26,7 +26,7 @@ externalDocs:
   url: https://openrouter.ai/docs
 components:
   securitySchemes:
-    BearerAuth:
+    ApiKey:
       type: http
       scheme: bearer
       description: API key as bearer token in Authorization header
diff --git a/FUNCTIONS.md b/FUNCTIONS.md
@@ -25,7 +25,7 @@ import { chatComplete } from "open-router/funcs/chatComplete.js";
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
diff --git a/README.md b/README.md
@@ -94,7 +94,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 import { OpenRouter } from "open-router";
 
 const openRouter = new OpenRouter({
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
@@ -125,16 +125,16 @@ run();
 
 This SDK supports the following security scheme globally:
 
-| Name         | Type | Scheme      | Environment Variable     |
-| ------------ | ---- | ----------- | ------------------------ |
-| `bearerAuth` | http | HTTP Bearer | `OPENROUTER_BEARER_AUTH` |
+| Name     | Type | Scheme      | Environment Variable |
+| -------- | ---- | ----------- | -------------------- |
+| `apiKey` | http | HTTP Bearer | `OPENROUTER_API_KEY` |
 
-To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
+To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
 import { OpenRouter } from "open-router";
 
 const openRouter = new OpenRouter({
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
@@ -283,7 +283,7 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { OpenRouter } from "open-router";
 
 const openRouter = new OpenRouter({
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
@@ -332,7 +332,7 @@ const openRouter = new OpenRouter({
     },
     retryConnectionErrors: false,
   },
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
@@ -376,7 +376,7 @@ import { OpenRouter } from "open-router";
 import * as errors from "open-router/models/errors";
 
 const openRouter = new OpenRouter({
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
@@ -455,7 +455,7 @@ import { OpenRouter } from "open-router";
 
 const openRouter = new OpenRouter({
   providerUrl: "https://ruddy-guacamole.info/",
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
@@ -486,7 +486,7 @@ import { OpenRouter } from "open-router";
 
 const openRouter = new OpenRouter({
   serverURL: "https://openrouter.ai/api/v1",
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
diff --git a/USAGE.md b/USAGE.md
@@ -3,7 +3,7 @@
 import { OpenRouter } from "open-router";
 
 const openRouter = new OpenRouter({
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
diff --git a/docs/models/security.md b/docs/models/security.md
@@ -12,4 +12,4 @@ let value: Security = {};
 
 | Field              | Type               | Required           | Description        |
 | ------------------ | ------------------ | ------------------ | ------------------ |
-| `bearerAuth`       | *string*           | :heavy_minus_sign: | N/A                |
+| `apiKey`           | *string*           | :heavy_minus_sign: | N/A                |
diff --git a/docs/sdks/chat/README.md b/docs/sdks/chat/README.md
@@ -18,7 +18,7 @@ Creates a model response for the given chat conversation. Supports both streamin
 import { OpenRouter } from "open-router";
 
 const openRouter = new OpenRouter({
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
@@ -51,7 +51,7 @@ import { chatComplete } from "open-router/funcs/chatComplete.js";
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore({
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function run() {
diff --git a/examples/.env.template b/examples/.env.template
@@ -7,7 +7,7 @@
 # with the prefix: OPENROUTER_
 #
 # Security environment variables:
-OPENROUTER_BEARER_AUTH=your_bearer_auth_here
+OPENROUTER_API_KEY=your_api_key_here
 
 # Debug Configuration
 # Enable HTTP request/response logging for debugging
diff --git a/examples/chatCompletion.example.ts b/examples/chatCompletion.example.ts
@@ -1,12 +1,8 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
 import dotenv from "dotenv";
 dotenv.config();
 import { OpenRouter } from "open-router";
 const openRouter = new OpenRouter({
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 async function main() {
   const result = await openRouter.chat.complete({
diff --git a/examples/chatCompletionStream.example.ts b/examples/chatCompletionStream.example.ts
@@ -1,14 +1,10 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
 import dotenv from "dotenv";
 dotenv.config();
 
 import { OpenRouter } from "open-router";
 
 const openRouter = new OpenRouter({
-  bearerAuth: process.env["OPENROUTER_BEARER_AUTH"] ?? "",
+  apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
 });
 
 async function main() {
diff --git a/jsr.json b/jsr.json
@@ -2,7 +2,7 @@
 
 {
   "name": "open-router",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "open-router",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {
diff --git a/src/funcs/chatComplete.ts b/src/funcs/chatComplete.ts
@@ -102,8 +102,8 @@ async function $do(
       || "application/json;q=1, text/event-stream;q=0",
   }));
 
-  const secConfig = await extractSecurity(client._options.bearerAuth);
-  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -114,7 +114,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.bearerAuth,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
diff --git a/src/lib/config.ts b/src/lib/config.ts
@@ -18,7 +18,7 @@ export const ServerList = [
 ] as const;
 
 export type SDKOptions = {
-  bearerAuth?: string | (() => Promise<string>) | undefined;
+  apiKey?: string | (() => Promise<string>) | undefined;
 
   httpClient?: HTTPClient;
   /**
@@ -71,7 +71,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.5.2",
+  sdkVersion: "0.5.3",
   genVersion: "2.694.1",
-  userAgent: "speakeasy-sdk/typescript 0.5.2 2.694.1 1.0.0 open-router",
+  userAgent: "speakeasy-sdk/typescript 0.5.3 2.694.1 1.0.0 open-router",
 } as const;
diff --git a/src/lib/env.ts b/src/lib/env.ts
@@ -7,13 +7,13 @@ import { dlv } from "./dlv.js";
 import * as z from "zod";
 
 export interface Env {
-  OPENROUTER_BEARER_AUTH?: string | undefined;
+  OPENROUTER_API_KEY?: string | undefined;
 
   OPENROUTER_DEBUG?: boolean | undefined;
 }
 
 export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
-  OPENROUTER_BEARER_AUTH: z.string().optional(),
+  OPENROUTER_API_KEY: z.string().optional(),
 
   OPENROUTER_DEBUG: z.coerce.boolean().optional(),
 });
diff --git a/src/lib/security.ts b/src/lib/security.ts
@@ -247,7 +247,7 @@ export function resolveGlobalSecurity(
       {
         fieldName: "Authorization",
         type: "http:bearer",
-        value: security?.bearerAuth ?? env().OPENROUTER_BEARER_AUTH,
+        value: security?.apiKey ?? env().OPENROUTER_API_KEY,
       },
     ],
   );
diff --git a/src/models/security.ts b/src/models/security.ts
@@ -9,7 +9,7 @@ import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 export type Security = {
-  bearerAuth?: string | undefined;
+  apiKey?: string | undefined;
 };
 
 /** @internal */
@@ -18,16 +18,16 @@ export const Security$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  BearerAuth: z.string().optional(),
+  ApiKey: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "BearerAuth": "bearerAuth",
+    "ApiKey": "apiKey",
   });
 });
 
 /** @internal */
 export type Security$Outbound = {
-  BearerAuth?: string | undefined;
+  ApiKey?: string | undefined;
 };
 
 /** @internal */
@@ -36,10 +36,10 @@ export const Security$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Security
 > = z.object({
-  bearerAuth: z.string().optional(),
+  apiKey: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    bearerAuth: "BearerAuth",
+    apiKey: "ApiKey",
   });
 });
 

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`# with the prefix: OPENROUTER_`
`8`	`8`	`#`
`9`	`9`	`# Security environment variables:`
`10`		`-OPENROUTER_BEARER_AUTH=your_bearer_auth_here`
	`10`	`+OPENROUTER_API_KEY=your_api_key_here`
`11`	`11`
`12`	`12`	`# Debug Configuration`
`13`	`13`	`# Enable HTTP request/response logging for debugging`