mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-09-01 12:17:02 +03:00
84504e3f1f
Merged via /merge-batch (v3.8.51 provenance sweep). Boarded and validated together with the batch's other retirement PRs in a combined worktree — full gate suite green. This PR's conflicts (against #11720's Designer retirement, both introducing a retirement-guard mechanism across executors/index.ts, executorProxy.ts, providers.ts, reservedProviderPrefixes.ts, auth.ts, chat.ts, chatHelpers.ts, model.ts) were reconciled by combining both guards at every chokepoint, with the shared reserved-prefix count recomputed (not guessed) at 400. Re-validated with this PR's own 72 node:test + 20 vitest focused tests, all passing, and pushed before merge. Thank you.
Quickstart Code Examples
Simple, copy-paste scripts to get your first response from a local OmniRoute server in under a minute.
Prerequisites
Start OmniRoute locally first:
npx omniroute
# Server is now live at http://localhost:20128/v1
Examples
| File | Language | Dependency |
|---|---|---|
python_requests.py |
Python | pip install requests |
nodejs_axios.js |
Node.js | npm install axios |
curl_terminal.sh |
Bash / cURL | curl (pre-installed on Mac/Linux) |
php_curl.php |
PHP | PHP 7.4+ with cURL |
All examples use auto — the zero-configuration router that works immediately with no provider sign-up required.
Key Settings (same in all examples)
| Setting | Value | Why |
|---|---|---|
model |
auto |
Zero-configuration routing, works out of the box |
stream |
false |
Returns standard JSON instead of SSE stream |
Authorization |
Bearer dummy-key |
Any non-empty string satisfies the header requirement |
What to Change
To use a specific model, replace auto with any model ID from:
curl http://localhost:20128/v1/models