feat: OpenRouter Support & Improve Model Fetching ⇆ (#936)

* chore(ChatGPTClient.js): add support for OpenRouter API
chore(OpenAIClient.js): add support for OpenRouter API

* chore: comment out token debugging

* chore: add back streamResult assignment

* chore: remove double condition/assignment from merging

* refactor(routes/endpoints): -> controller/services logic

* feat: add openrouter model fetching

* chore: remove unused endpointsConfig in cleanupPreset function

* refactor: separate models concern from endpointsConfig

* refactor(data-provider): add TModels type and make TEndpointsConfig adaptible to new endpoint keys

* refactor: complete models endpoint service in data-provider

* refactor: onMutate for refreshToken and login, invalidate models query

* feat: complete models endpoint logic for frontend

* chore: remove requireJwtAuth from /api/endpoints and /api/models as not implemented yet

* fix: endpoint will not be overwritten and instead use active value

* feat: openrouter support for plugins

* chore(EndpointOptionsDialog): remove unused recoil value

* refactor(schemas/parseConvo): add handling of secondaryModels to use first of defined secondary models, which includes last selected one as first, or default to the convo's secondary model value

* refactor: remove hooks from store and move to hooks
refactor(switchToConversation): make switchToConversation use latest recoil state, which is necessary to get the most up-to-date models list, replace wrapper function
refactor(getDefaultConversation): factor out logic into 3 pieces to reduce complexity.

* fix: backend tests

* feat: optimistic update by calling newConvo when models are fetched

* feat: openrouter support for titling convos

* feat: cache models fetch

* chore: add missing dep to AuthContext useEffect

* chore: fix useTimeout types

* chore: delete old getDefaultConvo file

* chore: remove newConvo logic from Root, remove console log from api models caching

* chore: ensure bun is used for building in b:client script

* fix: default endpoint will not default to null on a completely fresh login (no localStorage/cookies)

* chore: add openrouter docs to free_ai_apis.md and .env.example

* chore: remove openrouter console logs

* feat: add debugging env variable for Plugins

api/app/clients/ChatGPTClient.js

@@ -179,6 +179,11 @@ class ChatGPTClient extends BaseClient {
       opts.headers.Authorization = `Bearer ${this.apiKey}`;
     }
 
+    if (this.useOpenRouter) {
+      opts.headers['HTTP-Referer'] = 'https://librechat.ai';
+      opts.headers['X-Title'] = 'LibreChat';
+    }
+
     if (this.options.headers) {
       opts.headers = { ...opts.headers, ...this.options.headers };
     }

api/app/clients/OpenAIClient.js

@@ -61,7 +61,13 @@ class OpenAIClient extends BaseClient {
       };
     }
 
+    if (process.env.OPENROUTER_API_KEY) {
+      this.apiKey = process.env.OPENROUTER_API_KEY;
+      this.useOpenRouter = true;
+    }
+
     this.isChatCompletion =
+      this.useOpenRouter ||
       this.options.reverseProxyUrl ||
       this.options.localAI ||
       this.modelOptions.model.startsWith('gpt-');
@@ -119,6 +125,10 @@ class OpenAIClient extends BaseClient {
       console.debug('Using Azure endpoint');
     }
 
+    if (this.useOpenRouter) {
+      this.completionsUrl = 'https://openrouter.ai/api/v1/chat/completions';
+    }
+
     return this;
   }
 
@@ -324,12 +334,24 @@ class OpenAIClient extends BaseClient {
             return;
           }
 
+          if (this.options.debug) {
+            // console.debug('progressMessage');
+            // console.dir(progressMessage, { depth: null });
+          }
+
           if (progressMessage.choices) {
             streamResult = progressMessage;
           }
-          const token = this.isChatCompletion
-            ? progressMessage.choices?.[0]?.delta?.content
-            : progressMessage.choices?.[0]?.text;
+
+          let token = null;
+          if (this.isChatCompletion) {
+            token =
+              progressMessage.choices?.[0]?.delta?.content ?? progressMessage.choices?.[0]?.text;
+          }
+
+          if (!token && this.useOpenRouter) {
+            token = progressMessage.choices?.[0]?.message?.content;
+          }
           // first event's delta content is always undefined
           if (!token) {
             return;
@@ -396,6 +418,16 @@ class OpenAIClient extends BaseClient {
       configOptions.basePath = this.langchainProxy;
     }
 
+    if (this.useOpenRouter) {
+      configOptions.basePath = 'https://openrouter.ai/api/v1';
+      configOptions.baseOptions = {
+        headers: {
+          'HTTP-Referer': 'https://librechat.ai',
+          'X-Title': 'LibreChat',
+        },
+      };
+    }
+
     try {
       const llm = createLLM({
         modelOptions,

api/app/clients/PluginsClient.js

@@ -13,25 +13,27 @@ class PluginsClient extends OpenAIClient {
     this.sender = options.sender ?? 'Assistant';
     this.tools = [];
     this.actions = [];
-    this.openAIApiKey = apiKey;
     this.setOptions(options);
+    this.openAIApiKey = this.apiKey;
     this.executor = null;
   }
 
   setOptions(options) {
-    this.agentOptions = options.agentOptions;
+    this.agentOptions = { ...options.agentOptions };
     this.functionsAgent = this.agentOptions?.agent === 'functions';
-    this.agentIsGpt3 = this.agentOptions?.model.startsWith('gpt-3');
-    if (this.functionsAgent && this.agentOptions.model) {
+    this.agentIsGpt3 = this.agentOptions?.model?.includes('gpt-3');
+
+    super.setOptions(options);
+
+    if (this.functionsAgent && this.agentOptions.model && !this.useOpenRouter) {
       this.agentOptions.model = this.getFunctionModelName(this.agentOptions.model);
     }
 
-    super.setOptions(options);
-    this.isGpt3 = this.modelOptions.model.startsWith('gpt-3');
+    this.isGpt3 = this.modelOptions?.model?.includes('gpt-3');
 
-    // if (this.options.reverseProxyUrl) {
-    //   this.langchainProxy = this.options.reverseProxyUrl.match(/.*v1/)[0];
-    // }
+    if (this.options.reverseProxyUrl) {
+      this.langchainProxy = this.options.reverseProxyUrl.match(/.*v1/)[0];
+    }
   }
 
   getSaveOptions() {
@@ -77,6 +79,16 @@ class PluginsClient extends OpenAIClient {
       configOptions.basePath = this.langchainProxy;
     }
 
+    if (this.useOpenRouter) {
+      configOptions.basePath = 'https://openrouter.ai/api/v1';
+      configOptions.baseOptions = {
+        headers: {
+          'HTTP-Referer': 'https://librechat.ai',
+          'X-Title': 'LibreChat',
+        },
+      };
+    }
+
     const model = createLLM({
       modelOptions,
       configOptions,