pjandro/OmniRoute
1
0
Fork 0
mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-08-07 15:52:52 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
0b4bc4f4b13bee11ec5e1df29ef7301ea862b604
OmniRoute/docs/getting-started/PROVIDERS-GUIDE.md
Diego Rodrigues de Sa e Souza 04683029a6 fix(build): exec native esbuild binary directly in prepublish (dast-smoke base-red) (#9558) 
* fix(build): exec native tool binaries directly in runBuildTool

#8858 routed every resolved local bin through process.execPath to avoid
Windows .cmd shims — but esbuild >=0.25 ships bin/esbuild as the NATIVE
platform executable (ELF on Linux), so Node parsed machine code as JS and
build:cli died with 'SyntaxError: Invalid or unexpected token', turning
dast-smoke red for every PR.

runBuildTool now sniffs the entry's magic bytes (ELF / Mach-O / PE) and
execs native binaries directly; JS entries keep going through this Node
binary (the .cmd-shim avoidance #8858 wanted).

Validation (RED->GREEN on this box):
- RED: node node_modules/esbuild/bin/esbuild --version -> SyntaxError (ELF)
- GREEN: the exact failing CI step reproduced via the new logic bundles
  open-sse/mcp-server/server.ts successfully (4.2MB output, 1.3s).

* fix(docs): add MDX frontmatter to the 20 remaining docs without it

Same failure class as AGENTROUTER_WAF (#9503) and DOCKER_RELEASE_CHANNELS
(this run's dast-smoke red): any doc without frontmatter breaks the
fumadocs MDX loader during next build, killing build:cli/dast-smoke for
every PR. Swept ALL of docs/ (i18n mirrors excluded) in one pass so this
class cannot recur one file at a time.

* docs(env): document OMNIROUTE_INTERNAL_SERVICE_TOKEN(+_FILE), OPENROUTER_PROVIDER_STATS_* and embedded-Redis binding vars

Pre-existing env/docs contract drift from recently merged features made
check:env-doc-sync red for any docs-touching PR. Values and defaults read
from the defining modules (internalServiceAuth.ts, openrouterProviderStats.ts).

* fix(build): resolve bundled npm-cli.js in the standard Unix layout + safe npm fallback off-Windows

The opencode-plugin step hard-failed on GitHub runners because
resolveBundledNpmEntry only looked next to the node binary (Windows zip
layout); hostedtoolcache Node keeps npm at <prefix>/lib/node_modules/npm.
Added that candidate, and when neither exists on non-Windows the step now
falls back to plain 'npm' — the .cmd-shim hazard #8858 avoids is
Windows-only.

* test(mutation): register xai-agent-tools-passthrough.test.ts in stryker tap.testFiles

The test landed on release/v3.8.50 covering
open-sse/handlers/chatCore/passthroughHelpers.ts without the stryker
registration, so Fast Quality Gates' drift detection reds any PR that
carries it. Mechanical registration so its mutant kills count.

---------

Co-authored-by: diegosouzapw <diegosouzapw@users.noreply.github.com>
2026-08-06 02:19:57 -03:00

8.6 KiB
Raw Blame History

title, version, lastUpdated
title version lastUpdated
Providers Guide: Connect AI Models to OmniRoute 3.8.50 2026-08-06

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

Type What It Is Examples Cost
Free No payment required Kiro, OpenCode Free, Pollinations $0
API Key You need an API key OpenAI, Anthropic, Google Pay per use
OAuth Login with your account Claude Code, GitHub Copilot Subscription
Web Cookie Uses your browser session ChatGPT Web, Gemini Web $0 (uses your account)

Web Cookie Providers

See WEB-COOKIE-GUIDE.md for general setup instructions, limitations, troubleshooting, and provider-specific authentication guidance.

Quick Start: Connect Your First Provider

Option A: Free Provider (No Credit Card)

  1. Open the dashboard at http://localhost:20128
  2. Go to Providers → Add 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 Providers → Add 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 Providers → Add 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:

Provider Free Quota Models How to Connect
Kiro AI 50 credits/month Claude Sonnet 4.5, Haiku 4.5, Opus 4.6 No auth needed
OpenCode Free Unlimited GPT-4o, Claude, Gemini No auth needed
Pollinations No key needed GPT-5, Claude, Gemini, DeepSeek, Llama 4 No auth needed
LongCat 10M one-time LongCat-2.0 API key + KYC
Cloudflare AI 10K neurons/day 50+ models No auth needed
NVIDIA NIM ~40 RPM 129 models API key needed
Cerebras 1M tokens/day Qwen3 235B, GPT-OSS 120B API key needed
Qwen Unlimited Qwen3-coder-plus/flash/next No auth needed
Qoder Unlimited Kimi-K2, DeepSeek-R1, Qwen3-coder No 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:

Provider Best Models Cost Free Tier
OpenAI GPT-5, GPT-4o $2.50-$10/1M tokens $5 free credits
Anthropic Claude Opus 4.6, Sonnet 4.6 $3-$15/1M tokens $5 free credits
Google Gemini 2.5 Pro, Flash $0.075-$1.25/1M tokens 1,500 req/day free
DeepSeek DeepSeek V4 $0.14-$0.28/1M tokens 5M free tokens
Groq Llama 4, Mixtral $0.05-$0.27/1M tokens 30 RPM free
xAI Grok 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

Recommended Setup

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?

Reference in New Issue View Git Blame Copy Permalink