@openrouter/ai-sdk-provider 0.4.6 → 0.6.0

package/README.md

@@ -37,7 +37,7 @@ const { text } = await generateText({
 
 ## Supported models
 
-This list is not a definitive list of models supported by OpenRouter, as it constantly changes as we add new models (and deprecate old ones) to our system.  
+This list is not a definitive list of models supported by OpenRouter, as it constantly changes as we add new models (and deprecate old ones) to our system.
 You can find the latest list of models supported by OpenRouter [here](https://openrouter.ai/models).
 
 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.)
@@ -147,10 +147,37 @@ await streamText({
         },
         {
           type: 'text',
-          text: 'Who're the speakers?',
+          text: 'List the speakers?',
         },
       ],
     },
   ],
 });
 ```
+
+## Use Cases
+
+### Usage Accounting
+
+The provider supports [OpenRouter usage accounting](https://openrouter.ai/docs/use-cases/usage-accounting), which allows you to track token usage details directly in your API responses, without making additional API calls.
+
+```typescript
+// Enable usage accounting
+const model = openrouter('openai/gpt-3.5-turbo', {
+  usage: {
+    include: true,
+  }
+});
+
+// Access usage accounting data
+const result = await generateText({
+  model,
+  prompt: 'Hello, how are you today?',
+});
+
+// Provider-specific usage details (available in providerMetadata)
+if (result.providerMetadata?.openrouter?.usage) {
+  console.log('Cost:', result.providerMetadata.openrouter.usage.cost);
+  console.log('Total Tokens:', result.providerMetadata.openrouter.usage.totalTokens);
+}
+```

package/dist/index.d.mts

@@ -27,7 +27,33 @@ type OpenRouterSharedSettings = OpenRouterProviderOptions & {
      * @deprecated use `reasoning` instead
      */
     includeReasoning?: boolean;
-    extraBody?: Record<string, any>;
+    extraBody?: Record<string, unknown>;
+    /**
+     * Enable usage accounting to get detailed token usage information.
+     * https://openrouter.ai/docs/use-cases/usage-accounting
+     */
+    usage?: {
+        /**
+         * When true, includes token usage information in the response.
+         */
+        include: boolean;
+    };
+};
+/**
+ * Usage accounting response
+ * @see https://openrouter.ai/docs/use-cases/usage-accounting
+ */
+type OpenRouterUsageAccounting = {
+    promptTokens: number;
+    promptTokensDetails?: {
+        cachedTokens: number;
+    };
+    completionTokens: number;
+    completionTokensDetails?: {
+        reasoningTokens: number;
+    };
+    totalTokens: number;
+    cost?: number;
 };
 
 type OpenRouterChatModelId = string;
@@ -236,4 +262,4 @@ declare class OpenRouter {
     completion(modelId: OpenRouterCompletionModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
 }
 
-export { OpenRouter, type OpenRouterCompletionSettings, type OpenRouterLanguageModel, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, createOpenRouter, openrouter };
+export { OpenRouter, type OpenRouterCompletionSettings, type OpenRouterLanguageModel, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, createOpenRouter, openrouter };

package/dist/index.d.ts

@@ -27,7 +27,33 @@ type OpenRouterSharedSettings = OpenRouterProviderOptions & {
      * @deprecated use `reasoning` instead
      */
     includeReasoning?: boolean;
-    extraBody?: Record<string, any>;
+    extraBody?: Record<string, unknown>;
+    /**
+     * Enable usage accounting to get detailed token usage information.
+     * https://openrouter.ai/docs/use-cases/usage-accounting
+     */
+    usage?: {
+        /**
+         * When true, includes token usage information in the response.
+         */
+        include: boolean;
+    };
+};
+/**
+ * Usage accounting response
+ * @see https://openrouter.ai/docs/use-cases/usage-accounting
+ */
+type OpenRouterUsageAccounting = {
+    promptTokens: number;
+    promptTokensDetails?: {
+        cachedTokens: number;
+    };
+    completionTokens: number;
+    completionTokensDetails?: {
+        reasoningTokens: number;
+    };
+    totalTokens: number;
+    cost?: number;
 };
 
 type OpenRouterChatModelId = string;
@@ -236,4 +262,4 @@ declare class OpenRouter {
     completion(modelId: OpenRouterCompletionModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
 }
 
-export { OpenRouter, type OpenRouterCompletionSettings, type OpenRouterLanguageModel, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, createOpenRouter, openrouter };
+export { OpenRouter, type OpenRouterCompletionSettings, type OpenRouterLanguageModel, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, createOpenRouter, openrouter };

package/dist/index.js

@@ -96,14 +96,15 @@ function convertToOpenRouterChatMessages(prompt) {
         const messageCacheControl = getCacheControl(providerMetadata);
         const contentParts = content.map(
           (part) => {
-            var _a2, _b2, _c2, _d, _e, _f;
+            var _a2, _b2, _c2, _d;
+            const cacheControl = (_a2 = getCacheControl(part.providerMetadata)) != null ? _a2 : messageCacheControl;
             switch (part.type) {
               case "text":
                 return {
                   type: "text",
                   text: part.text,
                   // For text parts, only use part-specific cache control
-                  cache_control: (_a2 = getCacheControl(part.providerMetadata)) != null ? _a2 : messageCacheControl
+                  cache_control: cacheControl
                 };
               case "image":
                 return {
@@ -114,18 +115,18 @@ function convertToOpenRouterChatMessages(prompt) {
                     )}`
                   },
                   // For image parts, use part-specific or message-level cache control
-                  cache_control: (_c2 = getCacheControl(part.providerMetadata)) != null ? _c2 : messageCacheControl
+                  cache_control: cacheControl
                 };
               case "file":
                 return {
                   type: "file",
                   file: {
                     filename: String(
-                      (_e = (_d = part.providerMetadata) == null ? void 0 : _d.openrouter) == null ? void 0 : _e.filename
+                      (_d = (_c2 = part.providerMetadata) == null ? void 0 : _c2.openrouter) == null ? void 0 : _d.filename
                     ),
                     file_data: part.data instanceof Uint8Array ? `data:${part.mimeType};base64,${(0, import_provider_utils.convertUint8ArrayToBase64)(part.data)}` : `data:${part.mimeType};base64,${part.data}`
                   },
-                  cache_control: (_f = getCacheControl(part.providerMetadata)) != null ? _f : messageCacheControl
+                  cache_control: cacheControl
                 };
               default: {
                 const _exhaustiveCheck = part;
@@ -162,6 +163,7 @@ function convertToOpenRouterChatMessages(prompt) {
               });
               break;
             }
+            case "file":
             // TODO: Handle reasoning and redacted-reasoning
             case "reasoning":
             case "redacted-reasoning":
@@ -277,7 +279,7 @@ var OpenRouterChatLanguageModel = class {
   }) {
     var _a;
     const type = mode.type;
-    const extraCallingBody = (_a = providerMetadata == null ? void 0 : providerMetadata["openrouter"]) != null ? _a : {};
+    const extraCallingBody = (_a = providerMetadata == null ? void 0 : providerMetadata.openrouter) != null ? _a : {};
     const baseArgs = __spreadValues(__spreadValues(__spreadValues({
       // model id:
       model: this.modelId,
@@ -302,7 +304,8 @@ var OpenRouterChatLanguageModel = class {
       messages: convertToOpenRouterChatMessages(prompt),
       // OpenRouter specific settings:
       include_reasoning: this.settings.includeReasoning,
-      reasoning: this.settings.reasoning
+      reasoning: this.settings.reasoning,
+      usage: this.settings.usage
     }, this.config.extraBody), this.settings.extraBody), extraCallingBody);
     switch (type) {
       case "regular": {
@@ -338,7 +341,7 @@ var OpenRouterChatLanguageModel = class {
     }
   }
   async doGenerate(options) {
-    var _b, _c, _d, _e, _f, _g, _h;
+    var _b, _c, _d, _e, _f, _g, _h, _i, _j;
     const args = this.getArgs(options);
     const { responseHeaders, value: response } = await (0, import_provider_utils3.postJsonToApi)({
       url: this.config.url({
@@ -359,14 +362,39 @@ var OpenRouterChatLanguageModel = class {
     if (!choice) {
       throw new Error("No choice in response");
     }
-    return {
+    const usageInfo = response.usage ? {
+      promptTokens: (_b = response.usage.prompt_tokens) != null ? _b : 0,
+      completionTokens: (_c = response.usage.completion_tokens) != null ? _c : 0
+    } : {
+      promptTokens: 0,
+      completionTokens: 0
+    };
+    const providerMetadata = {};
+    if (response.usage && ((_d = this.settings.usage) == null ? void 0 : _d.include)) {
+      providerMetadata.openrouter = {
+        usage: {
+          promptTokens: response.usage.prompt_tokens,
+          promptTokensDetails: response.usage.prompt_tokens_details ? {
+            cachedTokens: (_e = response.usage.prompt_tokens_details.cached_tokens) != null ? _e : 0
+          } : void 0,
+          completionTokens: response.usage.completion_tokens,
+          completionTokensDetails: response.usage.completion_tokens_details ? {
+            reasoningTokens: (_f = response.usage.completion_tokens_details.reasoning_tokens) != null ? _f : 0
+          } : void 0,
+          cost: response.usage.cost,
+          totalTokens: (_g = response.usage.total_tokens) != null ? _g : 0
+        }
+      };
+    }
+    const hasProviderMetadata = Object.keys(providerMetadata).length > 0;
+    return __spreadValues({
       response: {
         id: response.id,
         modelId: response.model
       },
-      text: (_b = choice.message.content) != null ? _b : void 0,
-      reasoning: (_c = choice.message.reasoning) != null ? _c : void 0,
-      toolCalls: (_d = choice.message.tool_calls) == null ? void 0 : _d.map((toolCall) => {
+      text: (_h = choice.message.content) != null ? _h : void 0,
+      reasoning: (_i = choice.message.reasoning) != null ? _i : void 0,
+      toolCalls: (_j = choice.message.tool_calls) == null ? void 0 : _j.map((toolCall) => {
         var _a2;
         return {
           toolCallType: "function",
@@ -376,17 +404,15 @@ var OpenRouterChatLanguageModel = class {
         };
       }),
       finishReason: mapOpenRouterFinishReason(choice.finish_reason),
-      usage: {
-        promptTokens: (_f = (_e = response.usage) == null ? void 0 : _e.prompt_tokens) != null ? _f : 0,
-        completionTokens: (_h = (_g = response.usage) == null ? void 0 : _g.completion_tokens) != null ? _h : 0
-      },
+      usage: usageInfo,
       rawCall: { rawPrompt, rawSettings },
       rawResponse: { headers: responseHeaders },
       warnings: [],
       logprobs: mapOpenRouterChatLogProbsOutput(choice.logprobs)
-    };
+    }, hasProviderMetadata ? { providerMetadata } : {});
   }
   async doStream(options) {
+    var _a, _c;
     const args = this.getArgs(options);
     const { responseHeaders, value: response } = await (0, import_provider_utils3.postJsonToApi)({
       url: this.config.url({
@@ -397,7 +423,9 @@ var OpenRouterChatLanguageModel = class {
       body: __spreadProps(__spreadValues({}, args), {
         stream: true,
         // only include stream_options when in strict compatibility mode:
-        stream_options: this.config.compatibility === "strict" ? { include_usage: true } : void 0
+        stream_options: this.config.compatibility === "strict" ? __spreadValues({
+          include_usage: true
+        }, ((_a = this.settings.usage) == null ? void 0 : _a.include) ? { include_usage: true } : {}) : void 0
       }),
       failedResponseHandler: openrouterFailedResponseHandler,
       successfulResponseHandler: (0, import_provider_utils3.createEventSourceResponseHandler)(
@@ -406,7 +434,7 @@ var OpenRouterChatLanguageModel = class {
       abortSignal: options.abortSignal,
       fetch: this.config.fetch
     });
-    const _a = args, { messages: rawPrompt } = _a, rawSettings = __objRest(_a, ["messages"]);
+    const _b = args, { messages: rawPrompt } = _b, rawSettings = __objRest(_b, ["messages"]);
     const toolCalls = [];
     let finishReason = "other";
     let usage = {
@@ -414,11 +442,13 @@ var OpenRouterChatLanguageModel = class {
       completionTokens: Number.NaN
     };
     let logprobs;
+    const openrouterUsage = {};
+    const shouldIncludeUsageAccounting = !!((_c = this.settings.usage) == null ? void 0 : _c.include);
     return {
       stream: response.pipeThrough(
         new TransformStream({
           transform(chunk, controller) {
-            var _a2, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l;
+            var _a2, _b2, _c2, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
             if (!chunk.success) {
               finishReason = "error";
               controller.enqueue({ type: "error", error: chunk.error });
@@ -447,6 +477,20 @@ var OpenRouterChatLanguageModel = class {
                 promptTokens: value.usage.prompt_tokens,
                 completionTokens: value.usage.completion_tokens
               };
+              openrouterUsage.promptTokens = value.usage.prompt_tokens;
+              if (value.usage.prompt_tokens_details) {
+                openrouterUsage.promptTokensDetails = {
+                  cachedTokens: (_a2 = value.usage.prompt_tokens_details.cached_tokens) != null ? _a2 : 0
+                };
+              }
+              openrouterUsage.completionTokens = value.usage.completion_tokens;
+              if (value.usage.completion_tokens_details) {
+                openrouterUsage.completionTokensDetails = {
+                  reasoningTokens: (_b2 = value.usage.completion_tokens_details.reasoning_tokens) != null ? _b2 : 0
+                };
+              }
+              openrouterUsage.cost = value.usage.cost;
+              openrouterUsage.totalTokens = value.usage.total_tokens;
             }
             const choice = value.choices[0];
             if ((choice == null ? void 0 : choice.finish_reason) != null) {
@@ -491,7 +535,7 @@ var OpenRouterChatLanguageModel = class {
                       message: `Expected 'id' to be a string.`
                     });
                   }
-                  if (((_a2 = toolCallDelta.function) == null ? void 0 : _a2.name) == null) {
+                  if (((_c2 = toolCallDelta.function) == null ? void 0 : _c2.name) == null) {
                     throw new import_provider.InvalidResponseDataError({
                       data: toolCallDelta,
                       message: `Expected 'function.name' to be a string.`
@@ -502,7 +546,7 @@ var OpenRouterChatLanguageModel = class {
                     type: "function",
                     function: {
                       name: toolCallDelta.function.name,
-                      arguments: (_b = toolCallDelta.function.arguments) != null ? _b : ""
+                      arguments: (_d = toolCallDelta.function.arguments) != null ? _d : ""
                     },
                     sent: false
                   };
@@ -510,7 +554,7 @@ var OpenRouterChatLanguageModel = class {
                   if (toolCall2 == null) {
                     throw new Error("Tool call is missing");
                   }
-                  if (((_c = toolCall2.function) == null ? void 0 : _c.name) != null && ((_d = toolCall2.function) == null ? void 0 : _d.arguments) != null && (0, import_provider_utils3.isParsableJson)(toolCall2.function.arguments)) {
+                  if (((_e = toolCall2.function) == null ? void 0 : _e.name) != null && ((_f = toolCall2.function) == null ? void 0 : _f.arguments) != null && (0, import_provider_utils3.isParsableJson)(toolCall2.function.arguments)) {
                     controller.enqueue({
                       type: "tool-call-delta",
                       toolCallType: "function",
@@ -521,7 +565,7 @@ var OpenRouterChatLanguageModel = class {
                     controller.enqueue({
                       type: "tool-call",
                       toolCallType: "function",
-                      toolCallId: (_e = toolCall2.id) != null ? _e : (0, import_provider_utils3.generateId)(),
+                      toolCallId: (_g = toolCall2.id) != null ? _g : (0, import_provider_utils3.generateId)(),
                       toolName: toolCall2.function.name,
                       args: toolCall2.function.arguments
                     });
@@ -533,21 +577,21 @@ var OpenRouterChatLanguageModel = class {
                 if (toolCall == null) {
                   throw new Error("Tool call is missing");
                 }
-                if (((_f = toolCallDelta.function) == null ? void 0 : _f.arguments) != null) {
-                  toolCall.function.arguments += (_h = (_g = toolCallDelta.function) == null ? void 0 : _g.arguments) != null ? _h : "";
+                if (((_h = toolCallDelta.function) == null ? void 0 : _h.arguments) != null) {
+                  toolCall.function.arguments += (_j = (_i = toolCallDelta.function) == null ? void 0 : _i.arguments) != null ? _j : "";
                 }
                 controller.enqueue({
                   type: "tool-call-delta",
                   toolCallType: "function",
                   toolCallId: toolCall.id,
                   toolName: toolCall.function.name,
-                  argsTextDelta: (_i = toolCallDelta.function.arguments) != null ? _i : ""
+                  argsTextDelta: (_k = toolCallDelta.function.arguments) != null ? _k : ""
                 });
-                if (((_j = toolCall.function) == null ? void 0 : _j.name) != null && ((_k = toolCall.function) == null ? void 0 : _k.arguments) != null && (0, import_provider_utils3.isParsableJson)(toolCall.function.arguments)) {
+                if (((_l = toolCall.function) == null ? void 0 : _l.name) != null && ((_m = toolCall.function) == null ? void 0 : _m.arguments) != null && (0, import_provider_utils3.isParsableJson)(toolCall.function.arguments)) {
                   controller.enqueue({
                     type: "tool-call",
                     toolCallType: "function",
-                    toolCallId: (_l = toolCall.id) != null ? _l : (0, import_provider_utils3.generateId)(),
+                    toolCallId: (_n = toolCall.id) != null ? _n : (0, import_provider_utils3.generateId)(),
                     toolName: toolCall.function.name,
                     args: toolCall.function.arguments
                   });
@@ -573,12 +617,19 @@ var OpenRouterChatLanguageModel = class {
                 }
               }
             }
-            controller.enqueue({
+            const providerMetadata = {};
+            if (shouldIncludeUsageAccounting && (openrouterUsage.totalTokens !== void 0 || openrouterUsage.cost !== void 0 || openrouterUsage.promptTokensDetails !== void 0 || openrouterUsage.completionTokensDetails !== void 0)) {
+              providerMetadata.openrouter = {
+                usage: openrouterUsage
+              };
+            }
+            const hasProviderMetadata = Object.keys(providerMetadata).length > 0 && shouldIncludeUsageAccounting;
+            controller.enqueue(__spreadValues({
               type: "finish",
               finishReason,
               logprobs,
               usage
-            });
+            }, hasProviderMetadata ? { providerMetadata } : {}));
           }
         })
       ),
@@ -593,8 +644,15 @@ var OpenRouterChatCompletionBaseResponseSchema = import_zod2.z.object({
   model: import_zod2.z.string().optional(),
   usage: import_zod2.z.object({
     prompt_tokens: import_zod2.z.number(),
+    prompt_tokens_details: import_zod2.z.object({
+      cached_tokens: import_zod2.z.number()
+    }).optional(),
     completion_tokens: import_zod2.z.number(),
-    total_tokens: import_zod2.z.number()
+    completion_tokens_details: import_zod2.z.object({
+      reasoning_tokens: import_zod2.z.number()
+    }).optional(),
+    total_tokens: import_zod2.z.number(),
+    cost: import_zod2.z.number().optional()
   }).nullish()
 });
 var OpenRouterNonStreamChatCompletionResponseSchema = OpenRouterChatCompletionBaseResponseSchema.extend({
@@ -691,14 +749,13 @@ function prepareToolsAndToolChoice(mode) {
           parameters: tool.parameters
         }
       };
-    } else {
-      return {
-        type: "function",
-        function: {
-          name: tool.name
-        }
-      };
     }
+    return {
+      type: "function",
+      function: {
+        name: tool.name
+      }
+    };
   });
   const toolChoice = mode.toolChoice;
   if (toolChoice == null) {
@@ -809,6 +866,11 @@ ${userMessage}
                 functionality: "redacted reasoning messages"
               });
             }
+            case "file": {
+              throw new import_provider2.UnsupportedFunctionalityError({
+                functionality: "file attachments"
+              });
+            }
             default: {
               const _exhaustiveCheck = part;
               throw new Error(
@@ -887,7 +949,7 @@ var OpenRouterCompletionLanguageModel = class {
   }) {
     var _a, _b;
     const type = mode.type;
-    const extraCallingBody = (_a = providerMetadata == null ? void 0 : providerMetadata["openrouter"]) != null ? _a : {};
+    const extraCallingBody = (_a = providerMetadata == null ? void 0 : providerMetadata.openrouter) != null ? _a : {};
     const { prompt: completionPrompt } = convertToOpenRouterCompletionPrompt({
       prompt,
       inputFormat
@@ -1184,9 +1246,7 @@ function createOpenRouter(options = {}) {
     }
     return createChatModel(modelId, settings);
   };
-  const provider = function(modelId, settings) {
-    return createLanguageModel(modelId, settings);
-  };
+  const provider = (modelId, settings) => createLanguageModel(modelId, settings);
   provider.languageModel = createLanguageModel;
   provider.chat = createChatModel;
   provider.completion = createCompletionModel;