@openrouter/ai-sdk-provider 1.3.0 → 1.4.1

package/README.md

@@ -55,6 +55,64 @@ This list is not a definitive list of models supported by OpenRouter, as it cons
 
 You can find the latest list of tool-supported models supported by OpenRouter [here](https://openrouter.ai/models?order=newest&supported_parameters=tools). (Note: This list may contain models that are not compatible with the AI SDK.)
 
+## Embeddings
+
+OpenRouter supports embedding models for semantic search, RAG pipelines, and vector-native features. The provider exposes embeddings compatible with both AI SDK v5 and v4.
+
+### AI SDK v5 (Recommended)
+
+```ts
+import { embed } from 'ai';
+import { openrouter } from '@openrouter/ai-sdk-provider';
+
+const { embedding } = await embed({
+  model: openrouter.textEmbeddingModel('openai/text-embedding-3-small'),
+  value: 'sunny day at the beach',
+});
+
+console.log(embedding); // Array of numbers representing the embedding
+```
+
+### Batch Embeddings
+
+```ts
+import { embedMany } from 'ai';
+import { openrouter } from '@openrouter/ai-sdk-provider';
+
+const { embeddings } = await embedMany({
+  model: openrouter.textEmbeddingModel('openai/text-embedding-3-small'),
+  values: [
+    'sunny day at the beach',
+    'rainy day in the city',
+    'snowy mountain peak',
+  ],
+});
+
+console.log(embeddings); // Array of embedding arrays
+```
+
+### AI SDK v4 (Deprecated)
+
+For backwards compatibility, the `embedding` method is also available:
+
+```ts
+import { embed } from 'ai';
+import { openrouter } from '@openrouter/ai-sdk-provider';
+
+const { embedding } = await embed({
+  model: openrouter.embedding('openai/text-embedding-3-small'),
+  value: 'sunny day at the beach',
+});
+```
+
+### Supported Embedding Models
+
+OpenRouter supports various embedding models including:
+- `openai/text-embedding-3-small`
+- `openai/text-embedding-3-large`
+- `openai/text-embedding-ada-002`
+- And more available on [OpenRouter](https://openrouter.ai/models?output_modalities=embeddings)
+
 ## Passing Extra Body to OpenRouter
 
 There are 3 ways to pass extra body to OpenRouter:

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Content, LanguageModelV2FinishReason, LanguageModelV2Usage, LanguageModelV2CallWarning, LanguageModelV2ResponseMetadata, SharedV2Headers, LanguageModelV2StreamPart, ProviderV2 } from '@ai-sdk/provider';
+import { LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Content, LanguageModelV2FinishReason, LanguageModelV2Usage, LanguageModelV2CallWarning, LanguageModelV2ResponseMetadata, SharedV2Headers, LanguageModelV2StreamPart, EmbeddingModelV2, SharedV2ProviderMetadata, ProviderV2 } from '@ai-sdk/provider';
 export { LanguageModelV2, LanguageModelV2Prompt } from '@ai-sdk/provider';
 import * as models from '@openrouter/sdk/models';
 import { z } from 'zod/v4';
@@ -70,6 +70,14 @@ type OpenRouterChatSettings = {
          * Custom search prompt to guide the search query
          */
         search_prompt?: string;
+        /**
+         * Search engine to use for web search
+         * - "native": Use provider's built-in web search
+         * - "exa": Use Exa's search API
+         * - undefined: Native if supported, otherwise Exa
+         * @see https://openrouter.ai/docs/features/web-search
+         */
+        engine?: models.Engine;
     };
     /**
      * Debug options for troubleshooting API requests.
@@ -130,6 +138,63 @@ type OpenRouterChatSettings = {
             audio?: number | string;
             request?: number | string;
         };
+        /**
+         * Whether to restrict routing to only ZDR (Zero Data Retention) endpoints.
+         * When true, only endpoints that do not retain prompts will be used.
+         */
+        zdr?: boolean;
+    };
+} & OpenRouterSharedSettings;
+
+type OpenRouterEmbeddingModelId = string;
+type OpenRouterEmbeddingSettings = {
+    /**
+     * A unique identifier representing your end-user, which can help OpenRouter to
+     * monitor and detect abuse.
+     */
+    user?: string;
+    /**
+     * Provider routing preferences to control request routing behavior
+     */
+    provider?: {
+        /**
+         * List of provider slugs to try in order (e.g. ["openai", "voyageai"])
+         */
+        order?: string[];
+        /**
+         * Whether to allow backup providers when primary is unavailable (default: true)
+         */
+        allow_fallbacks?: boolean;
+        /**
+         * Only use providers that support all parameters in your request (default: false)
+         */
+        require_parameters?: boolean;
+        /**
+         * Control whether to use providers that may store data
+         */
+        data_collection?: 'allow' | 'deny';
+        /**
+         * List of provider slugs to allow for this request
+         */
+        only?: string[];
+        /**
+         * List of provider slugs to skip for this request
+         */
+        ignore?: string[];
+        /**
+         * Sort providers by price, throughput, or latency
+         */
+        sort?: 'price' | 'throughput' | 'latency';
+        /**
+         * Maximum pricing you want to pay for this request
+         */
+        max_price?: {
+            prompt?: number | string;
+            completion?: number | string;
+            image?: number | string;
+            audio?: number | string;
+            request?: number | string;
+        };
     };
 } & OpenRouterSharedSettings;
 
@@ -277,6 +342,7 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
     readonly provider = "openrouter";
     readonly defaultObjectGenerationMode: "tool";
     readonly modelId: OpenRouterChatModelId;
+    readonly supportsImageUrls = true;
     readonly supportedUrls: Record<string, RegExp[]>;
     readonly settings: OpenRouterChatSettings;
     private readonly config;
@@ -330,6 +396,7 @@ declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
     readonly specificationVersion: "v2";
     readonly provider = "openrouter";
     readonly modelId: OpenRouterCompletionModelId;
+    readonly supportsImageUrls = true;
     readonly supportedUrls: Record<string, RegExp[]>;
     readonly defaultObjectGenerationMode: undefined;
     readonly settings: OpenRouterCompletionSettings;
@@ -340,6 +407,42 @@ declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
     doStream(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
 }
 
+type OpenRouterEmbeddingConfig = {
+    provider: string;
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
+};
+declare class OpenRouterEmbeddingModel implements EmbeddingModelV2<string> {
+    readonly specificationVersion: "v2";
+    readonly provider = "openrouter";
+    readonly modelId: OpenRouterEmbeddingModelId;
+    readonly settings: OpenRouterEmbeddingSettings;
+    readonly maxEmbeddingsPerCall: undefined;
+    readonly supportsParallelCalls = true;
+    private readonly config;
+    constructor(modelId: OpenRouterEmbeddingModelId, settings: OpenRouterEmbeddingSettings, config: OpenRouterEmbeddingConfig);
+    doEmbed(options: {
+        values: Array<string>;
+        abortSignal?: AbortSignal;
+        headers?: Record<string, string | undefined>;
+    }): Promise<{
+        embeddings: Array<Array<number>>;
+        usage?: {
+            tokens: number;
+        };
+        providerMetadata?: SharedV2ProviderMetadata;
+        response?: {
+            headers?: SharedV2Headers;
+            body?: unknown;
+        };
+    }>;
+}
+
 interface OpenRouterProvider extends ProviderV2 {
     (modelId: OpenRouterChatModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
     (modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
@@ -353,6 +456,15 @@ interface OpenRouterProvider extends ProviderV2 {
   Creates an OpenRouter completion model for text generation.
      */
     completion(modelId: OpenRouterCompletionModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
+    /**
+  Creates an OpenRouter text embedding model. (AI SDK v5)
+     */
+    textEmbeddingModel(modelId: OpenRouterEmbeddingModelId, settings?: OpenRouterEmbeddingSettings): OpenRouterEmbeddingModel;
+    /**
+  Creates an OpenRouter text embedding model. (AI SDK v4 - deprecated, use textEmbeddingModel instead)
+  @deprecated Use textEmbeddingModel instead
+     */
+    embedding(modelId: OpenRouterEmbeddingModelId, settings?: OpenRouterEmbeddingSettings): OpenRouterEmbeddingModel;
 }
 interface OpenRouterProviderSettings {
     /**
@@ -386,6 +498,11 @@ interface OpenRouterProviderSettings {
   A JSON object to send as the request body to access OpenRouter features & upstream provider features.
     */
     extraBody?: Record<string, unknown>;
+    /**
+     * Record of provider slugs to API keys for injecting into provider routing.
+     * Maps provider slugs (e.g. "anthropic", "openai") to their respective API keys.
+     */
+    api_keys?: Record<string, string>;
 }
 /**
 Create an OpenRouter provider instance.
@@ -414,6 +531,10 @@ declare class OpenRouter {
   Custom headers to include in the requests.
      */
     readonly headers?: Record<string, string>;
+    /**
+     * Record of provider slugs to API keys for injecting into provider routing.
+     */
+    readonly api_keys?: Record<string, string>;
     /**
      * Creates a new OpenRouter provider instance.
      */
@@ -421,6 +542,11 @@ declare class OpenRouter {
     private get baseConfig();
     chat(modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
     completion(modelId: OpenRouterCompletionModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
+    textEmbeddingModel(modelId: OpenRouterEmbeddingModelId, settings?: OpenRouterEmbeddingSettings): OpenRouterEmbeddingModel;
+    /**
+     * @deprecated Use textEmbeddingModel instead
+     */
+    embedding(modelId: OpenRouterEmbeddingModelId, settings?: OpenRouterEmbeddingSettings): OpenRouterEmbeddingModel;
 }
 
-export { OpenRouter, type OpenRouterCompletionSettings, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, createOpenRouter, openrouter };
+export { OpenRouter, type OpenRouterCompletionSettings, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, createOpenRouter, openrouter };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Content, LanguageModelV2FinishReason, LanguageModelV2Usage, LanguageModelV2CallWarning, LanguageModelV2ResponseMetadata, SharedV2Headers, LanguageModelV2StreamPart, ProviderV2 } from '@ai-sdk/provider';
+import { LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Content, LanguageModelV2FinishReason, LanguageModelV2Usage, LanguageModelV2CallWarning, LanguageModelV2ResponseMetadata, SharedV2Headers, LanguageModelV2StreamPart, EmbeddingModelV2, SharedV2ProviderMetadata, ProviderV2 } from '@ai-sdk/provider';
 export { LanguageModelV2, LanguageModelV2Prompt } from '@ai-sdk/provider';
 import * as models from '@openrouter/sdk/models';
 import { z } from 'zod/v4';
@@ -70,6 +70,14 @@ type OpenRouterChatSettings = {
          * Custom search prompt to guide the search query
          */
         search_prompt?: string;
+        /**
+         * Search engine to use for web search
+         * - "native": Use provider's built-in web search
+         * - "exa": Use Exa's search API
+         * - undefined: Native if supported, otherwise Exa
+         * @see https://openrouter.ai/docs/features/web-search
+         */
+        engine?: models.Engine;
     };
     /**
      * Debug options for troubleshooting API requests.
@@ -130,6 +138,63 @@ type OpenRouterChatSettings = {
             audio?: number | string;
             request?: number | string;
         };
+        /**
+         * Whether to restrict routing to only ZDR (Zero Data Retention) endpoints.
+         * When true, only endpoints that do not retain prompts will be used.
+         */
+        zdr?: boolean;
+    };
+} & OpenRouterSharedSettings;
+
+type OpenRouterEmbeddingModelId = string;
+type OpenRouterEmbeddingSettings = {
+    /**
+     * A unique identifier representing your end-user, which can help OpenRouter to
+     * monitor and detect abuse.
+     */
+    user?: string;
+    /**
+     * Provider routing preferences to control request routing behavior
+     */
+    provider?: {
+        /**
+         * List of provider slugs to try in order (e.g. ["openai", "voyageai"])
+         */
+        order?: string[];
+        /**
+         * Whether to allow backup providers when primary is unavailable (default: true)
+         */
+        allow_fallbacks?: boolean;
+        /**
+         * Only use providers that support all parameters in your request (default: false)
+         */
+        require_parameters?: boolean;
+        /**
+         * Control whether to use providers that may store data
+         */
+        data_collection?: 'allow' | 'deny';
+        /**
+         * List of provider slugs to allow for this request
+         */
+        only?: string[];
+        /**
+         * List of provider slugs to skip for this request
+         */
+        ignore?: string[];
+        /**
+         * Sort providers by price, throughput, or latency
+         */
+        sort?: 'price' | 'throughput' | 'latency';
+        /**
+         * Maximum pricing you want to pay for this request
+         */
+        max_price?: {
+            prompt?: number | string;
+            completion?: number | string;
+            image?: number | string;
+            audio?: number | string;
+            request?: number | string;
+        };
     };
 } & OpenRouterSharedSettings;
 
@@ -277,6 +342,7 @@ declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
     readonly provider = "openrouter";
     readonly defaultObjectGenerationMode: "tool";
     readonly modelId: OpenRouterChatModelId;
+    readonly supportsImageUrls = true;
     readonly supportedUrls: Record<string, RegExp[]>;
     readonly settings: OpenRouterChatSettings;
     private readonly config;
@@ -330,6 +396,7 @@ declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
     readonly specificationVersion: "v2";
     readonly provider = "openrouter";
     readonly modelId: OpenRouterCompletionModelId;
+    readonly supportsImageUrls = true;
     readonly supportedUrls: Record<string, RegExp[]>;
     readonly defaultObjectGenerationMode: undefined;
     readonly settings: OpenRouterCompletionSettings;
@@ -340,6 +407,42 @@ declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
     doStream(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
 }
 
+type OpenRouterEmbeddingConfig = {
+    provider: string;
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: typeof fetch;
+    extraBody?: Record<string, unknown>;
+};
+declare class OpenRouterEmbeddingModel implements EmbeddingModelV2<string> {
+    readonly specificationVersion: "v2";
+    readonly provider = "openrouter";
+    readonly modelId: OpenRouterEmbeddingModelId;
+    readonly settings: OpenRouterEmbeddingSettings;
+    readonly maxEmbeddingsPerCall: undefined;
+    readonly supportsParallelCalls = true;
+    private readonly config;
+    constructor(modelId: OpenRouterEmbeddingModelId, settings: OpenRouterEmbeddingSettings, config: OpenRouterEmbeddingConfig);
+    doEmbed(options: {
+        values: Array<string>;
+        abortSignal?: AbortSignal;
+        headers?: Record<string, string | undefined>;
+    }): Promise<{
+        embeddings: Array<Array<number>>;
+        usage?: {
+            tokens: number;
+        };
+        providerMetadata?: SharedV2ProviderMetadata;
+        response?: {
+            headers?: SharedV2Headers;
+            body?: unknown;
+        };
+    }>;
+}
+
 interface OpenRouterProvider extends ProviderV2 {
     (modelId: OpenRouterChatModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
     (modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
@@ -353,6 +456,15 @@ interface OpenRouterProvider extends ProviderV2 {
   Creates an OpenRouter completion model for text generation.
      */
     completion(modelId: OpenRouterCompletionModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
+    /**
+  Creates an OpenRouter text embedding model. (AI SDK v5)
+     */
+    textEmbeddingModel(modelId: OpenRouterEmbeddingModelId, settings?: OpenRouterEmbeddingSettings): OpenRouterEmbeddingModel;
+    /**
+  Creates an OpenRouter text embedding model. (AI SDK v4 - deprecated, use textEmbeddingModel instead)
+  @deprecated Use textEmbeddingModel instead
+     */
+    embedding(modelId: OpenRouterEmbeddingModelId, settings?: OpenRouterEmbeddingSettings): OpenRouterEmbeddingModel;
 }
 interface OpenRouterProviderSettings {
     /**
@@ -386,6 +498,11 @@ interface OpenRouterProviderSettings {
   A JSON object to send as the request body to access OpenRouter features & upstream provider features.
     */
     extraBody?: Record<string, unknown>;
+    /**
+     * Record of provider slugs to API keys for injecting into provider routing.
+     * Maps provider slugs (e.g. "anthropic", "openai") to their respective API keys.
+     */
+    api_keys?: Record<string, string>;
 }
 /**
 Create an OpenRouter provider instance.
@@ -414,6 +531,10 @@ declare class OpenRouter {
   Custom headers to include in the requests.
      */
     readonly headers?: Record<string, string>;
+    /**
+     * Record of provider slugs to API keys for injecting into provider routing.
+     */
+    readonly api_keys?: Record<string, string>;
     /**
      * Creates a new OpenRouter provider instance.
      */
@@ -421,6 +542,11 @@ declare class OpenRouter {
     private get baseConfig();
     chat(modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
     completion(modelId: OpenRouterCompletionModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
+    textEmbeddingModel(modelId: OpenRouterEmbeddingModelId, settings?: OpenRouterEmbeddingSettings): OpenRouterEmbeddingModel;
+    /**
+     * @deprecated Use textEmbeddingModel instead
+     */
+    embedding(modelId: OpenRouterEmbeddingModelId, settings?: OpenRouterEmbeddingSettings): OpenRouterEmbeddingModel;
 }
 
-export { OpenRouter, type OpenRouterCompletionSettings, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, createOpenRouter, openrouter };
+export { OpenRouter, type OpenRouterCompletionSettings, type OpenRouterEmbeddingModelId, type OpenRouterEmbeddingSettings, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, createOpenRouter, openrouter };