@ai-sdk/gateway 4.0.129 → 4.0.131

package/docs/00-ai-gateway.mdx

@@ -91,7 +91,12 @@ You can use the following optional settings to customize the AI Gateway provider
 
   Use a different URL prefix for API calls. The default prefix is `https://ai-gateway.vercel.sh/v4/ai`.
 
-- **apiKey** _string_
+- **apiKey** _string | PromiseLike<string> | (() => string | PromiseLike<string>)_
+
+  Pass a callback to resolve the API key before each request. The callback can
+  return a string or a promise; token caching and renewal are handled by the caller.
+  A callback or promise selects API key authentication and must resolve to a
+  non-empty string; lookup failures do not switch authentication methods.
 
   API key or Vercel access token that is being sent using the `Authorization`
   header. It defaults to the `AI_GATEWAY_API_KEY` environment variable.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ai-sdk/gateway",
   "private": false,
-  "version": "4.0.129",
+  "version": "4.0.131",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -30,8 +30,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "4.0.34",
-    "@ai-sdk/provider-utils": "5.0.70",
+    "@ai-sdk/provider": "4.0.35",
+    "@ai-sdk/provider-utils": "5.0.72",
     "@vercel/oidc": "3.2.0"
   },
   "devDependencies": {

package/src/errors/as-gateway-error.ts

@@ -31,6 +31,15 @@ export async function asGatewayError(
   error: unknown,
   authMethod?: 'api-key' | 'oidc',
 ) {
+  // Caller cancellation is not a gateway failure and must not become a retryable 500.
+  if (
+    (error instanceof Error ||
+      (typeof DOMException === 'function' && error instanceof DOMException)) &&
+    (error.name === 'AbortError' || error.name === 'TimeoutError')
+  ) {
+    throw error;
+  }
+
   if (GatewayError.isInstance(error)) {
     return error;
   }

package/src/gateway-language-model-settings.ts

@@ -259,6 +259,7 @@ export type GatewayModelId =
   | 'openai/o3-mini'
   | 'openai/o3-pro'
   | 'openai/o4-mini'
+  | 'particle/particle-1'
   | 'perplexity/sonar'
   | 'poolside/laguna-s-2.1'
   | 'poolside/laguna-s-2.1-free'

package/src/gateway-provider.ts

@@ -5,10 +5,12 @@ import {
   createJsonResponseHandler,
   getErrorMessage,
   loadOptionalSetting,
+  resolve,
   postJsonToApi,
   withoutTrailingSlash,
   withUserAgentSuffix,
   type FetchFunction,
+  type Resolvable,
   type WebSocketConstructor,
 } from '@ai-sdk/provider-utils';
 import { z } from './zod';
@@ -57,20 +59,21 @@ import type { GatewayVideoModelId } from './gateway-video-model-settings';
 import { gatewayTools } from './gateway-tools';
 import { getVercelOidcToken, getVercelRequestId } from './vercel-environment';
 import type { GatewayModelId } from './gateway-language-model-settings';
-import type {
-  EmbeddingModelV4,
-  Experimental_BatchV4 as BatchV4,
-  ImageModelV4,
-  RerankingModelV4,
-  SpeechModelV4,
-  TranscriptionModelV4,
-  Experimental_VideoModelV4,
-  Experimental_DecisionModelV4,
-  Experimental_StreamingSpeechModelV4,
-  Experimental_RealtimeFactoryV4 as RealtimeFactoryV4,
-  Experimental_RealtimeFactoryV4GetTokenOptions as RealtimeFactoryV4GetTokenOptions,
-  ProviderV4,
-  LanguageModelV4,
+import {
+  LoadAPIKeyError,
+  type EmbeddingModelV4,
+  type Experimental_BatchV4 as BatchV4,
+  type ImageModelV4,
+  type RerankingModelV4,
+  type SpeechModelV4,
+  type TranscriptionModelV4,
+  type Experimental_VideoModelV4,
+  type Experimental_DecisionModelV4,
+  type Experimental_StreamingSpeechModelV4,
+  type Experimental_RealtimeFactoryV4 as RealtimeFactoryV4,
+  type Experimental_RealtimeFactoryV4GetTokenOptions as RealtimeFactoryV4GetTokenOptions,
+  type ProviderV4,
+  type LanguageModelV4,
 } from '@ai-sdk/provider';
 import { VERSION } from './version';
 
@@ -306,8 +309,9 @@ export interface GatewayProviderSettings {
   /**
    * API key or Vercel access token that is being sent using the `Authorization`
    * header. It defaults to the `AI_GATEWAY_API_KEY` environment variable.
+   * A callback is resolved before each request and must return a non-empty key.
    */
-  apiKey?: string;
+  apiKey?: Resolvable<string>;
 
   /**
    * Vercel team ID or slug to scope requests for access tokens that can access
@@ -392,9 +396,13 @@ export function createGateway(
       `ai-sdk-gateway/${VERSION}`,
     );
 
-  const getHeaders = async () => {
+  const getHeaders = async (
+    onResolved?: (headers: Record<string, string | undefined>) => void,
+  ) => {
     try {
-      return createAuthHeaders(await getGatewayAuthToken(options));
+      const headers = createAuthHeaders(await getGatewayAuthToken(options));
+      onResolved?.(headers);
+      return headers;
     } catch (error) {
       throw GatewayAuthenticationError.createContextualError({
         apiKeyProvided: false,
@@ -520,9 +528,13 @@ export function createGateway(
     if (!pendingMetadata || now - lastFetchTime > cacheRefreshMillis) {
       lastFetchTime = now;
 
+      let resolvedHeaders: Record<string, string | undefined> | undefined;
       pendingMetadata = new GatewayFetchMetadata({
         baseURL,
-        headers: getHeaders,
+        headers: () =>
+          getHeaders(headers => {
+            resolvedHeaders = headers;
+          }),
         fetch: options.fetch,
       })
         .getAvailableModels()
@@ -533,7 +545,7 @@ export function createGateway(
         .catch(async (error: unknown) => {
           throw await asGatewayError(
             error,
-            await parseAuthMethod(await getHeaders()),
+            await parseAuthMethod(resolvedHeaders ?? {}),
           );
         });
     }
@@ -542,46 +554,58 @@ export function createGateway(
   };
 
   const getCredits = async () => {
+    let resolvedHeaders: Record<string, string | undefined> | undefined;
     return new GatewayFetchMetadata({
       baseURL,
-      headers: getHeaders,
+      headers: () =>
+        getHeaders(headers => {
+          resolvedHeaders = headers;
+        }),
       fetch: options.fetch,
     })
       .getCredits()
       .catch(async (error: unknown) => {
         throw await asGatewayError(
           error,
-          await parseAuthMethod(await getHeaders()),
+          await parseAuthMethod(resolvedHeaders ?? {}),
         );
       });
   };
 
   const getSpendReport = async (params: GatewaySpendReportParams) => {
+    let resolvedHeaders: Record<string, string | undefined> | undefined;
     return new GatewaySpendReport({
       baseURL,
-      headers: getHeaders,
+      headers: () =>
+        getHeaders(headers => {
+          resolvedHeaders = headers;
+        }),
       fetch: options.fetch,
     })
       .getSpendReport(params)
       .catch(async (error: unknown) => {
         throw await asGatewayError(
           error,
-          await parseAuthMethod(await getHeaders()),
+          await parseAuthMethod(resolvedHeaders ?? {}),
         );
       });
   };
 
   const getGenerationInfo = async (params: GatewayGenerationInfoParams) => {
+    let resolvedHeaders: Record<string, string | undefined> | undefined;
     return new GatewayGenerationInfoFetcher({
       baseURL,
-      headers: getHeaders,
+      headers: () =>
+        getHeaders(headers => {
+          resolvedHeaders = headers;
+        }),
       fetch: options.fetch,
     })
       .getGenerationInfo(params)
       .catch(async (error: unknown) => {
         throw await asGatewayError(
           error,
-          await parseAuthMethod(await getHeaders()),
+          await parseAuthMethod(resolvedHeaders ?? {}),
         );
       });
   };
@@ -770,8 +794,22 @@ export const gateway = createGateway();
 export async function getGatewayAuthToken(
   options: GatewayProviderSettings,
 ): Promise<{ token: string; authMethod: 'api-key' | 'oidc' }> {
+  const resolvedApiKey =
+    typeof options.apiKey === 'string' || options.apiKey == null
+      ? options.apiKey
+      : await resolve(options.apiKey);
+  if (
+    options.apiKey != null &&
+    typeof options.apiKey !== 'string' &&
+    (typeof resolvedApiKey !== 'string' || !resolvedApiKey.trim())
+  ) {
+    throw new LoadAPIKeyError({
+      message: 'AI Gateway API key must be a non-empty string.',
+    });
+  }
+
   const apiKey = loadOptionalSetting({
-    settingValue: options.apiKey,
+    settingValue: resolvedApiKey,
     environmentVariableName: 'AI_GATEWAY_API_KEY',
   });
 

package/src/gateway-stream-errors.ts

@@ -10,7 +10,10 @@ export async function errorControllerWithGatewayError<PART>(
   error: unknown,
   authMethod: 'api-key' | 'oidc' | undefined,
 ): Promise<void> {
-  controller.error(await asGatewayError(error, authMethod));
+  // Cancellation errors are rethrown by asGatewayError and must still reach the stream.
+  controller.error(
+    await asGatewayError(error, authMethod).catch(error => error),
+  );
 }
 
 /**