Files
OmniRoute/examples/quickstart/README.md
Praveen K Palaniswamy 65e81158ab fix(ollama): route models by advertised capability (#11088)
Landed with the design call resolved per the owner's pick — **option 1**: the synced store is now endpoint-agnostic (persistDiscoveredModels and managedModelImport no longer drop non-chat models at write time), and chat selectability moved to read time (auto-pool expansion in autoStrategy applies filterChatSelectableModels; the models-route projection already had its chatOnly filter). Your discovery test now passes end-to-end (3/3): /api/show capabilities persist per connection and image/embedding requests route through the advertising host.

Reconciliation notes: conflicted areas merged onto the current tip (adobe discovery import, requestedModel preflight signature, resolvedProvider fast-path coexists with the synced-route override — explicit resolution wins); carried base-red drains (#10055 memoization, #11071 test variants) dropped as already-landed; the managed-model-import exclusion test was propagated to the new contract (image/video models persist; the read filter still hides them from chat pickers — pinned by a new assertion). Full battery: 205/206 focused (the one red is a confirmed periodic-timer timing flake on the loaded devbox — 20/20 isolated), autoCombo vitest 30/30, combo suites 46/46, gates + typecheck clean.

Thank you @yourspraveen — the capability probe + routing design was right; it just needed the store contract opened up. Fixes #11087.
2026-08-23 11:45:01 -03:00

40 lines
1.2 KiB
Markdown

# 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:
```bash
npx omniroute
# Server is now live at http://localhost:20128/v1
```
## Examples
| File | Language | Dependency |
|------|----------|------------|
| [`python_requests.py`](python_requests.py) | Python | `pip install requests` |
| [`nodejs_axios.js`](nodejs_axios.js) | Node.js | `npm install axios` |
| [`curl_terminal.sh`](curl_terminal.sh) | Bash / cURL | `curl` (pre-installed on Mac/Linux) |
| [`php_curl.php`](php_curl.php) | PHP | PHP 7.4+ with cURL |
All examples use **`felo/auto`** — a keyless, zero-configuration model that works immediately with no provider sign-up required.
## Key Settings (same in all examples)
| Setting | Value | Why |
|---------|-------|-----|
| `model` | `felo/auto` | Keyless provider, 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 different model, replace `felo/auto` with any model ID from:
```bash
curl http://localhost:20128/v1/models
```