Add support for OpenRouter as an LLM provider.

elskito · elskito · commit d0ed6f18a1f0 · 2025-07-24T10:21:53.000+02:00
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ Snap a photo of any receipt or upload an invoice PDF, and TaxHacker will automat
 - **Auto-categorization**: Transactions are automatically sorted into relevant categories based on their content
 - **Item splitting**: Extract individual items from invoices and split them into separate transactions when needed
 - **Structured storage**: Everything gets saved in an organized database for easy filtering and retrieval
-- **Customizable AI providers**: Choose from OpenAI, Google Gemini, or Mistral (local LLM support coming soon)
+- **Customizable AI providers**: Choose from OpenAI, Google Gemini, Mistral and OpenRouter (local LLM support coming soon)
 
 TaxHacker works with a wide variety of documents, including store receipts, restaurant bills, invoices, bank statements, letters, even handwritten receipts. It handles any language and any currency with ease.
 
@@ -163,6 +163,7 @@ You can also configure LLM provider settings in the application or via environme
 - **OpenAI**: `OPENAI_MODEL_NAME` and `OPENAI_API_KEY`
 - **Google Gemini**: `GOOGLE_MODEL_NAME` and `GOOGLE_API_KEY`
 - **Mistral**: `MISTRAL_MODEL_NAME` and `MISTRAL_API_KEY`
+- **OpenRouter**: `OPENROUTER_MODEL_NAME` and `OPENROUTER_API_KEY`
 
 ## ⌨️ Local Development
 
diff --git a/ai/providers/llmProvider.ts b/ai/providers/llmProvider.ts
@@ -3,7 +3,7 @@ import { ChatGoogleGenerativeAI } from "@langchain/google-genai"
 import { ChatMistralAI } from "@langchain/mistralai"
 import { BaseMessage, HumanMessage } from "@langchain/core/messages"
 
-export type LLMProvider = "openai" | "google" | "mistral"
+export type LLMProvider = "openai" | "google" | "mistral" | "openrouter"
 
 export interface LLMConfig {
   provider: LLMProvider
@@ -50,6 +50,15 @@ async function requestLLMUnified(config: LLMConfig, req: LLMRequest): Promise<LL
         model: config.model,
         temperature: temperature,
       })
+    } else if (config.provider === "openrouter") {
+      model = new ChatOpenAI({
+        apiKey: config.apiKey,
+        model: config.model,
+        temperature: temperature,
+        configuration: {
+          baseURL: "https://openrouter.ai/api/v1",
+        },
+      })
     } else {
       return {
         output: {},
diff --git a/app/(app)/unsorted/page.tsx b/app/(app)/unsorted/page.tsx
@@ -41,7 +41,8 @@ export default async function UnsortedPage() {
       {config.selfHosted.isEnabled &&
         !settings.openai_api_key &&
         !settings.google_api_key &&
-        !settings.mistral_api_key && (
+        !settings.mistral_api_key &&
+        !settings.openrouter_api_key && (
           <Alert>
             <Settings className="h-4 w-4 mt-2" />
             <div className="flex flex-row justify-between pt-2">
diff --git a/app/(auth)/actions.ts b/app/(auth)/actions.ts
@@ -16,7 +16,8 @@ export async function selfHostedGetStartedAction(formData: FormData) {
   const apiKeys = [
     "openai_api_key",
     "google_api_key",
-    "mistral_api_key"
+    "mistral_api_key",
+    "openrouter_api_key"
   ]
 
   for (const key of apiKeys) {
diff --git a/app/(auth)/self-hosted/page.tsx b/app/(auth)/self-hosted/page.tsx
@@ -37,6 +37,7 @@ export default async function SelfHostedWelcomePage() {
     openai: config.ai.openaiApiKey ?? "",
     google: config.ai.googleApiKey ?? "",
     mistral: config.ai.mistralApiKey ?? "",
+    openrouter: config.ai.openrouterApiKey ?? "",
   }
 
   return (
diff --git a/components/settings/llm-settings-form.tsx b/components/settings/llm-settings-form.tsx
@@ -30,7 +30,7 @@ import { PROVIDERS } from "@/lib/llm-providers";
 function getInitialProviderOrder(settings: Record<string, string>) {
   let order: string[] = []
   if (!settings.llm_providers) {
-    order = ['openai', 'google', 'mistral']
+    order = ['openai', 'google', 'mistral', 'openrouter']
   } else {
     order = settings.llm_providers.split(",").map(p => p.trim())
   }
diff --git a/forms/settings.ts b/forms/settings.ts
@@ -12,7 +12,9 @@ export const settingsFormSchema = z.object({
   google_model_name: z.string().default("gemini-2.5-flash"),
   mistral_api_key: z.string().optional(),
   mistral_model_name: z.string().default("mistral-medium-latest"),
-  llm_providers: z.string().default('openai,google,mistral'),
+  openrouter_api_key: z.string().optional(),
+  openrouter_model_name: z.string().default("openai/gpt-4o-mini"),
+  llm_providers: z.string().default('openai,google,mistral,openrouter'),
   prompt_analyse_new_file: z.string().optional(),
   is_welcome_message_hidden: z.string().optional(),
 })
diff --git a/lib/config.ts b/lib/config.ts
@@ -10,6 +10,8 @@ const envSchema = z.object({
   GOOGLE_MODEL_NAME: z.string().default("gemini-2.5-flash"),
   MISTRAL_API_KEY: z.string().optional(),
   MISTRAL_MODEL_NAME: z.string().default("mistral-medium-latest"),
+  OPENROUTER_API_KEY: z.string().optional(),
+  OPENROUTER_MODEL_NAME: z.string().default("gpt-4o-mini"),
   BETTER_AUTH_SECRET: z
     .string()
     .min(16, "Auth secret must be at least 16 characters")
diff --git a/lib/llm-providers.ts b/lib/llm-providers.ts
@@ -44,4 +44,19 @@ export const PROVIDERS = [
     },
     logo: "/logo/mistral.svg"
   },
+  {
+    key: "openrouter",
+    label: "OpenRouter",
+    apiKeyName: "openrouter_api_key",
+    modelName: "openrouter_model_name",
+    defaultModelName: "openai/gpt-4.1-mini",
+    apiDoc: "https://openrouter.ai/keys",
+    apiDocLabel: "OpenRouter Keys",
+    placeholder: "sk-or-...",
+    help: {
+      url: "https://openrouter.ai/keys",
+      label: "OpenRouter Keys"
+    },
+    logo: "/logo/openrouter.svg"
+  },
 ]
diff --git a/models/settings.ts b/models/settings.ts
@@ -9,28 +9,37 @@ export type SettingsMap = Record<string, string>
  * Helper to extract LLM provider settings from SettingsMap.
  */
 export function getLLMSettings(settings: SettingsMap) {
-  const priorities = (settings.llm_providers || "openai,google,mistral").split(",").map(p => p.trim()).filter(Boolean)
+  const priorities = (settings.llm_providers || "openai,google,mistral,openrouter").split(",").map(p => p.trim()).filter(Boolean)
 
   const providers = priorities.map((provider) => {
+    const providerConfig = PROVIDERS.find(p => p.key === provider)
+
     if (provider === "openai") {
       return {
         provider: provider as LLMProvider,
         apiKey: settings.openai_api_key || "",
-        model: settings.openai_model_name || PROVIDERS[0]['defaultModelName'],
+        model: settings.openai_model_name || (providerConfig?.defaultModelName),
       }
     }
     if (provider === "google") {
       return {
         provider: provider as LLMProvider,
         apiKey: settings.google_api_key || "",
-        model: settings.google_model_name || PROVIDERS[1]['defaultModelName'],
+        model: settings.google_model_name || (providerConfig?.defaultModelName),
       }
     }
     if (provider === "mistral") {
       return {
         provider: provider as LLMProvider,
         apiKey: settings.mistral_api_key || "",
-        model: settings.mistral_model_name || PROVIDERS[2]['defaultModelName'],
+        model: settings.mistral_model_name || (providerConfig?.defaultModelName),
+      }
+    }
+    if (provider === "openrouter") {
+      return {
+        provider: provider as LLMProvider,
+        apiKey: settings.openrouter_api_key || "",
+        model: settings.openrouter_model_name || (providerConfig?.defaultModelName),
       }
     }
     return null
diff --git a/public/logo/openrouter.svg b/public/logo/openrouter.svg
@@ -0,0 +1 @@
+<svg fill="currentColor" fill-rule="evenodd" height="1em" style="flex:none;line-height:1" viewBox="0 0 24 24" width="1em" xmlns="http://www.w3.org/2000/svg"><title>OpenRouter</title><path d="M16.804 1.957l7.22 4.105v.087L16.73 10.21l.017-2.117-.821-.03c-1.059-.028-1.611.002-2.268.11-1.064.175-2.038.577-3.147 1.352L8.345 11.03c-.284.195-.495.336-.68.455l-.515.322-.397.234.385.23.53.338c.476.314 1.17.796 2.701 1.866 1.11.775 2.083 1.177 3.147 1.352l.3.045c.694.091 1.375.094 2.825.033l.022-2.159 7.22 4.105v.087L16.589 22l.014-1.862-.635.022c-1.386.042-2.137.002-3.138-.162-1.694-.28-3.26-.926-4.881-2.059l-2.158-1.5a21.997 21.997 0 00-.755-.498l-.467-.28a55.927 55.927 0 00-.76-.43C2.908 14.73.563 14.116 0 14.116V9.888l.14.004c.564-.007 2.91-.622 3.809-1.124l1.016-.58.438-.274c.428-.28 1.072-.726 2.686-1.853 1.621-1.133 3.186-1.78 4.881-2.059 1.152-.19 1.974-.213 3.814-.138l.02-1.907z"></path></svg>

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,8 @@ export async function selfHostedGetStartedAction(formData: FormData) {`
`16`	`16`	`const apiKeys = [`
`17`	`17`	`"openai_api_key",`
`18`	`18`	`"google_api_key",`
`19`		`- "mistral_api_key"`
	`19`	`+ "mistral_api_key",`
	`20`	`+ "openrouter_api_key"`
`20`	`21`	`]`
`21`	`22`
`22`	`23`	`for (const key of apiKeys) {`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ export default async function SelfHostedWelcomePage() {`
`37`	`37`	`openai: config.ai.openaiApiKey ?? "",`
`38`	`38`	`google: config.ai.googleApiKey ?? "",`
`39`	`39`	`mistral: config.ai.mistralApiKey ?? "",`
	`40`	`+ openrouter: config.ai.openrouterApiKey ?? "",`
`40`	`41`	`}`
`41`	`42`
`42`	`43`	`return (`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ import { PROVIDERS } from "@/lib/llm-providers";`
`30`	`30`	`function getInitialProviderOrder(settings: Record<string, string>) {`
`31`	`31`	`let order: string[] = []`
`32`	`32`	`if (!settings.llm_providers) {`
`33`		`- order = ['openai', 'google', 'mistral']`
	`33`	`+ order = ['openai', 'google', 'mistral', 'openrouter']`
`34`	`34`	`} else {`
`35`	`35`	`order = settings.llm_providers.split(",").map(p => p.trim())`
`36`	`36`	`}`