Skip to main content

OpenGateLLM documentation

Welcome to the OpenGateLLM official documentation! This comprehensive guide will walk you through everything you need to know to run, configure, and extend OpenGateLLM.

warning

The API is still under beta version, major breaking changes may occur.

What is OpenGateLLM?​

OpenGateLLM is an open-source, production-ready API gateway, optimized for self-hosted models. It's designed to centralize, secure, and manage Generative AI access in a sovereign and cost-effective way.

OpenGateLLM addresses three critical challenges for organizations:

  1. Cost control - Reduce expenses of commercial APIs and GPU infrastructure by using self-hosted models and build a mutualized infrastructure with your peers.
  2. Data sovereignty - Keep sensitive data under your control
  3. Privacy & security - No chat history storage, robust access control

Core principles

  • Open source and free forever - All features available without commercial licensing
  • High code quality - Built with maintainability and reliability in mind
  • Lightweight architecture - Focused feature set for optimal performance
  • High compatibility - Seamlessly integrates with GenAI ecosystem frameworks by OpenAI-compatible API
  • Production-ready - Engineered to handle high loads with advanced QoS features

OpenGateLLM architecture

OpenGateLLM is an alternative to...

Key featuresOpenGateLLMLiteLLMTensorZero
πŸ”Œ OpenAI Compatibilityβœ…βœ…βœ…
πŸ“– Open-sourceβœ…βœ…βœ…
πŸ’» Self-hostableβœ…βœ…βœ…
πŸ’Έ Free (all features)βœ…βŒβœ…
🏭 Support commercial and self-hosted modelsβœ…βœ…βœ…
Account management
🎲 Playground UIβœ…βœ…βœ…
πŸ‘€ User management (API keys, budget...)βœ…βœ…βœ…
🏒 Organization managementπŸš§βœ…βŒ
✏️ Project managementπŸ”œβœ…βŒ
πŸ”‘ SSO supportπŸš§βœ…βŒ
High load features
βŒ› Rate limitingβœ…βŒβŒ
⚑ Requests prioritizationβœ…βœ…βŒ
πŸ“ˆ Quality of service thresholdsβœ…βœ…βŒ
πŸ”€ Model load balancingβœ…βœ…βŒ
πŸ”„ Model fallbackπŸ”œβœ…βŒ
Monitoring & analytics
πŸ“Š Usage trackingβœ…βŒβŒ
πŸ“ˆ Carbon footprintβœ…βŒβŒ
πŸ”— Prometheus integrationβœ…βŒβŒ
Privacy & security
🚫 No chat history storageβœ…βŒβŒ
πŸ”’ Role-based access controlβœ…βŒβŒ

Legend: βœ… supported β€” ❌ not supported β€” 🚧 work in progress β€” πŸ”œ in roadmap

Quickstart​

Get started with OpenGateLLM in minutes with our quickstart guide here.

Community & support​

OpenGateLLM is developed by Etalab since July 2024, the French government's open data and AI task force, with the support of CentraleSupΓ©lec.

This project exists thanks to all the people who contribute. OpenGateLLM thrives on open-source contributions. Join our community! Whether you're fixing bugs, adding features, or improving documentation, we welcome your help. Check out our Contributing Guide to get started.

Thanks to all contributors ❀️

leoguillaumesladinjibenjaminpiliaArtixJPmoscaalecyrillayAudreyCLEVYblanch0tdtrckdLedouxFaheemBEGKundun78revolunetmatthieucharreiredependabot[bot]Naxxosalexisfargeatanthonyjacquelinbzgjbousquielvcv4yRealVidylebaudantoineandjulecodcordanceetalab-bot

Roadmap​

OpenGateLLM is still under beta version, major breaking changes may occur. Check our current roadmap here to see what we are working on.

License​

OpenGateLLM is open-source software licensed under the MIT License.