Back to Omniroute

Providers Guide: Connect AI Models to OmniRoute

docs/getting-started/PROVIDERS-GUIDE.md

3.8.499.3 KB
Original Source

Providers Guide: Connect AI Models to OmniRoute

TL;DR: A provider is a connection to an AI service (like OpenAI, Anthropic, Google). You need at least one provider to use OmniRoute.


What Is a Provider?

Think of a provider like a phone carrier. Just as you need a phone carrier to make calls, you need an AI provider to use AI models. OmniRoute is like a phone that works with all carriers — you can switch between them automatically.

Types of Providers

TypeWhat It IsExamplesCost
FreeNo payment requiredKiro, OpenCode Free, Pollinations$0
API KeyYou need an API keyOpenAI, Anthropic, GooglePay per use
OAuthLogin with your accountClaude Code, GitHub CopilotSubscription
Web CookieUses your browser sessionChatGPT Web, Gemini Web$0 (uses your account)

Quick Start: Connect Your First Provider

Optional first-run free-provider setup

The first-run wizard offers an explicit Set up free providers card. It derives the current eligible list from OmniRoute's no-auth provider registry, then lets you review and deselect each provider before confirming. OmniRoute shows the provider's caution notice and a link to its site so you can review third-party terms, privacy, availability, and rate limits first.

This action is optional: finishing the wizard never creates free-provider connections silently. It creates only providers that are still missing, leaves existing customized connections untouched, and reports created, already-configured, and failed providers individually. You can safely retry only the failures after a partial result.

Option A: Free Provider (No Credit Card)

  1. Open the dashboard at http://localhost:20128
  2. Go to ProvidersAdd Provider
  3. Select one of these free providers:
    • Kiro AI — Free Claude models (no auth needed)
    • OpenCode Free — Free GPT models (no auth needed)
    • Pollinations — Free GPT-5, Claude, Gemini (no key needed)
    • LongCat — 10M tokens free (one-time grant, requires account + KYC)
    • Cloudflare AI — 50+ models, 10K neurons/day
  4. Click Connect
  5. Done! You now have free AI access.

Option B: API Key Provider (Paid)

  1. Get an API key from the provider's website:
  2. Open the dashboard at http://localhost:20128
  3. Go to ProvidersAdd Provider
  4. Select your provider
  5. Paste your API key
  6. Click Connect
  7. Done! You now have access to that provider's models.

Option C: OAuth Provider (Subscription)

  1. Open the dashboard at http://localhost:20128
  2. Go to ProvidersAdd Provider
  3. Select your provider (e.g., Claude Code, GitHub Copilot)
  4. Click Connect with OAuth
  5. Login with your account
  6. Done! You now have access to your subscription models.

Best Free Providers

These providers offer free access with no credit card:

ProviderFree QuotaModelsHow to Connect
Kiro AI50 credits/monthClaude Sonnet 4.5, Haiku 4.5, Opus 4.6No auth needed
OpenCode FreeUnlimitedGPT-4o, Claude, GeminiNo auth needed
PollinationsNo key neededGPT-5, Claude, Gemini, DeepSeek, Llama 4No auth needed
LongCat10M one-timeLongCat-2.0API key + KYC
Cloudflare AI10K neurons/day50+ modelsNo auth needed
NVIDIA NIM~40 RPM129 modelsAPI key needed
Cerebras1M tokens/dayQwen3 235B, GPT-OSS 120BAPI key needed
QwenUnlimitedQwen3-coder-plus/flash/nextNo auth needed
QoderUnlimitedKimi-K2, DeepSeek-R1, Qwen3-coderNo auth needed

Tip: Connect multiple free providers for unlimited free AI with automatic fallback!


Best Paid Providers

These providers offer high-quality models with API keys:

ProviderBest ModelsCostFree Tier
OpenAIGPT-5, GPT-4o$2.50-$10/1M tokens$5 free credits
AnthropicClaude Opus 4.6, Sonnet 4.6$3-$15/1M tokens$5 free credits
GoogleGemini 2.5 Pro, Flash$0.075-$1.25/1M tokens1,500 req/day free
DeepSeekDeepSeek V4$0.14-$0.28/1M tokens5M free tokens
GroqLlama 4, Mixtral$0.05-$0.27/1M tokens30 RPM free
xAIGrok 3$0.30-$0.60/1M tokens

How to Connect a Provider (Step-by-Step)

Step 1: Open the Dashboard

Go to http://localhost:20128 in your browser.

Step 2: Go to Providers

Click Providers in the sidebar.

Step 3: Click Add Provider

Click the + Add Provider button.

Step 4: Select Your Provider

Browse the list or search for your provider. Click on it.

Step 5: Enter Credentials

  • Free providers: No credentials needed — just click Connect
  • API key providers: Paste your API key
  • OAuth providers: Click Connect with OAuth and login

Step 6: Test the Connection

Click Test Connection to verify it works.

Step 7: Done!

Your provider is now connected. You can use it with model: "auto" or specify the provider directly.


Using Multiple Providers

OmniRoute works best with multiple providers. This gives you:

  • Automatic fallback — If one provider fails, OmniRoute tries the next
  • Cost optimization — OmniRoute picks the cheapest provider for each request
  • Speed optimization — OmniRoute picks the fastest provider for each request
  • Quality optimization — OmniRoute picks the best provider for each task

Connect at least 3 providers for the best experience:

  1. One free provider (Kiro, OpenCode Free, or Pollinations) — Always available
  2. One fast provider (Groq, Cerebras) — For quick responses
  3. One quality provider (OpenAI, Anthropic, Google) — For complex tasks

Then use model: "auto" and OmniRoute will automatically pick the best one for each request.


Provider-Specific Setup

OpenAI

  1. Get API key: https://platform.openai.com/api-keys
  2. In OmniRoute: Providers → Add Provider → OpenAI
  3. Paste API key → Connect

Anthropic

  1. Get API key: https://console.anthropic.com/
  2. In OmniRoute: Providers → Add Provider → Anthropic
  3. Paste API key → Connect

Google (Gemini)

  1. Get API key: https://aistudio.google.com/apikey
  2. In OmniRoute: Providers → Add Provider → Gemini
  3. Paste API key → Connect

DeepSeek

  1. Get API key: https://platform.deepseek.com/
  2. In OmniRoute: Providers → Add Provider → DeepSeek
  3. Paste API key → Connect

Groq

  1. Get API key: https://console.groq.com/
  2. In OmniRoute: Providers → Add Provider → Groq
  3. Paste API key → Connect

Common Questions

"Do I need to pay to use OmniRoute?"

No! OmniRoute is free and open-source. You can use free providers (Kiro, OpenCode Free, Pollinations) without paying anything. You only pay if you choose to use paid providers.

"Which provider should I start with?"

Start with Kiro AI — it's free, requires no API key, and gives you access to Claude models. Then add more providers as needed.

"Can I use multiple providers at once?"

Yes! That's the whole point of OmniRoute. Connect multiple providers and use model: "auto" to let OmniRoute pick the best one for each request.

"What if a provider goes down?"

OmniRoute automatically skips failed providers and tries the next one. You don't need to do anything.

"How do I disconnect a provider?"

Go to Providers → click on the provider → click Disconnect.

"Can I use my existing API keys?"

Yes! If you already have API keys for OpenAI, Anthropic, Google, etc., you can use them in OmniRoute. Just paste them when connecting the provider.


What's Next?