Endpoints personnalisés

Ajoutez des fournisseurs d'IA personnalisés comme OpenRouter, Ollama et des passerelles compatibles avec Anthropic à LibreChat en utilisant librechat.yaml

LibreChat prend en charge les services compatibles avec l'API OpenAI en tant qu'endpoints personnalisés. Il prend également en charge les endpoints personnalisés compatibles avec Anthropic avec provider: "anthropic". Vous configurez les endpoints dans librechat.yaml, stockez les clés API dans .env et montez la configuration via docker-compose.override.yml pour les déploiements Docker.

Quel fichier fait quoi ?

La configuration d'un endpoint personnalisé implique trois fichiers, chacun ayant un rôle spécifique :

librechat.yaml -- Définit vos endpoints personnalisés (nom, URL de l'API, modèles, paramètres d'affichage)
.env -- Stocke les valeurs sensibles telles que les clés API (référencées depuis librechat.yaml en utilisant la syntaxe ${VAR_NAME})
docker-compose.override.yml -- Monte librechat.yaml dans le conteneur Docker (utilisateurs Docker uniquement)

Pour un aperçu complet de la manière dont ces fichiers fonctionnent ensemble, consultez la Configuration Overview.

Avant de commencer

Ce guide suppose que vous avez LibreChat installé et en cours d'exécution. Si ce n'est pas le cas, terminez d'abord l'installation avec Docker setup.

Étape 1. Monter librechat.yaml (Docker uniquement)

Les utilisateurs de Docker doivent monter librechat.yaml en tant que volume afin que le conteneur puisse le lire. Ignorez cette étape si vous exécutez LibreChat localement sans Docker.

cp docker-compose.override.yml.example docker-compose.override.yml

Modifiez docker-compose.override.yml et assurez-vous que le montage de volume est décommenté :

services:
  api:
    volumes:
      - type: bind
        source: ./librechat.yaml
        target: /app/librechat.yaml

En savoir plus : Guide de remplacement Docker

Étape 2. Configurer librechat.yaml

Créez un fichier librechat.yaml à la racine du projet (s'il n'existe pas) et ajoutez votre configuration d'endpoint. Consultez le guide librechat.yaml pour des instructions de configuration détaillées.

Voici un exemple avec OpenRouter, Ollama et une passerelle compatible Anthropic :

version: 1.3.13
cache: true
endpoints:
  custom:
    - name: 'OpenRouter'
      apiKey: '${OPENROUTER_KEY}'
      baseURL: 'https://openrouter.ai/api/v1'
      models:
        default: ['meta-llama/llama-3-70b-instruct']
        fetch: true
      titleConvo: true
      titleModel: 'meta-llama/llama-3-70b-instruct'
      dropParams: ['stop']
      modelDisplayLabel: 'OpenRouter'
    - name: 'Ollama'
      apiKey: 'ollama'
      baseURL: 'http://host.docker.internal:11434/v1/'
      models:
        default: ['llama3:latest', 'command-r', 'mixtral', 'phi3']
        fetch: true
      titleConvo: true
      titleModel: 'current_model'
    - name: 'Claude-Compatible'
      provider: 'anthropic'
      apiKey: '${ANTHROPIC_API_KEY}'
      baseURL: 'https://api.anthropic.com'
      headers:
        anthropic-version: '2023-06-01'
      models:
        default: ['claude-sonnet-4-5']
        fetch: false
      titleConvo: true
      titleModel: 'claude-sonnet-4-5'

Parcourez tous les fournisseurs compatibles dans la section AI Endpoints. Pour la référence complète des champs, consultez Custom Endpoint Object Structure.

Endpoints compatibles avec Anthropic

Utilisez provider: "anthropic" uniquement pour les endpoints qui utilisent l'API native Anthropic Messages. Pour les passerelles compatibles OpenAI qui exposent simplement des modèles Anthropic, omettez provider et utilisez la structure d'endpoint personnalisé compatible OpenAI standard.

Configuration de la clé API

Lors de la configuration des clés API dans les endpoints personnalisés, vous avez trois options :

Variable d'environnement (recommandé) : apiKey: "${OPENROUTER_KEY}" -- lit depuis .env
User provided: apiKey: "user_provided" -- les utilisateurs saisissent leur propre clé dans l'interface utilisateur
Valeur directe (non recommandé) : apiKey: "sk-your-actual-key" -- stockée en texte brut

Étape 3. Définir les variables d'environnement

Ajoutez les clés API référencées dans votre librechat.yaml au fichier .env :

OPENROUTER_KEY=your_openrouter_api_key

Chaque ${VARIABLE_NAME} dans librechat.yaml doit avoir une entrée correspondante dans .env.

Étape 4. Redémarrer et vérifier

Après avoir modifié les fichiers de configuration, vous devez redémarrer LibreChat pour que les changements prennent effet.

docker compose down && docker compose up -d

Ouvrez LibreChat dans votre navigateur. Vos endpoints personnalisés devraient apparaître dans le menu déroulant de sélection des endpoints.

Vous ne voyez pas votre endpoint ?

Vérifiez les journaux du serveur pour détecter les erreurs de configuration :

docker compose logs api

Problèmes courants : erreurs de syntaxe YAML, variables d'environnement manquantes ou librechat.yaml non monté dans Docker. Validez votre YAML avec le YAML Validator.

OpenRouter ne s'affiche toujours pas

Pour OpenRouter spécifiquement, vérifiez la chaîne de trois fichiers :

.env contient OPENROUTER_KEY=...
librechat.yaml contient apiKey: "${OPENROUTER_KEY}" sous l'endpoint personnalisé OpenRouter
Les utilisateurs de Docker ont monté librechat.yaml dans docker-compose.override.yml

Ensuite, redémarrez avec :

docker compose down && docker compose up -d

Si le endpoint apparaît mais renvoie 402 Payment Required, la requête a bien atteint OpenRouter et le problème est généralement lié aux crédits du compte, à la facturation ou à la disponibilité du modèle sur OpenRouter.

Étapes suivantes

Endpoints IA

Parcourez tous les fournisseurs d'IA compatibles avec des exemples de configurations

→

Guide librechat.yaml

Guide de configuration complet et référence pour le fichier de configuration

→