-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Relay Backend Strategy
github-actions[bot] edited this page Jun 30, 2026
·
1 revision
OmniRoute now supports three relay modes for /api/v1/relay/chat/completions:
-
ts: Use the TypeScript relay in-process. -
bifrost: Force the Bifrost gateway. -
auto: Prefer Bifrost when available, fall back to TypeScript on failure.
When you are running at high request rate (large number of tokens/day, near-constant throughput), the best strategy is to keep the fallback path explicit and fast so the hot path never blocks on a dead sidecar.
-
ts- Lowest operational complexity.
- All routing and validation runs in Node.
- No sidecar dependency for availability.
-
bifrost- Force all requests through the sidecar gateway.
- No automatic fallback.
- Useful only when sidecar health and latency are guaranteed.
-
auto- Sidecar is used when it can be reached and is enabled.
- Failed attempts trigger fallback headers and return traffic to TS so request success remains bounded.
- This mode is the safest choice for production when uptime matters more than strict sidecar-only routing.
9router and CLIPROXYAPI are both integrations that historically exposed compatibility paths for upstream providers.
- 9router is an embedded path for upstream orchestration and compatibility behavior.
- CLIPROXYAPI is a proxy API bridge for CLI / SDK style traffic.
- Bifrost is being stabilized as the externalized path when you need a dedicated sidecar-like hop and low-latency local dispatch.
If you are currently comparing 9router/CLIPROXYAPI:
- Keep request signing, allowlist checks, and DB policy gates in the API route before handoff.
- If a workflow needs strict sidecar behavior and lower per-request variance, use
OMNIROUTE_RELAY_BACKEND=bifrost. - If you need sidecar resilience with graceful degradation under incident conditions, use
OMNIROUTE_RELAY_BACKEND=auto.
For sustained high RPM/RPS and strict success SLO:
- Use
autowith a practical cooldown and failure telemetry. - Keep upstream validation and API-key checks on the TypeScript route boundary.
- Enable explicit headers/counters so your alerting sees fallback frequency and reasons.
- Tune sidecar timeouts to fail fast, not to wait forever.
- Keep service auto-restart and health telemetry loop healthy so fallback is truly exceptional.
OMNIROUTE_RELAY_BACKEND=autoBIFROST_ENABLED=1- Keep API keys, allowlist, sanitizer, and rate-limit checks enabled in route handlers (they always run before downstream forwarding).
- Export fallback metrics from your reverse proxy and request logs so sidecar outages are visible within one minute.
OmniRoute · Website · npm · Docker Hub
- Setup Guide
- User Guide
- Features
- Quick Start (Docker)
- Electron Desktop App
- Termux (Android)
- PWA Guide
- MCP Server
- A2A Server
- Agent Protocols
- OpenCode Plugin
- Webhooks
- Cloud Agents
- Skills
- Memory
- Evals
- Gamification
- Guardrails
- Compliance
- Error Sanitization
- Public Credentials
- Route Guard Tiers
- Stealth Guide
- CLI Token Auth