@openrouter/ai-sdk-provider 1.2.8 → 1.4.0

package/dist/internal/index.d.mts

@@ -91,7 +91,7 @@ type OpenRouterUsageAccounting = {
     };
     totalTokens: number;
     cost?: number;
-    costDetails: {
+    costDetails?: {
         upstreamInferenceCost: number;
     };
 };
@@ -146,6 +146,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;
@@ -224,6 +225,19 @@ type OpenRouterChatSettings = {
          */
         search_prompt?: string;
     };
+    /**
+     * Debug options for troubleshooting API requests.
+     * Only works with streaming requests.
+     * @see https://openrouter.ai/docs/api-reference/debugging
+     */
+    debug?: {
+        /**
+         * When true, echoes back the request body that was sent to the upstream provider.
+         * The debug data will be returned as the first chunk in the stream with a `debug.echo_upstream_body` field.
+         * Sensitive data like user IDs and base64 content will be redacted.
+         */
+        echo_upstream_body?: boolean;
+    };
     /**
      * Provider routing preferences to control request routing behavior
      */
@@ -259,7 +273,7 @@ type OpenRouterChatSettings = {
         /**
          * Sort providers by price, throughput, or latency
          */
-        sort?: models.Sort;
+        sort?: models.ProviderSort;
         /**
          * Maximum pricing you want to pay for this request
          */
@@ -289,6 +303,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;

package/dist/internal/index.d.ts

@@ -91,7 +91,7 @@ type OpenRouterUsageAccounting = {
     };
     totalTokens: number;
     cost?: number;
-    costDetails: {
+    costDetails?: {
         upstreamInferenceCost: number;
     };
 };
@@ -146,6 +146,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;
@@ -224,6 +225,19 @@ type OpenRouterChatSettings = {
          */
         search_prompt?: string;
     };
+    /**
+     * Debug options for troubleshooting API requests.
+     * Only works with streaming requests.
+     * @see https://openrouter.ai/docs/api-reference/debugging
+     */
+    debug?: {
+        /**
+         * When true, echoes back the request body that was sent to the upstream provider.
+         * The debug data will be returned as the first chunk in the stream with a `debug.echo_upstream_body` field.
+         * Sensitive data like user IDs and base64 content will be redacted.
+         */
+        echo_upstream_body?: boolean;
+    };
     /**
      * Provider routing preferences to control request routing behavior
      */
@@ -259,7 +273,7 @@ type OpenRouterChatSettings = {
         /**
          * Sort providers by price, throughput, or latency
          */
-        sort?: models.Sort;
+        sort?: models.ProviderSort;
         /**
          * Maximum pricing you want to pay for this request
          */
@@ -289,6 +303,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;

package/dist/internal/index.js

@@ -968,9 +968,23 @@ var openrouterFailedResponseHandler = createJsonErrorResponseHandler({
 
 // src/schemas/provider-metadata.ts
 var import_v43 = require("zod/v4");
+var FileAnnotationSchema = import_v43.z.object({
+  type: import_v43.z.literal("file"),
+  file: import_v43.z.object({
+    hash: import_v43.z.string(),
+    name: import_v43.z.string(),
+    content: import_v43.z.array(
+      import_v43.z.object({
+        type: import_v43.z.string(),
+        text: import_v43.z.string().optional()
+      }).passthrough()
+    ).optional()
+  }).passthrough()
+});
 var OpenRouterProviderMetadataSchema = import_v43.z.object({
   provider: import_v43.z.string(),
   reasoning_details: import_v43.z.array(ReasoningDetailUnionSchema).optional(),
+  annotations: import_v43.z.array(FileAnnotationSchema).optional(),
   usage: import_v43.z.object({
     promptTokens: import_v43.z.number(),
     promptTokensDetails: import_v43.z.object({
@@ -984,12 +998,13 @@ var OpenRouterProviderMetadataSchema = import_v43.z.object({
     cost: import_v43.z.number().optional(),
     costDetails: import_v43.z.object({
       upstreamInferenceCost: import_v43.z.number()
-    }).passthrough()
+    }).passthrough().optional()
   }).passthrough()
 }).passthrough();
 var OpenRouterProviderOptionsSchema = import_v43.z.object({
   openrouter: import_v43.z.object({
-    reasoning_details: import_v43.z.array(ReasoningDetailUnionSchema).optional()
+    reasoning_details: import_v43.z.array(ReasoningDetailUnionSchema).optional(),
+    annotations: import_v43.z.array(FileAnnotationSchema).optional()
   }).optional()
 }).optional();
 
@@ -1103,9 +1118,8 @@ function getCacheControl(providerMetadata) {
   return (_c = (_b = (_a15 = openrouter == null ? void 0 : openrouter.cacheControl) != null ? _a15 : openrouter == null ? void 0 : openrouter.cache_control) != null ? _b : anthropic == null ? void 0 : anthropic.cacheControl) != null ? _c : anthropic == null ? void 0 : anthropic.cache_control;
 }
 function convertToOpenRouterChatMessages(prompt) {
-  var _a15, _b, _c, _d, _e, _f;
+  var _a15, _b, _c, _d, _e, _f, _g, _h, _i, _j;
   const messages = [];
-  const accumulatedReasoningDetails = [];
   for (const { role, content, providerOptions } of prompt) {
     switch (role) {
       case "system": {
@@ -1135,7 +1149,7 @@ function convertToOpenRouterChatMessages(prompt) {
         const messageCacheControl = getCacheControl(providerOptions);
         const contentParts = content.map(
           (part) => {
-            var _a16, _b2, _c2, _d2, _e2, _f2, _g;
+            var _a16, _b2, _c2, _d2, _e2, _f2, _g2;
             const cacheControl = (_a16 = getCacheControl(part.providerOptions)) != null ? _a16 : messageCacheControl;
             switch (part.type) {
               case "text":
@@ -1168,7 +1182,7 @@ function convertToOpenRouterChatMessages(prompt) {
                   };
                 }
                 const fileName = String(
-                  (_g = (_f2 = (_e2 = (_d2 = part.providerOptions) == null ? void 0 : _d2.openrouter) == null ? void 0 : _e2.filename) != null ? _f2 : part.filename) != null ? _g : ""
+                  (_g2 = (_f2 = (_e2 = (_d2 = part.providerOptions) == null ? void 0 : _d2.openrouter) == null ? void 0 : _e2.filename) != null ? _f2 : part.filename) != null ? _g2 : ""
                 );
                 const fileData = getFileUrl({
                   part,
@@ -1215,6 +1229,7 @@ function convertToOpenRouterChatMessages(prompt) {
         let text = "";
         let reasoning = "";
         const toolCalls = [];
+        const accumulatedReasoningDetails = [];
         for (const part of content) {
           switch (part.type) {
             case "text": {
@@ -1240,6 +1255,12 @@ function convertToOpenRouterChatMessages(prompt) {
             }
             case "reasoning": {
               reasoning += part.text;
+              const parsedPartProviderOptions = OpenRouterProviderOptionsSchema.safeParse(part.providerOptions);
+              if (parsedPartProviderOptions.success && ((_e = (_d = parsedPartProviderOptions.data) == null ? void 0 : _d.openrouter) == null ? void 0 : _e.reasoning_details)) {
+                accumulatedReasoningDetails.push(
+                  ...parsedPartProviderOptions.data.openrouter.reasoning_details
+                );
+              }
               break;
             }
             case "file":
@@ -1250,7 +1271,8 @@ function convertToOpenRouterChatMessages(prompt) {
           }
         }
         const parsedProviderOptions = OpenRouterProviderOptionsSchema.safeParse(providerOptions);
-        const messageReasoningDetails = parsedProviderOptions.success ? (_e = (_d = parsedProviderOptions.data) == null ? void 0 : _d.openrouter) == null ? void 0 : _e.reasoning_details : void 0;
+        const messageReasoningDetails = parsedProviderOptions.success ? (_g = (_f = parsedProviderOptions.data) == null ? void 0 : _f.openrouter) == null ? void 0 : _g.reasoning_details : void 0;
+        const messageAnnotations = parsedProviderOptions.success ? (_i = (_h = parsedProviderOptions.data) == null ? void 0 : _h.openrouter) == null ? void 0 : _i.annotations : void 0;
         const finalReasoningDetails = messageReasoningDetails && Array.isArray(messageReasoningDetails) && messageReasoningDetails.length > 0 ? messageReasoningDetails : accumulatedReasoningDetails.length > 0 ? accumulatedReasoningDetails : void 0;
         messages.push({
           role: "assistant",
@@ -1258,6 +1280,7 @@ function convertToOpenRouterChatMessages(prompt) {
           tool_calls: toolCalls.length > 0 ? toolCalls : void 0,
           reasoning: reasoning || void 0,
           reasoning_details: finalReasoningDetails,
+          annotations: messageAnnotations,
           cache_control: getCacheControl(providerOptions)
         });
         break;
@@ -1269,7 +1292,7 @@ function convertToOpenRouterChatMessages(prompt) {
             role: "tool",
             tool_call_id: toolResponse.toolCallId,
             content: content2,
-            cache_control: (_f = getCacheControl(providerOptions)) != null ? _f : getCacheControl(toolResponse.providerOptions)
+            cache_control: (_j = getCacheControl(providerOptions)) != null ? _j : getCacheControl(toolResponse.providerOptions)
           });
         }
         break;
@@ -1528,6 +1551,7 @@ var OpenRouterChatLanguageModel = class {
     this.specificationVersion = "v2";
     this.provider = "openrouter";
     this.defaultObjectGenerationMode = "tool";
+    this.supportsImageUrls = true;
     this.supportedUrls = {
       "image/*": [
         /^data:image\/[a-zA-Z]+;base64,/,
@@ -1585,7 +1609,9 @@ var OpenRouterChatLanguageModel = class {
       plugins: this.settings.plugins,
       web_search_options: this.settings.web_search_options,
       // Provider routing settings:
-      provider: this.settings.provider
+      provider: this.settings.provider,
+      // Debug settings:
+      debug: this.settings.debug
     }, this.config.extraBody), this.settings.extraBody);
     if ((responseFormat == null ? void 0 : responseFormat.type) === "json" && responseFormat.schema != null) {
       return __spreadProps(__spreadValues({}, baseArgs), {
@@ -1620,7 +1646,7 @@ var OpenRouterChatLanguageModel = class {
     return baseArgs;
   }
   async doGenerate(options) {
-    var _a15, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y;
+    var _a15, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w;
     const providerOptions = options.providerOptions || {};
     const openrouterOptions = providerOptions.openrouter || {};
     const args = __spreadValues(__spreadValues({}, this.getArgs(options)), openrouterOptions);
@@ -1778,6 +1804,9 @@ var OpenRouterChatLanguageModel = class {
         }
       }
     }
+    const fileAnnotations = (_k = choice.message.annotations) == null ? void 0 : _k.filter(
+      (a) => a.type === "file"
+    );
     return {
       content,
       finishReason: mapOpenRouterFinishReason(choice.finish_reason),
@@ -1785,23 +1814,27 @@ var OpenRouterChatLanguageModel = class {
       warnings: [],
       providerMetadata: {
         openrouter: OpenRouterProviderMetadataSchema.parse({
-          provider: (_k = response.provider) != null ? _k : "",
-          reasoning_details: (_l = choice.message.reasoning_details) != null ? _l : [],
-          usage: {
-            promptTokens: (_m = usageInfo.inputTokens) != null ? _m : 0,
-            completionTokens: (_n = usageInfo.outputTokens) != null ? _n : 0,
-            totalTokens: (_o = usageInfo.totalTokens) != null ? _o : 0,
-            cost: (_p = response.usage) == null ? void 0 : _p.cost,
+          provider: (_l = response.provider) != null ? _l : "",
+          reasoning_details: (_m = choice.message.reasoning_details) != null ? _m : [],
+          annotations: fileAnnotations && fileAnnotations.length > 0 ? fileAnnotations : void 0,
+          usage: __spreadValues(__spreadValues(__spreadValues({
+            promptTokens: (_n = usageInfo.inputTokens) != null ? _n : 0,
+            completionTokens: (_o = usageInfo.outputTokens) != null ? _o : 0,
+            totalTokens: (_p = usageInfo.totalTokens) != null ? _p : 0,
+            cost: (_q = response.usage) == null ? void 0 : _q.cost
+          }, ((_s = (_r = response.usage) == null ? void 0 : _r.prompt_tokens_details) == null ? void 0 : _s.cached_tokens) != null ? {
             promptTokensDetails: {
-              cachedTokens: (_s = (_r = (_q = response.usage) == null ? void 0 : _q.prompt_tokens_details) == null ? void 0 : _r.cached_tokens) != null ? _s : 0
-            },
+              cachedTokens: response.usage.prompt_tokens_details.cached_tokens
+            }
+          } : {}), ((_u = (_t = response.usage) == null ? void 0 : _t.completion_tokens_details) == null ? void 0 : _u.reasoning_tokens) != null ? {
             completionTokensDetails: {
-              reasoningTokens: (_v = (_u = (_t = response.usage) == null ? void 0 : _t.completion_tokens_details) == null ? void 0 : _u.reasoning_tokens) != null ? _v : 0
-            },
+              reasoningTokens: response.usage.completion_tokens_details.reasoning_tokens
+            }
+          } : {}), ((_w = (_v = response.usage) == null ? void 0 : _v.cost_details) == null ? void 0 : _w.upstream_inference_cost) != null ? {
             costDetails: {
-              upstreamInferenceCost: (_y = (_x = (_w = response.usage) == null ? void 0 : _w.cost_details) == null ? void 0 : _x.upstream_inference_cost) != null ? _y : 0
+              upstreamInferenceCost: response.usage.cost_details.upstream_inference_cost
             }
-          }
+          } : {})
         })
       },
       request: { body: args },
@@ -1858,7 +1891,7 @@ var OpenRouterChatLanguageModel = class {
       stream: response.pipeThrough(
         new TransformStream({
           transform(chunk, controller) {
-            var _a16, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
+            var _a16, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o;
             if (!chunk.success) {
               finishReason = "error";
               controller.enqueue({ type: "error", error: chunk.error });
@@ -1908,6 +1941,12 @@ var OpenRouterChatLanguageModel = class {
               }
               openrouterUsage.cost = value.usage.cost;
               openrouterUsage.totalTokens = value.usage.total_tokens;
+              const upstreamInferenceCost = (_c = value.usage.cost_details) == null ? void 0 : _c.upstream_inference_cost;
+              if (upstreamInferenceCost != null) {
+                openrouterUsage.costDetails = {
+                  upstreamInferenceCost
+                };
+              }
             }
             const choice = value.choices[0];
             if ((choice == null ? void 0 : choice.finish_reason) != null) {
@@ -1917,16 +1956,18 @@ var OpenRouterChatLanguageModel = class {
               return;
             }
             const delta = choice.delta;
-            const emitReasoningChunk = (chunkText) => {
+            const emitReasoningChunk = (chunkText, providerMetadata) => {
               if (!reasoningStarted) {
                 reasoningId = openrouterResponseId || generateId();
                 controller.enqueue({
+                  providerMetadata,
                   type: "reasoning-start",
                   id: reasoningId
                 });
                 reasoningStarted = true;
               }
               controller.enqueue({
+                providerMetadata,
                 type: "reasoning-delta",
                 delta: chunkText,
                 id: reasoningId || generateId()
@@ -1947,23 +1988,28 @@ var OpenRouterChatLanguageModel = class {
                   accumulatedReasoningDetails.push(detail);
                 }
               }
+              const reasoningMetadata = {
+                openrouter: {
+                  reasoning_details: delta.reasoning_details
+                }
+              };
               for (const detail of delta.reasoning_details) {
                 switch (detail.type) {
                   case "reasoning.text" /* Text */: {
                     if (detail.text) {
-                      emitReasoningChunk(detail.text);
+                      emitReasoningChunk(detail.text, reasoningMetadata);
                     }
                     break;
                   }
                   case "reasoning.encrypted" /* Encrypted */: {
                     if (detail.data) {
-                      emitReasoningChunk("[REDACTED]");
+                      emitReasoningChunk("[REDACTED]", reasoningMetadata);
                     }
                     break;
                   }
                   case "reasoning.summary" /* Summary */: {
                     if (detail.summary) {
-                      emitReasoningChunk(detail.summary);
+                      emitReasoningChunk(detail.summary, reasoningMetadata);
                     }
                     break;
                   }
@@ -2018,7 +2064,7 @@ var OpenRouterChatLanguageModel = class {
             }
             if (delta.tool_calls != null) {
               for (const toolCallDelta of delta.tool_calls) {
-                const index = (_c = toolCallDelta.index) != null ? _c : toolCalls.length - 1;
+                const index = (_d = toolCallDelta.index) != null ? _d : toolCalls.length - 1;
                 if (toolCalls[index] == null) {
                   if (toolCallDelta.type !== "function") {
                     throw new InvalidResponseDataError({
@@ -2032,7 +2078,7 @@ var OpenRouterChatLanguageModel = class {
                       message: `Expected 'id' to be a string.`
                     });
                   }
-                  if (((_d = toolCallDelta.function) == null ? void 0 : _d.name) == null) {
+                  if (((_e = toolCallDelta.function) == null ? void 0 : _e.name) == null) {
                     throw new InvalidResponseDataError({
                       data: toolCallDelta,
                       message: `Expected 'function.name' to be a string.`
@@ -2043,7 +2089,7 @@ var OpenRouterChatLanguageModel = class {
                     type: "function",
                     function: {
                       name: toolCallDelta.function.name,
-                      arguments: (_e = toolCallDelta.function.arguments) != null ? _e : ""
+                      arguments: (_f = toolCallDelta.function.arguments) != null ? _f : ""
                     },
                     inputStarted: false,
                     sent: false
@@ -2055,7 +2101,7 @@ var OpenRouterChatLanguageModel = class {
                       message: `Tool call at index ${index} is missing after creation.`
                     });
                   }
-                  if (((_f = toolCall2.function) == null ? void 0 : _f.name) != null && ((_g = toolCall2.function) == null ? void 0 : _g.arguments) != null && isParsableJson(toolCall2.function.arguments)) {
+                  if (((_g = toolCall2.function) == null ? void 0 : _g.name) != null && ((_h = toolCall2.function) == null ? void 0 : _h.arguments) != null && isParsableJson(toolCall2.function.arguments)) {
                     toolCall2.inputStarted = true;
                     controller.enqueue({
                       type: "tool-input-start",
@@ -2105,18 +2151,18 @@ var OpenRouterChatLanguageModel = class {
                     toolName: toolCall.function.name
                   });
                 }
-                if (((_h = toolCallDelta.function) == null ? void 0 : _h.arguments) != null) {
-                  toolCall.function.arguments += (_j = (_i = toolCallDelta.function) == null ? void 0 : _i.arguments) != null ? _j : "";
+                if (((_i = toolCallDelta.function) == null ? void 0 : _i.arguments) != null) {
+                  toolCall.function.arguments += (_k = (_j = toolCallDelta.function) == null ? void 0 : _j.arguments) != null ? _k : "";
                 }
                 controller.enqueue({
                   type: "tool-input-delta",
                   id: toolCall.id,
-                  delta: (_k = toolCallDelta.function.arguments) != null ? _k : ""
+                  delta: (_l = toolCallDelta.function.arguments) != null ? _l : ""
                 });
-                if (((_l = toolCall.function) == null ? void 0 : _l.name) != null && ((_m = toolCall.function) == null ? void 0 : _m.arguments) != null && isParsableJson(toolCall.function.arguments)) {
+                if (((_m = toolCall.function) == null ? void 0 : _m.name) != null && ((_n = toolCall.function) == null ? void 0 : _n.arguments) != null && isParsableJson(toolCall.function.arguments)) {
                   controller.enqueue({
                     type: "tool-call",
-                    toolCallId: (_n = toolCall.id) != null ? _n : generateId(),
+                    toolCallId: (_o = toolCall.id) != null ? _o : generateId(),
                     toolName: toolCall.function.name,
                     input: toolCall.function.arguments,
                     providerMetadata: {
@@ -2332,7 +2378,10 @@ var OpenRouterCompletionChunkSchema = import_v47.z.union([
         reasoning_tokens: import_v47.z.number()
       }).passthrough().nullish(),
       total_tokens: import_v47.z.number(),
-      cost: import_v47.z.number().optional()
+      cost: import_v47.z.number().optional(),
+      cost_details: import_v47.z.object({
+        upstream_inference_cost: import_v47.z.number().nullish()
+      }).passthrough().nullish()
     }).passthrough().nullish()
   }).passthrough(),
   OpenRouterErrorResponseSchema
@@ -2343,6 +2392,7 @@ var OpenRouterCompletionLanguageModel = class {
   constructor(modelId, settings, config) {
     this.specificationVersion = "v2";
     this.provider = "openrouter";
+    this.supportsImageUrls = true;
     this.supportedUrls = {
       "image/*": [
         /^data:image\/[a-zA-Z]+;base64,/,
@@ -2505,7 +2555,7 @@ var OpenRouterCompletionLanguageModel = class {
       stream: response.pipeThrough(
         new TransformStream({
           transform(chunk, controller) {
-            var _a15, _b;
+            var _a15, _b, _c;
             if (!chunk.success) {
               finishReason = "error";
               controller.enqueue({ type: "error", error: chunk.error });
@@ -2539,6 +2589,12 @@ var OpenRouterCompletionLanguageModel = class {
               }
               openrouterUsage.cost = value.usage.cost;
               openrouterUsage.totalTokens = value.usage.total_tokens;
+              const upstreamInferenceCost = (_c = value.usage.cost_details) == null ? void 0 : _c.upstream_inference_cost;
+              if (upstreamInferenceCost != null) {
+                openrouterUsage.costDetails = {
+                  upstreamInferenceCost
+                };
+              }
             }
             const choice = value.choices[0];
             if ((choice == null ? void 0 : choice.finish_reason) != null) {