# ORBIT ### Open Retrieval-Based Inference Toolkit

Connect your data (files, databases, APIs, and MCP tools) to any local or cloud LLM. Exposes a unified endpoint for your apps, with built-in authentication and observability.

⚡ Try Live Sandbox  •  Quick start  •  Watch the demo  •  Tutorial  •  Documentation

Architecture

One backend for private AI applications

| | What ORBIT gives you | | :---: | :--- | | Connect anything | Query files, SQL, NoSQL, vector stores, Elasticsearch, REST/GraphQL APIs, and MCP tools in natural language across multiple languages. | | Use any model | Route one API contract across local models such as Ollama, llama.cpp, and vLLM or cloud providers such as OpenAI, Anthropic, Gemini, Bedrock, and Azure. | | Operate it safely | Ship with API keys, RBAC, SSO, quotas, moderation, fallbacks, metrics, audit logs, and an admin panel instead of assembling them yourself. |

ORBIT sits between your applications and the models, data, and tools they need. Define adapters in YAML, expose them through one OpenAI-compatible endpoint, and move from a local prototype to a governed deployment without replacing the architecture.

ORBIT is actively maintained. See the release history, changelog, and commit history.

Capabilities

| Capability | Included | | :--- | :--- | | Model gateway | 41 configured inference backends and providers, OpenAI-compatible APIs, per-key routing, model switching, retries, and fallbacks. | | Retrieval | Vector RAG, file and multimodal RAG, SQL, MongoDB, Elasticsearch, REST, GraphQL, web search, and multi-source answers. | | Agents and protocols | MCP tool calling, bounded multi-step loops, natural-language skill routing, A2A, and asynchronous RabbitMQ requests. | | Media | Image, video, speech, PDF, Word, Excel, PowerPoint, CSV, and markdown generation. | | Security | API keys, RBAC, Entra ID and Auth0 SSO, rate limits, quotas, moderation, file encryption, and cloud secret managers. | | Operations | Admin UI, health checks, metrics, audit logs, per-request token and estimated-cost tracking, spend analytics, circuit breakers, datasource pooling, and hot adapter reloads. |

Browse all adapters · See provider configuration · Read the configuration reference

⭐ Finding ORBIT useful? Star the repository to help other developers discover it and support continued investment in new model, datasource, and agent integrations.

🚀 Quick Start

Explore the live sandbox instantly—no download, Docker, or setup required.

Install ORBIT

Option 1 (Preferred): Stable release tarball

Prerequisites: Linux or macOS, Python 3.12+, and an internet connection for downloading dependencies.

Download and install the latest stable release:

curl -L https://github.com/schmitech/orbit/releases/download/v2.15.3/orbit-2.15.3.tar.gz -o orbit-2.15.3.tar.gz
tar -xzf orbit-2.15.3.tar.gz
cd orbit-2.15.3
./install/setup.sh --profile default
./bin/orbit.sh start

ORBIT starts on http://localhost:3000. For Windows, follow the Windows installation guide.

ORBIT is highly configurable. The main server settings live in ./config/config.yaml; inference providers, adapters, models, data sources, and other capabilities are configured in the other files under ./config/.

See the server management guide for commands to start, stop, restart, pause, and monitor ORBIT.

To use the optional ORBIT chatbot web interface, install and run orbitchat from your host machine:

npm install -g orbitchat
ORBITADAPTERKEYS='{"simple-chat":"default-key"}' orbitchat

Then open http://localhost:5173 in your browser.

See the OrbitChat project and documentation for configuration, custom adapters, authentication, and advanced usage.

Option 2: Docker

Prerequisites: Docker, 4 GB of free RAM, and 3 GB of disk space.

docker pull schmitech/orbit-ollama:latest
docker run -d --name orbit -p 5173:5173 -p 3000:3000 \
  -v orbit-data:/orbit/data \
  -v orbit-models:/orbit/models \
  schmitech/orbit-ollama:latest

export OPENAIAPIKEY=sk-...
docker pull schmitech/orbit-openai:latest docker run -d --name orbit -p 5173:5173 -p 3000:3000 \   -e OPENAIAPIKEY \   -v orbit-data:/orbit/data \   schmitech/orbit-openai:latest

export GOOGLEAPIKEY=...
docker pull schmitech/orbit-gemini:latest docker run -d --name orbit -p 5173:5173 -p 3000:3000 \   -e GOOGLEAPIKEY \   -v orbit-data:/orbit/data \   schmitech/orbit-gemini:latest

Port 5173 is the chat UI, 3000 is the OpenAI-compatible API if you want to call ORBIT directly:

curl -X POST http://localhost:3000/v1/chat/completions \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: multimodal' \
  -H 'X-Session-ID: local-test' \
  -d '{"messages":[{"role":"user","content":"What can ORBIT connect to?"}]}'

Admin Panel at http://localhost:3000/admin (default credentials: username admin, password admin123, set via auth.defaultadmin_password in config.yaml — change this immediately after first login).

For custom Docker deployments, follow Docker guide.

Continue with the tutorial's fastest path: verify your installation, then create your first chat with a persona, API key, and OrbitChat.

Before you go further, read this: adapters — not the server code — are what define what ORBIT can actually do (retrieval sources, models, voice, file/multimodal handling, and more). They're configured entirely in YAML under config/adapters/ and registered in config/adapters.yaml. See the Adapter overview to understand this system before customizing your deployment.

What you can build

| Goal | ORBIT handles | | :--- | :--- | | Chat with private documents | Upload PDFs, office documents, spreadsheets, images, and audio; retrieve relevant context across a conversation. Try the tutorial → | | Query databases in multiple languages | Generate and execute safe queries across SQL, MongoDB, Elasticsearch, and composite datasources. Try the SQL demo → | | Build tool-using agents | Give models scoped access to MCP servers with bounded, multi-step server-side tool loops. Read the MCP guide → | | Offer one governed AI endpoint | Route local and cloud models with per-key access, quotas, fallbacks, moderation, metrics, and auditability. Create your first key → |

Clients and documentation

| Start here | Resource | | :--- | :--- | | Learn ORBIT | Tutorial · Your first chat · HTTP APIs | | Configure adapters | Adapter overview · Configuration guide | | Connect private data | Files · Vector stores · SQL | | Build agents | MCP tools · Auto skill routing · A2A | | Add voice | Real-time voice (speech-to-speech) · Audio services & STT/TTS adapters | | Run in production | Authentication · Usage and cost tracking · Rate limiting · Fault tolerance | | Use a client | ORBIT Chat · Node.js SDK · API key and Python examples |

See the full documentation index for architecture deep-dives, vector store setup, security hardening, and every other guide under docs/.

Contributing

Contributions are welcome: new retrievers and provider integrations, deployment guides, tests, fixes, and documentation. Read CONTRIBUTING.md, pick an open issue, or start a discussion.

Maintained by Remsy Schmilinsky.

License

ORBIT is licensed under the Apache License 2.0.