264 KiB
API Reference (සිංහල)
🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇧🇦 bs · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇱 he · 🇮🇳 hi · 🇭🇷 hr · 🇭🇺 hu · 🇦🇲 hy · 🇮🇩 id · 🇳🇬 ig · 🇮🇹 it · 🇯🇵 ja · 🇬🇪 ka · 🇰🇭 km · 🇮🇳 kn · 🇰🇷 ko · 🇱🇹 lt · 🇱🇻 lv · 🇮🇳 ml · 🇮🇳 mr · 🇲🇾 ms · 🇲🇹 mt · 🇲🇲 my · 🇳🇵 ne · 🇳🇱 nl · 🇳🇴 no · 🇮🇳 or · 🇮🇳 pa · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW
🌐 භාෂා: 🇺🇸 English | 🇪🇹 አማርኛ | 🇸🇦 العربية | 🇦🇿 Azərbaycan dili | 🇧🇬 Български | 🇧🇩 বাংলা | 🇧🇦 Bosanski | 🇨🇿 Čeština | 🇩🇰 Dansk | 🇩🇪 Deutsch | 🇬🇷 Ελληνικά | 🇪🇸 Español | 🇪🇪 Eesti | 🇮🇷 فارسی | 🇫🇮 Suomi | 🇫🇷 Français | 🇮🇪 Gaeilge | 🇮🇳 ગુજરાતી | 🇳🇬 Hausa | 🇮🇱 עברית | 🇮🇳 हिन्दी | 🇭🇷 Hrvatski | 🇭🇺 Magyar | 🇦🇲 Հայերեն | 🇮🇩 Bahasa Indonesia | 🇳🇬 Igbo | 🇮🇹 Italiano | 🇯🇵 日本語 | 🇬🇪 ქართული | 🇰🇭 ខ្មែរ | 🇮🇳 ಕನ್ನಡ | 🇰🇷 한국어 | 🇱🇹 Lietuvių | 🇱🇻 Latviešu | 🇮🇳 മലയാളം | 🇮🇳 मराठी | 🇲🇾 Bahasa Melayu | 🇲🇹 Malti | 🇲🇲 မြန်မာ | 🇳🇵 नेपाली | 🇳🇱 Nederlands | 🇳🇴 Norsk | 🇮🇳 ଓଡ଼ିଆ | 🇮🇳 ਪੰਜਾਬੀ | 🇵🇭 Filipino | 🇵🇱 Polski | 🇵🇹 Português (Portugal) | 🇧🇷 Português (Brasil) | 🇷🇴 Română | 🇷🇺 Русский | 🇱🇰 සිංහල | 🇸🇰 Slovenčina | 🇸🇮 Slovenščina | 🇷🇸 Српски | 🇸🇪 Svenska | 🇰🇪 Kiswahili | 🇮🇳 தமிழ் | 🇮🇳 తెలుగు | 🇹🇭 ไทย | 🇹🇷 Türkçe | 🇺🇦 Українська | 🇵🇰 اردو | 🇺🇿 Oʻzbekcha | 🇻🇳 Tiếng Việt | 🇳🇬 Yorùbá | 🇨🇳 中文 (简体) | 🇹🇼 中文 (繁體)
OmniRoute API සඳහා වන මූලික යොමු මාර්ගෝපදේශය මෙයයි. මෙය පොදු /v1 අතුරුමුහුණත සහ බහුලව භාවිත කරන කළමනාකරණ අන්තඃසන්ධි ආවරණය කරයි; යන්ත්රයෙන් කියවිය හැකි docs/openapi.yaml ගොනුව සහ src/app/api/ යටතේ ඇති මාර්ග වෘක්ෂය සම්පූර්ණ මූලාශ්ර වේ.
විශේෂයෙන් OpenAI සමඟ අනුකූල වන ප්රොටෝකෝලය සහ සැපයුම්කරුගේ හැකියා මැට්රික්සය සඳහා,
OPENAI_COMPATIBILITY.md බලන්න.
සෑම deployment එකක්ම build අතරතුර docs/openapi.yaml වෙතින් ජනනය කරන ලද, තමන්ගේම spec පිටපත /openapi.yaml හි සපයයි. එහි build හි version එක සහ සාපේක්ෂ server URL එක (./) අඩංගු වන බැවින්, requests ලේඛනය සපයන host එකේම රැඳේ. බාගත කළ ගොනුව import කරන tool එකකට එවැනි host එකක් නොමැති බැවින්, base URL එක අතින් සැකසිය යුතුය.
අන්තර්ගත වගුව
- චැට් සම්පූර්ණ කිරීම්
- සුවිශේෂී කළමනාකරණය කළ සැසි ලීසිං
- Embedding
- රූප ජනනය
- ලේඛන OCR
- ආකෘති ලැයිස්තුව
- Provider Plugin Manifest
- අනුකූලතා Endpoints
- Files API
- Batches API
- Search API
- WebSocket Streaming
- කෝටා සහ ගැටලු වාර්තාකරණය
- Semantic Cache
- CLIProxyAPI කළමනාකරණ අනුකූලතාව
- Dashboard සහ කළමනාකරණය
- Combo කළමනාකරණය
- Webhooks
- ලියාපදිංචි කළ Keys (ස්වයංක්රීය කළමනාකරණය)
- Agents Protocol
- කළමනාකරණ Proxies
- ප්රතිරෝධශීලීත්වය (විස්තීර්ණ)
- Skills
- Memory
- MCP Server
- A2A Server
- Cloud, Evals සහ Assess
- ඉල්ලීම් සැකසීම
- සත්යාපනය
චැට් සම්පූර්ණ කිරීම්
POST /v1/chat/completions
Authorization: Bearer your-api-key
Content-Type: application/json
{
"model": "cc/claude-opus-4-6",
"messages": [
{"role": "user", "content": "Write a function to..."}
],
"stream": true
}
අභිරුචි Headers
| ශීර්ෂය | දිශාව | විස්තර |
|---|---|---|
X-OmniRoute-No-Cache |
ඉල්ලීම | හැඹිලිය මඟහැරීමට true ලෙස සකසන්න |
x-omniroute-no-memory |
ඉල්ලීම | මෙම ඉල්ලීම සඳහා memory + skills injection මඟහැරීමට true ලෙස සකසන්න (no-cache හි හැසිරීම අනුකරණය කරයි; එක් ඇමතුමකට අදාළ token/cost අමතර බර වළක්වයි) |
X-OmniRoute-Progress |
ඉල්ලීම | ප්රගති සිදුවීම් සඳහා true ලෙස සකසන්න |
X-Session-Id |
ඉල්ලීම | බාහිර සැසි affinity සඳහා ස්ථාවර සැසි යතුර |
x_session_id |
ඉල්ලීම | underscore ප්රභේදයද පිළිගනී (සෘජු HTTP) |
X-OmniRoute-Session-Id |
ඉල්ලීම | ඇමතුම්කරු සපයන සැසි/සංවාද ටැගය (memory වෙතද යොමු කරයි). මෙය පවතින විට, per-session cost attribution සඳහා call_logs.session_tag වෙත එය අකුරටම සුරකියි (#8249) — නොමැති විට කිසිවිටෙක ස්වයංක්රීයව සාදන්නේ නැත |
Idempotency-Key |
ඉල්ලීම | අනුපිටපත් හඳුනාගැනීමේ යතුර (තත්පර 5ක කවුළුව) |
X-Request-Id |
ඉල්ලීම | විකල්ප අනුපිටපත් හඳුනාගැනීමේ යතුර |
x-omniroute-connection |
ඉල්ලීම | තනි-මාදිලි ඉල්ලීමක් එහි id මඟින් එක් provider connection (ගිණුමක්) වෙත සීමා කරන්න — ඉල්ලීමකට ගිණුම් සීමා කිරීම බලන්න |
X-OmniRoute-Cache |
ප්රතිචාරය | HIT හෝ MISS (streaming නොවන) |
X-OmniRoute-Idempotent |
ප්රතිචාරය | අනුපිටපත් ඉවත් කර ඇත්නම් true |
X-OmniRoute-Progress |
ප්රතිචාරය | ප්රගති ලුහුබැඳීම සක්රීය නම් enabled |
X-OmniRoute-Session-Id |
ප්රතිචාරය | OmniRoute විසින් භාවිත කළ සත්ය සැසි ID |
X-OmniRoute-Request-Id |
ප්රතිචාරය | ඉල්ලීම් සම්බන්ධතා id (දන්නා විට) |
X-OmniRoute-Version |
ප්රතිචාරය | OmniRoute build අනුවාදය (සෑම විටම පවතී) |
X-OmniRoute-Cost-Saved |
ප්රතිචාරය | HIT එකකදී හැඹිලිය මඟින් ඉතිරි කළ USD (හැඹිලි hits සඳහා පමණි) |
X-OmniRoute-Decision |
ප්රතිචාරය | Routing trace: strategy=<name>; provider=<alias>; latency_ms=<n> (<name> යනු combo strategy එක හෝ combo නොවන ඉල්ලීමක් සඳහා single වේ) — completion responses මත සෑම විටම පවතී |
Nginx සටහන: ඔබ underscore headers මත රඳා පවතින්නේ නම් (උදාහරණයක් ලෙස
x_session_id),underscores_in_headers on;සක්රීය කරන්න.
ඉල්ලීමකට ගිණුම් සීමා කිරීම
Provider එකකට connections කිහිපයක් (ගිණුම් හෝ keys) ඇති විට, OmniRoute සාමාන්යයෙන් එහි account-selection strategy හරහා එකක් තෝරයි. ඒ වෙනුවට, ඉල්ලීමකට x-omniroute-connection header එක සමඟ එක් නිශ්චිත connection එකක් සීමා කළ හැක:
curl http://localhost:20128/v1/chat/completions \
-H "Authorization: Bearer <your OmniRoute API key>" \
-H "Content-Type: application/json" \
-H "x-omniroute-connection: <connection id>" \
-d '{"model": "codex/gpt-5.5", "messages": [{"role": "user", "content": "hi"}]}'
- id එක සොයාගත හැකි ස්ථානය. ඩෑෂ්බෝඩයේ provider පිටුව විවෘත කර
(Dashboard → Providers → ) සම්බන්ධතා පේළියක ඇති
xxxxxxxx…id chip එක ක්ලික් කරන්න — එවිට සම්පූර්ණ connection id එක පිටපත් වේ. - එය අනුගමනය කරන requests.
/v1/chat/completions,/v1/messagesසහ/v1/responsesමත ඇති තනි-model requests (provider/model) මෙය අනුගමනය කරයි. Combos header එක නොසලකා හරියි: ඒ වෙනුවට combo පියවරකට account එකක් pin කිරීමට එම පියවරේම connection එක භාවිත කරන්න. - මෙම pin එක දැඩි නියමයකි, මනාපයක් නොවේ. Pin කළ connection එක පමණක් භාවිත වේ. Request එක ඇතුළත failure එකක් සිදුවුවහොත් account එකේ cooldown එක වාර්තා වේ, නමුත් එම provider එකේ sibling account එකකට මාරු නොවේ.
- Cooldown සහ quota මඟින් pin එක නිදහස් කරයි. Pin කළ connection එක cooldown තත්ත්වයේ පවතින විට, quota අවසන් වී ඇති විට හෝ quota policy එකක් මඟින් අවහිර වී ඇති විට, පසුව එන requests provider එකේ අනෙකුත් connections වෙත fallback වේ — pin නොකළ traffic මෙන්ම.
- නොදන්නා හෝ අක්රිය ids අසාර්ථක වේ. Provider එකේ සක්රිය pool එකේ නොමැති id එකක් (මකා දැමූ, deactivated කළ, හෝ වෙනත් provider එකකට අයත් එකක්) සුදුසු account එකක් ඉතිරි නොකරයි. එබැවින් request එක නිහඬව වෙනත් ස්ථානයකට route කිරීම වෙනුවට අසාර්ථක වේ.
Claude Code custom headers යවන්නේ ANTHROPIC_CUSTOM_HEADERS හරහාය. එය ~/.claude/settings.json හි env block එකට, හෝ එක් එක් project එකට වෙනස් account එකක් pin කිරීමට project-level .claude/settings.json වෙත එක් කරන්න:
{
"env": {
"ANTHROPIC_BASE_URL": "http://<your OmniRoute>:20128",
"ANTHROPIC_AUTH_TOKEN": "<your OmniRoute API key>",
"ANTHROPIC_CUSTOM_HEADERS": "x-omniroute-connection: <connection id>",
},
}
මූලාශ්රය: src/sse/handlers/chat.ts (header read), src/sse/services/auth.ts සහ
src/sse/services/sessionAffinityPin.ts (pin release සහ pool එකෙන් නොමැතිදැයි පරීක්ෂා කිරීම).
පිරිවැය telemetry headers: streaming නොවන සාර්ථක responses ද
X-OmniRoute-*cost-telemetry කට්ටලය රැගෙන එයි —X-OmniRoute-Response-Cost(USD, ස්ථිර දශම ස්ථාන 10ක්; නොමිලේ/මිල නියම කර නොමැති විට0.0000000000),X-OmniRoute-Tokens-In/X-OmniRoute-Tokens-Out,X-OmniRoute-Model,X-OmniRoute-Provider,X-OmniRoute-Latency-Ms,X-OmniRoute-Cache-Hit, සහX-OmniRoute-Fallback-Attempts(0 ට වැඩි විට පමණක්), එමෙන්මX-OmniRoute-Request-IdසහX-OmniRoute-Version. මේවා chat completions,/v1/responses,/v1/messages, සහ media endpoints —/v1/embeddings,/v1/images/generations,/v1/audio/speech,/v1/audio/transcriptions,/v1/rerank,/v1/videos/generations,/v1/music/generations, සහ/v1/moderations— මඟින් නිකුත් කරයි (/v1/moderationsසඳහා පිරිවැය සැමවිටම0වේ). Pricing ලබා ගත හැකි විට media පිරිවැය එක් එක් modality එක අනුව (එක් image එකකට, තත්පරයකට, character එකකට, එක් search-unit එකකට) ගණනය කෙරේ; එසේ නොමැති විට එය0වේ (fail-open).
Cache-hit පිරිවැය අර්ථකථනය: semantic-cache HIT එකකදී (
X-OmniRoute-Cache-Hit: true) upstream call එකක් සිදු නොවන බැවින්,X-OmniRoute-Response-Costහි අගය0.0000000000වේ (hit එක ලබා දීමේ incremental පිරිවැය). මුල්/සිදු වීමට තිබූ පිරිවැයX-OmniRoute-Cost-Savedතුළ වෙනම වාර්තා වේ. Billing consumers විසින්X-OmniRoute-Response-Costඑකතුව ගත යුතුය (hits සඳහා පිරිවැයක් නොමැත); cache analytics මඟින්X-OmniRoute-Cost-Savedඑකතුව කළ හැක.
සුවිශේෂී කළමනාකරණය කළ සැසි ලීසිං
සුවිශේෂී කළමනාකරණය කළ සැසි ලීසිං යනු විකල්පයෙන් සක්රීය කළ හැකි, සේවාදායක-නිරපේක්ෂ routing ගිවිසුමකි: සක්රීය හිමිකරුවෙකු එක් සුදුසු OmniRoute සම්බන්ධතාවයක් දරයි. මෙය model එකක් lease නොකරයි, OAuth අවශ්ය නොකරයි, විශේෂිත client එකක් හඳුනා නොගනී, හෝ විශේෂිත provider එකක් අවශ්ය නොකරයි.
සත්යාපනය කරන API key එකට lease:exclusive scope එක සහ හිස් නොවන පැහැදිලි allowedConnections ලැයිස්තුවක් තිබිය යුතුය. දත්තගබඩා mutation සීමාව key නිර්මාණයේදී සහ partial updates වලදී මෙම ක්ෂේත්ර දෙකම එකට පවතින බව තහවුරු කරයි.
POST /api/v1/session-leases
Authorization: Bearer <managed-api-key>
Content-Type: application/json
X-OmniRoute-Lease-Owner: vlo_<43-base64url-characters>
{"action":"acquire","model":"glm/glm-4.6"}
සාර්ථක acquire, renew, සහ release ප්රතිචාර මගින් timestamp, state, සහ නිශ්චිත ධන generation අගය පෙන්වයි, නමුත් තෝරාගත් සම්බන්ධතාවය හෝ අක්තපත්ර කිසිවිටෙකත් පෙන්වන්නේ නැත. Renew සහ release මගින් generation එක JSON body එක තුළ සපයයි:
{ "action": "renew", "generation": 1 }
{ "action": "release", "generation": 1, "reason": "OWNER_EXIT" }
සක්රීය lease හිමිකරුවෙකුට තම වත්මන් binding එක සඳහා පෞද්ගලිකත්වය සුරකින display metadata පැහැදිලිව ඉල්ලා සිටිය හැක:
{ "action": "status", "generation": 1 }
{
"state": "ACTIVE",
"generation": 1,
"acquiredAt": "2026-08-28T12:00:00.000Z",
"renewedAt": "2026-08-28T12:00:30.000Z",
"expiresAt": "2026-08-28T12:02:30.000Z",
"connection": {
"displayName": "Primary Codex",
"provider": "codex"
}
}
මෙම විකල්පයෙන් සක්රීය කළ status ක්රියාවලිය opaque owner, සත්යාපනය කළ managed API key, සහ නිශ්චිත සක්රීය generation එක මගින් එක් database transaction එකක් තුළ සීමා කර ඇත. displayName යනු trim කළ වින්යාසගත connection නාමය පමණක් වන අතර, ආරක්ෂිතව භාවිත කළ හැකි වින්යාසගත නාමයක් නොමැති විට එය null වේ. OmniRoute කිසිවිටෙකත් email එකක් හෝ උත්පාදනය කළ account identity එකක් ආදේශ නොකරයි. Provider අගය සංවේදී නොවන display label එකක් වන අතර, උත්පාදනය කළ compatible-provider identifier එකක් නොවේ. Credentials, tokens, cookies, raw connection හෝ API key ids, owner hashes, fencing secrets, සහ අභ්යන්තර routing දත්ත ඇතුළත් නොවේ.
වැරදි key, වැරදි owner, යල් පැන ගිය generation, නොමැති, කල් ඉකුත් වූ, release කළ, සහ invalidated lookups සියල්ල connection metadata නොමැති එකම 409 LEASE_FENCE_STALE දෝෂය ලබා දෙයි. Capacity-wait ප්රතිචාරය ලැබූ client එකකට පරීක්ෂා කිරීමට සක්රීය binding එකක් නොමැත. Routing මගින් සක්රීය lease එකක් මාරු කළ විට, එම generation එකම වලංගු වන අතර status මගින් නව binding එක atomic ලෙස ලබා දෙයි; පැරණි binding එක කිසිවිටෙකත් ලබා නොදේ. Acquire, renew, release, සහ waiting ප්රතිචාර පෙර පැවති හැඩතලවලම පවතින බැවින් පවතින clients වෙනස් නොවේ.
මෙම server contract එක stock OpenAI Codex /status වෙනස් නොකරයි. Stock Codex දැනට තම model provider සහ built-in authentication/account state වාර්තා කරයි, නමුත් අත්තනෝමතික custom provider account metadata ඉදිරිපත් නොකරයි; පසුව එක්වන client integration එකක් මෙම ක්රියාවලිය කැඳවා connection.displayName පෙන්වන්නේ කෙසේදැයි තීරණය කළ යුතුය.
සෑම managed inference request එකක්ම පසුව control headers දෙකම සපයයි:
X-OmniRoute-Lease-Owner: vlo_<43-base64url-characters>
X-OmniRoute-Lease-Generation: 1
සහාය දක්වන සෑම upstream උත්සාහයකටම පෙර නිශ්චිත owner, generation, active connection, සහ authenticated API key වහාම fence කරනු ලැබේ. වෙනත් key එකක් සමඟ owner සහ generation නැවත භාවිත කළහොත්, එම key එකට එම connection එකට අවසර තිබුණද එය අසාර්ථක වේ. Raw owners ස්ථිරව ගබඩා නොකරන අතර, log නොකරයි, request snapshot එක තුළ රඳවා නොගනී, හෝ upstream වෙත යොමු නොකරයි.
තාවකාලික contention HTTP 429 සමඟ Retry-After සහ පහත ප්රතිචාරය ලබා දෙයි:
{
"state": "WAITING_FOR_CAPACITY",
"error": { "type": "lease_error", "code": "LEASE_CAPACITY_UNAVAILABLE" },
"reason": "NO_FREE_ELIGIBLE_CONNECTION",
"retryAfter": 30
}
මෙම ප්රතිචාරයෙන් අදහස් වන්නේ සාමාන්යයෙන් සුදුසු set එක හිස් නොවූ නමුත්, නිදහස්ව තිබූ සෑම candidate එකක්ම වෙනත් සක්රීය lease එකක් විසින් අල්ලාගෙන සිටි බව පමණි. සහාය නොදක්වන models/providers, policy mismatch, cooldown, quota, health, සහ අනෙකුත් සාමාන්ය eligibility අසාර්ථකතා සඳහා පවතින OmniRoute ප්රතිචාර එලෙසම පවතී.
x-omniroute-compression
Compression plan එක request එකකට override කිරීම. ඉහළම precedence — routing-combo override, active profile, auto-trigger, සහ panel Default අභිබවා යයි. අගයන්:
| Value | Effect |
|---|---|
off |
මෙම request එක සඳහා compression නොමැත. |
default |
Panel මගින් ලබාගත් Default profile එක (active profile එක නොසලකා හරියි). Lossy engines අක්රීයව තබයි. |
safe |
Dedup සහ whitespace folding පමණි. |
allow-lossy |
summaries සහ style rewrites ඇතුළුව, මෙම request එක සඳහා operator plan එක තබා ගනී. |
engine:<id> |
සක්රීය කර ඇති විට තනි engine එකක්, උදා. engine:rtk. එම engine එක සඳහා request එකකට opt-in වීම. |
<combo> |
නාමයෙන් ගැළපෙන combo එකක්, පළමුව නාමය අනුව (case-insensitive), පසුව id අනුව. |
සටහන්:
- නොදන්නා අගයන් නොසලකා හරිනු ලැබේ (request එක කිසිවිටෙක reject නොකරයි); resolution සාමාන්ය operator precedence වෙත පහළට යයි.
- Combos කිහිපයකට එකම නාමයක් තිබේ නම්, deterministic match එකක් සඳහා combo id එක සපයන්න.
- නාමය
offහෝdefaultවන combo එකක් නාමයෙන් තෝරාගත නොහැක (offසහdefaultkeywords පළමුව අර්ථකථනය කරනු ලැබේ); එවැනි combo එකක් එහි id මගින් යොමු කරන්න. - Master compression switch එක hard gate එකකි: compression ගෝලීයව අක්රීය කර ඇති විට, මෙම header එකට එය සක්රීය කළ නොහැක.
යෙදූ plan එක response header එක තුළ නැවත ලබා දෙයි:
X-OmniRoute-Compression: <mode>; source=<source>
මෙහි <source> යනු request-header, routing-override, active-profile, auto-trigger, default, හෝ off වලින් එකකි.
Embeddings
POST /v1/embeddings
Authorization: Bearer your-api-key
Content-Type: application/json
{
"model": "nebius/Qwen/Qwen3-Embedding-8B",
"input": "The food was delicious"
}
ලබා ගත හැකි providers: Nebius, OpenAI, Mistral, Together AI, Fireworks, NVIDIA, OpenRouter, Jina AI.
Catalog ids යනු provider/model වේ (උදාහරණය: jina-ai/jina-embeddings-v5-omni-small). Registry තුළ දිස්වන bare Jina model ids (උදාහරණයක් ලෙස jina-embeddings-v5-text-small, jina-reranker-v3.5) ද resolve වේ. Jina embed/rerank/classify/segment සඳහා පළමුව dashboard jina-ai credentials භාවිත කරයි; dashboard key එකක් නොමැති විට පමණක් JINA_AI_API_KEY fallback එකක් ලෙස භාවිත වේ. jina-reader card එක Reader / r.jina.ai සඳහා පමණි (POST /v1/web/fetch), එය කිසිවිටෙක embeddings හෝ rerank ලබා නොදේ.
Multimodal support ප්රකාශ කරන registry models, provider-neutral structured items 32ක් දක්වා ද පිළිගනී. Media item types වන්නේ text, image, audio, video, සහ document ය. ඒවායේ media source එක {"type":"url","url":"https://..."} හෝ
{"type":"base64","data":"...","media_type":"..."} එකක් වේ.
Jina v5 Omni (jina-ai/jina-embeddings-v5-omni-small, jina-ai/jina-embeddings-v5-omni-nano,
සහ family alias එක වන jina-ai/jina-embeddings-v5-omni → omni-small) Jina හි native
EmbeddingsV5Request docs ද පිළිගෙන, ඒවා වෙනස් නොකර
https://api.jina.ai/v1/embeddings වෙත යොමු කරයි:
{
"model": "jina-ai/jina-embeddings-v5-omni-small",
"task": "retrieval.query",
"normalized": true,
"input": [
{ "text": "a red bicycle" },
{ "image": "https://example.com/bike.png" },
{ "content": [{ "text": "caption" }, { "image": "data:image/png;base64,..." }] }
]
}
Native { image | audio | video | pdf } values public HTTPS URL එකක්, data: URI එකක් හෝ raw
base64 එකක් විය හැක. OmniRoute එම objects strings බවට පත් නොකරන අතර native image URLs fetch නොකරයි — Jina විසින් public media තමන්ම ලබා ගනී. අමතර Jina fields (task, normalized, truncate, embedding_type) forward කරනු ලැබේ. Text-only Jina SKUs තවමත් non-text docs ප්රතික්ෂේප කරයි.
ආරක්ෂාව සහ transport සීමාවන්:
- Remote media URLs public HTTPS විය යුතුය. Canonical
{type,source:url}items server-side ලෙස fetch කරනු ලැබේ (redirect revalidation, timeout, size limits, public DNS, connection pinning), පසුව provider call එකට පෙර inline කරනු ලැබේ. Jina-native{image:"https://..."}items එකම public-HTTPS පරීක්ෂාවෙන් පසුව ඒ ආකාරයෙන්ම forward කරනු ලැබේ; URL එක fetch කරන්නේ Jina ය. - Inline base64 media එක item එකකට decoded ලෙස 8 MiB දක්වාත්, request එක පුරා decoded ලෙස 16 MiB දක්වාත් සීමා වේ.
Provider පරිවර්තනය (canonical items කිසිවිටෙක වෙනස් නොකර forward නොකරයි):
- Jina multimodal models: ඉහළම මට්ටමේ සෑම item එකක්ම data URIs භාවිත කරන එක් modality-keyed object එකක්
(
text/image/audio/video/pdf) බවට පත් වේ; ඉහළම මට්ටමේ සෑම item එකකටම එක් vector එකක් ලැබේ. - Gemini Embedding 2 family: එක් ඉහළම මට්ටමේ array එකක්
content.parts(textහෝinline_data) සහිත තනි nativemodels/{model}:embedContentrequest එකක් බවට පත් වේ. - llama.cpp (
llama-cpp/<model>, local server එක load කර ඇති ඕනෑම model එකක්): canonicaltextitems plain strings බවට පත් වන අතර,image/audio/videoitems එක බැගින්{"content": [part]}object එකක් බවට පත් වේ. මෙහිදී llama-server හි chat content parts (image_url,input_audiowith formatwav/mp3/flac,input_video) inline data සමඟ භාවිත කරයි; ඉහළම මට්ටමේ සෑම item එකකටම එක් vector එකක් ලැබේ.documentසහාය නොදක්වයි. Server එක--embedding --mmproj …සමඟ ධාවනය විය යුතුය; projector එකක් නොමැති විට media එක server එක විසින්ම ප්රතික්ෂේප කරයි. - Explicit modality metadata නොමැති unknown/dynamic models structured input HTTP 400 සමඟ ප්රතික්ෂේප කරයි.
{
"model": "jina-ai/jina-embeddings-v5-omni-small",
"input": [
{ "type": "text", "text": "A red bicycle" },
{
"type": "image",
"source": { "type": "url", "url": "https://example.com/bicycle.png" }
}
],
"dimensions": 512,
"encoding_format": "float"
}
සහාය නොදක්වන model/modality සංයෝජන item එක coercing කිරීම වෙනුවට HTTP 400 ලබා දෙයි. Legacy string/token requests හි input නොවන extension fields තවදුරටත් වෙනස් නොකර pass through වේ.
# සියලුම embedding models ලැයිස්තුගත කරන්න
GET /v1/embeddings
රූප උත්පාදනය
POST /v1/images/generations
Authorization: Bearer your-api-key
Content-Type: application/json
{
"model": "openai/gpt-image-2",
"prompt": "A beautiful sunset over mountains",
"size": "1024x1024"
}
පවතින සැපයුම්කරුවන් අතර OpenAI (GPT Image 2), xAI (Grok Image), Together AI (FLUX), Fireworks AI, Nebius (FLUX), Hyperbolic, NanoBanana,OpenRouter ,ZenMux , SD WebUI (දේශීය), ComfyUI (දේශීය).
n data[] හි n රූප ලබා දෙයි. එක් ඇමතුමකට upstream API එක් රූපයක් ලබා දෙන සැපයුම්කරුවන්ට (Black Forest Labs, Stability AI, Leonardo, Ideogram, Haiper, Hyperbolic, Magnific/Freepik, NVIDIA NIM, Cloudflare Workers AI) n වෙනම උඩුගං ඇමතුම් ලබා ගනී, වැඩිම 4 ගුවන් ගමන්වලදී. ස්ථාවර seed ඇමතුම් දර්ශකය (seed, seed + 1, …) මගින් හිලව් කරනු ලැබේ, එබැවින් රූප වෙනස් වන නමුත් නැවත ප්රතිනිෂ්පාදනය කළ හැකිය. n 10 ට සීමා කර ඇත. කිසියම් ඇමතුමක් අසාර්ථක වුවහොත් ඉල්ලීම සමස්තයක් ලෙස අසාර්ථක වේ. Fan-out ආකෘති ලැයිස්තුව open-sse/handlers/imageGeneration/fanOut.ts හි SINGLE_IMAGE_FANOUT_FORMATS වේ.
ZenMux දැනට පවතින API-යතුරු සම්බන්ධතාවය නැවත භාවිතා කරන අතර zenmux/ හෝ zm/ උපසර්ග පිළිගනී:
zenmux/openai/gpt-image-2ZenMux's OpenAI Images API භාවිතා කරයි. විකල්ප අතරsize,quality,n,output_format,output_compression,background, සහresponse_formatඇතුළත් වේ.zm/meta/muse-image-1.0වැනි අනෙකුත් ප්රකාශකයින් ZenMux හි Vertex AI:predictඅන්ත ලක්ෂ්යය භාවිතා කරයි.nසිතියම්sampleCountවෙත,aspect_ratioසිටaspectRatioදක්වා සහimage_size(1K,2K,4K) සිටsampleImageSizeදක්වා. පික්සල්sizeසපයනු ලබන්නේ දර්ශන අනුපාතයක් පමණි, සහතික කළ පික්සල් මානයන් නොවේ. සහාය දක්වන අනුපාත, විභේදන සහ ගණන් මාදිලි අනුව වෙනස් වේ.zm/inclusionai/ming-image-0.1-designතමන්ගේම මානයන් තෝරා ගනී.size,aspect_ratioසහimage_sizeඅත්හැර දමන්න; පැහැදිලි අගයන් HTTP 400 ලබා දෙයි. PNG, JPEG, සහ WebPoutput_formatසමඟ ඉල්ලා සිටිය හැක.
මෙම අනුකලනය පෙළ-පින්තූර උත්පාදනය සඳහා සහය දක්වයි, යොමු-රූප සංස්කරණයට නොවේ. Vertex ප්රතිදානය data[].b64_json වෙත සාමාන්යකරණය කර ඇත; response_format: "url" රූප බයිට් පමණක් ඇති විට upstream HTTPS URL හෝ base64 දත්ත URL ලබා දෙයි. Empty/filtered නිමැවුම් හිස් සාර්ථකත්වයට වඩා දෝෂයක් ලබා දෙයි. ආදර්ශ ප්රවේශය ZenMux ගිණුම මත රඳා පවතී. ZenMux හි Vertex API සහ OpenAI පින්තූර API බලන්න.
Microsoft 365 Copilot පුරනය සම්බන්ධතාවක් Copilot හි බිල්ට් රූප මෙවලම හරහා copilot-m365-web/m365-copilot-image සේවය කරයි: එක් රූපයකට එක් Copilot හැරීමක් (n 1–4), size සුක්කානම පමණක් දිශානතිය, සහ රූප පේළිගතව ආපසු (b64_json, හෝ response_format: "url" සඳහා දත්ත URL ). Microsoft 365 Copilot බලන්න.
# List all image models
GET /v1/images/generations
ලේඛන OCR
POST /v1/ocr
Authorization: Bearer your-api-key
Content-Type: application/json
{
"model": "mistral/mistral-ocr-latest",
"document": {
"type": "document_url",
"document_url": "https://example.com/invoice.pdf"
}
}
model මඟින් provider/model prefix එකක් හරහා OCR provider තෝරා ගනී; හිස් model id එකක් (උදා.
mistral-ocr-latest) එහි ලියාපදිංචි provider වෙත resolve වන අතර, model නොසපයා ඇති විට default එක ලෙස
Mistral (mistral-ocr-latest) භාවිත වේ. ලියාපදිංචි providers (open-sse/config/ocrRegistry.ts):
| Provider id | Model id | model value |
සටහන් |
|---|---|---|---|
mistral |
mistral-ocr-latest |
mistral/mistral-ocr-latest (or bare mistral-ocr-latest) |
සමමුහුර්ත — ප්රතිචාරය එකම upstream call එකෙන් සෘජුවම ලබා දේ. |
azure-document-intelligence |
prebuilt-read |
azure-document-intelligence/prebuilt-read |
අසමමුහුර්ත upstream (analyze + poll) — පහත බලන්න. |
vertex-deepseek-ocr |
deepseek-ocr-maas |
vertex-deepseek-ocr/deepseek-ocr-maas |
සමමුහුර්ත, Vertex AI හි openapi/chat/completions partner endpoint හරහා — auth/URL සඳහා පහත බලන්න. |
providers තුනම එකම Mistral-ආකාරයේ body එකකින් ප්රතිචාර දක්වයි:
{
"pages": [{ "index": 0, "markdown": "# Extracted text..." }],
"model": "mistral-ocr-latest",
"usage_info": { "pages_processed": 1 }
}
Azure Document Intelligence poll ප්රවාහය
Azure Document Intelligence හි analyze API එක අසමමුහුර්ත වේ: ආරම්භක request එක body එකක් වෙනුවට
Operation-Location header එකක් ලබා දෙන අතර, ප්රතිඵලය poll කළ යුතුය. handler එක
(open-sse/handlers/ocr.ts) එම URL එක සෑම තත්පරයකට වරක් attempts 30ක් දක්වා poll කරයි, non-ok poll response එකක් හෝ "failed" status එකක් ලැබුණු විට ඉක්මනින් අසාර්ථක වේ (තවදුරටත් poll නොකරයි), සහ attempt budget එක අවසන් වූ පසුවත් operation එක ක්රියාත්මක නම් 504 ලබා දේ. අවසන් Azure response එක caller වෙත ලබා දීමට පෙර Mistral විසින් භාවිත කරන එකම pages/markdown ආකෘතියට සාමාන්යකරණය කෙරෙන බැවින්, client code එකට provider එක අනුව විශේෂ හැසිරීමක් අවශ්ය නොවේ.
Vertex AI DeepSeek OCR auth සහ endpoint resolution
vertex-deepseek-ocr chat/image traffic සඳහා OmniRoute දැනටමත් සහාය දක්වන එකම Vertex AI authentication නැවත භාවිත කරයි
(open-sse/executors/vertex.ts): connection හි API key එක Service Account JSON credential එකක් (JWT-bearer
flow හරහා කෙටි කාලීන OAuth access token එකකට හුවමාරු කරනු ලබන) හෝ එලෙසම භාවිත කරන දැනටමත් mint කර ඇති OAuth access token එකක් විය හැක. upstream endpoint URL එක Vertex හි සාමාන්ය
openapi/chat/completions partner endpoint එක වන අතර, එය connection හි project සහ
region මත පදනම්ව ගොඩනගනු ලැබේ — පැහැදිලි providerSpecificData.project/providerSpecificData.region අගයන් සෑම විටම ප්රමුඛ වේ;
එසේ නොමැති නම් project එක Service Account JSON හි project_id වෙතින් ලබා ගන්නා අතර region එක
us-central1 ලෙස default වේ. මෙම resolutions දෙකම open-sse/handlers/ocr.ts හි
(resolveVertexOcrAccessToken, resolveVertexOcrBaseUrl) සිදු කෙරෙන අතර, handleOcr වෙත dispatch කිරීමට පෙර
src/app/api/v1/ocr/route.ts මඟින් භාවිත කරයි.
ආකෘති ලැයිස්තුව
GET /v1/models
Authorization: Bearer your-api-key
→ සියලුම chat, embedding සහ image ආකෘති + සංයෝජන OpenAI ආකෘතියෙන් ලබා දෙයි
ආකෘති මිල ගණන් (pricing)
OmniRoute ආකෘතියේ මිල දන්නා විට, එහි ප්රවේශයක pricing වස්තුවක් අඩංගු වේ. මිල ලැබෙන්නේ
ගාස්තු ගණනය සඳහා භාවිත කරන මිල වගුවෙනි: ගොඩනඟා ඇති පෙරනිමි අගයන්, සමමුහුර්ත කළ මිල ගණන් සහ
/api/pricing හරහා සකසන ලද අභිබවාම්. මේවා ලැයිස්තු මිල ගණන් වන බැවින්, දායකත්ව සපයන්නන් සඳහාද
ටෝකනයකට මිලක් පෙන්වයි.
"pricing": {
"prompt": "0.000005",
"completion": "0.000025",
"input_cache_read": "0.0000005",
"input_cache_write": "0.00000625",
"input": 5,
"output": 25,
"cached": 0.5,
"cache_creation": 6.25
}
| ක්ෂේත්ර | ඒකකය | සටහන් |
|---|---|---|
prompt, completion, input_cache_read, input_cache_write |
ටෝකනයකට USD, දශම string | OpenRouter-අනුකූල වන අතර, කිසිවිටෙක ඝාතීය අංකන ආකෘතියෙන් නොවේ. cache මිලක් ඇති විට පමණක් cache ක්ෂේත්ර දෙක පෙන්වයි. |
input, output, cached, cache_creation |
ටෝකන මිලියන 1කට USD, number | පෙර catalog අනුවාදවලින් පැමිණෙන ක්ෂේත්ර වන අතර, පවතින clients සඳහා තබා ඇත. මිල පේළියේ ඒවා ඇති විට reasoning සහ long_context ද පෙන්වයි. |
- Combos ඒවායේ පළමු දෘශ්යමාන target හි මිල රැගෙන යයි. ගොඩනඟා ඇති
auto/*combos ඉල්ලීමේ වේලාවේ target එකක් තෝරන බැවින්, ඒවාටpricingනොමැත. - Free models සඳහා මිල ශුන්ය වන විට
"0"(සහ0) පෙන්වයි. මිල පේළියක් නොමැති ආකෘතියක් catalog මඟින් එය නොමිලේ (free: true) ලෙස සලකුණු කර ඇති විට හෝ ගොඩනඟා ඇති free-model catalog එකේ ලැයිස්තුගත කර ඇති විට"0"පෙන්වයි. - Unknown price: ප්රවේශයට
pricingයතුරක් නොමැත. - Credit-metered providers (Kiro වැනි) ටෝකනයකට නොව ඉල්ලීමකට අනුව ගාස්තු අය කරයි. ඒවායේ ප්රවේශවල පෙර තිබූ ටෝකන මිලියන 1කට සංඛ්යාත්මක ක්ෂේත්ර තබා ඇති අතර, ටෝකනයකට අදාළ string ක්ෂේත්ර නොමැත.
- Variants (reasoning-effort ids, no-thinking aliases, discovery සහ gateway mirrors) ඒවා route කරන ආකෘතියේ මිල පිටපත් කරයි.
- ක්ෂේත්රවල අඩංගු වන්නේ මූලික අනුපාත පමණි. දිගු-සන්දර්භ ස්තර (සංඛ්යාත්මක
long_contextක්ෂේත්රය) සහ සේවා-ස්තර ගුණක (උදාහරණයක් ලෙස Codex fast හෝ flex)promptහෝcompletionවෙනස් නොකරයි. x-api-keyසහanthropic-versionසහිත Anthropic-ආකාරයේ ඉල්ලීමක් ඇතුළුව, සෑම සත්යාපන ආකාරයකටම වස්තුව එකම වේ (ප්රතිචාරය{ "object": "list", "data": [...] }ලෙසම පවතී). ක්රියාත්මක කිරීම:src/app/api/v1/models/catalogPricing.ts.
ආකෘති id උපසර්ග (?prefix=)
බොහෝ ආකෘති provider prefix එකක් යටතේ ප්රචාරය කෙරේ. ඔබට ලැබෙන prefix එක
MODELS_CATALOG_PREFIX_MODE feature flag මඟින් පාලනය වන අතර, ඉල්ලීමකට per request
query parameter එකකින් එය අභිබවා සැකසිය හැක — අනෙක් සියල්ලන් සඳහා server-wide
සැකසුම වෙනස් නොකර පිරිසිදු ලැයිස්තුවක් අවශ්ය client එකකට මෙය ප්රයෝජනවත් වේ:
GET /v1/models?prefix=alias # ආකෘතියකට එක් id එකක් — කෙටි alias prefix එක
GET /v1/models?prefix=dual # ආකාර දෙකම (server default)
GET /v1/models?prefix=canonical # සම්පූර්ණ provider-id prefix එක පමණක්
| මාදිලිය | නිකුත් කරන්නේ | සටහන් |
|---|---|---|
dual |
cc/claude-sonnet-4-6 සහ claude/claude-sonnet-4-6 |
පෙරනිමිය. ids දෙකම එකම ආකෘතියට route වේ; ආකාර දෙකෙන් එකක් hardcode කළ client configs ක්රියාත්මකව තබා ගැනීමට මේවා තබා ඇත. Catalog එක දළ වශයෙන් දෙගුණ වේ. |
alias |
cc/claude-sonnet-4-6 |
ආකෘතියකට එක් entry එකක්. වෙනස් alias එකක් නොමැති providers ද ඔවුන්ගේ entry එක නිකුත් කරයි, එබැවින් කිසිවක් නැති නොවේ. |
canonical |
claude/claude-sonnet-4-6 |
සම්පූර්ණ provider-id prefix යටතේ ආකෘතියකට එක් entry එකක්. වෙනස් alias එකක් නොමැති providers (උදා. antigravity/…, agy/…) ද ඔවුන්ගේ එකම id එක මෙහි නිකුත් කරයි, එබැවින් කිසිවක් නැති නොවේ. |
dual-mode mirror එකක් query parameter එක නොමැතිවද හඳුනාගත හැක: එහි ප්රාථමික id එකට යොමු වන
parent ක්ෂේත්රයක් ඇත.
model picker එකක් render කරන clients ?prefix=alias ඉල්ලිය යුතුය — මෙය
OmniCopilot VS Code extension මඟින් සිදු කරයි.
සොයාගැනීම් පෙරහන් (?capability=, ?min_context=, ?kind=, ?q=)
GET /v1/models මඟින් opt-in discovery filters පිළිගනී. ඒවා කිසිවක් නොමැති විට ප්රතිචාරය
වෙනස් නොවේ. ඒවා caller දැනටමත් දකින catalog එක සීමා කරයි (API-key permissions පළමුව යෙදේ),
එමෙන්ම OpenAI-ආකාරයේ limit / after paging ට පෙර ක්රියාත්මක වේ:
GET /v1/models?capability=vision&capability=tool_calling # ලැයිස්තුගත කළ සෑම capability එකක්ම true විය යුතුය
GET /v1/models?capability=vision,reasoning&min_context=200000
GET /v1/models?kind=embedding # catalog `type`; එකක් නොමැති rows `chat` වේ
GET /v1/models?q=sonnet&limit=10 # id හෝ name මත case-insensitive ගැළපීම
| පරාමිතිය | අගයන් |
|---|---|
capability |
attachment, reasoning, structured_output, temperature, thinking, tool_calling, vision |
min_context |
සෘණ නොවන පූර්ණ සංඛ්යාවක්, context_length සමඟ සංසන්දනය කෙරේ |
kind |
chat, audio, embedding, image, moderation, music, rerank, video |
q |
අක්ෂර 1–200 |
නොදන්නා අගයක් හෝ සෘණ නොවන පූර්ණ සංඛ්යාවක් නොවන min_context අගයක් (උදාහරණයක් ලෙස 1.5) ලබා දුන් විට,
HTTP 400 ප්රතිචාරයක් ලැබෙන අතර පණිවිඩයේ වලංගු අගයන් ලැයිස්තුගත කරයි. ක්රියාත්මක කිරීම:
src/app/api/v1/models/catalogFilters.ts.
ආදර්ශ කෙටි ලැයිස්තුව (POST /v1/models/query)
POST /v1/models/query මඟින් එකම catalog එකෙන් කෙටි, නිර්ණායකාත්මක ලැයිස්තුවක් ලබා දෙන අතර,
GET /v1/models හි ඇති එකම සත්යාපනය සහ එක් යතුරකට අදාළ දෘශ්යතාව භාවිත කරයි:
POST /v1/models/query
Authorization: Bearer your-api-key
Content-Type: application/json
{ "capabilities": ["vision", "tool_calling"], "min_context": 128000, "max_output": 16000,
"kind": "chat", "q": "gpt", "owned_by": "openai", "exclude": ["openai/gpt-4o"], "limit": 5 }
→ { "object": "list", "data": [ ...models ] }
සෑම ක්ෂේත්රයක්ම විකල්ප වේ. capabilities සහ exclude සඳහා අරාවක් හෝ කොමාවකින් වෙන් කළ
තන්තුවක් භාවිත කළ හැක; max_output සංසන්දනය කරන්නේ max_output_tokens සමඟය. ප්රතිඵල
owned_by අනුවත්, පසුව id අනුවත් වර්ග කෙරේ. limit හි පෙරනිමි අගය 20 වන අතර
100 ඉක්මවන අගයන් 100 දක්වා සීමා කෙරේ. අවලංගු JSON එකක්, නොදන්නා ක්ෂේත්රයක් හෝ අවලංගු
අගයක් ලබා දුන් විට HTTP 400 ප්රතිචාරයක් ලැබේ.
තනි තනිව සඟවා ඇති chat ආදර්ශ
තම provider පිටුවේ සඟවා ඇත ලෙස සලකුණු කර ඇති ආදර්ශයක් catalog එකෙන් ඉවත් කරනු ලබන අතර,
පැහැදිලිව ඉල්ලා සිටින විට HTTP 404 / model_not_found සමඟ ප්රතික්ෂේප කෙරේ. මෙම පරීක්ෂාව
provider aliases, compatible-provider node prefixes සහ connection defaults ඇතුළුව විසඳූ provider
සහ model භාවිත කරයි. Combo එකක් සඟවා ඇති ඉලක්ක මඟහැර දෘශ්යමාන sibling එකක් භාවිත කළ හැක;
ක්රියාත්මක කළ හැකි ඉලක්කයක් ඉතිරි නොවන විට එම දෝෂ කේතයම ලබා දෙයි. නැවත දෘශ්යමාන කිරීම
ඊළඟ ඉල්ලීමේ සිට බලපැවැත්වේ. Image-only දෘශ්යතා අභිබවා යාම් එකම ID සහිත chat model එක
සඟවන්නේ නැත.
මෙම තනි ආදර්ශ සැකසුම model exposure allow/deny lists
වලින් වෙනස් වන අතර, ඒවා catalog ප්රචාරණය සහ auto-routing අපේක්ෂකයන් පෙරහන් කරන නමුත්
පැහැදිලි dispatch රඳවා ගනී. API-key ආදර්ශ අවසර ස්වාධීනව තවදුරටත් අදාළ වේ. පෙරනිමි catalog
prefix mode එක dual ලෙසම පවතී.
Thinking නොමැති ආදර්ශ ප්රභේද
Thinking හැකියාව ඇති Claude ආදර්ශ සඳහා, /v1/models මඟින් claude-3-omniroute-no-thinking/
යන prefix එක සහිත thinking නොමැති ප්රභේදයක් ද ප්රචාරණය කරයි:
claude-3-omniroute-no-thinking/<provider>/<model>
මෙම ID එක තේරීමෙන් (උදාහරණයක් ලෙස, සෑම විටම thinking block එකක් එක් කරන Claude Code
config එකකදී) සැබෑ <provider>/<model> වෙත නැවත විසඳා reasoning අක්රිය කෙරේ — /v1/messages
මාවතේ thinking:{type:"disabled"} ලෙස හෝ /v1/chat/completions මාවතේ reasoning/
reasoning_effort ක්ෂේත්ර ඉවත් කිරීමෙන්. මෙම ප්රභේදය ලැයිස්තුගත කරන්නේ thinking සඳහා
සහාය දක්වන සහ disabled ගරු කරන Claude-පවුලේ ආදර්ශ සඳහා පමණි (උදාහරණයක් ලෙස,
disabled ප්රතික්ෂේප කරන adaptive-only ආදර්ශ ඉවත් කෙරේ). ක්රියාකරුවන්ට
ModelSpec.noThinkingAlias හරහා එක් එක් ආදර්ශය සඳහා මෙම ප්රභේදය බලගන්වා හෝ අක්රිය කර
හැක.
Provider Plugin Manifest
GET /api/v1/provider-plugin-manifest
Bifrost, CLIProxyAPI සහ අනාගත sidecar routers විසින් භාවිත කරන JSON-ආරක්ෂිත provider plugin manifest එක ලබා දෙයි. ප්රතිචාරය TypeScript provider registry එකෙන් ජනනය වන අතර OAuth client secrets, runtime environment resolution, executor functions, request headers සහ account data හිතාමතාම බැහැර කරයි.
sidecar එකක් out-of-process ලෙස ක්රියාත්මක වන අතර open-sse/config/providerPluginManifestRegistry.ts සෘජුවම import කළ නොහැකි විට මෙම endpoint එක භාවිත කරන්න.
ElevenLabs audio generation
ඔබගේ ElevenLabs API key සමඟ OmniRoute හි elevenlabs provider connection එකක් වින්යාස කරන්න. Clients authenticate වන්නේ ඔවුන්ගේ OmniRoute key (Authorization: Bearer $OMNIROUTE_API_KEY) මඟිනි; gateway එක ගබඩා කර ඇති provider key එක xi-api-key ලෙස සපයයි. ElevenLabs key එක gateway bearer token ලෙස කිසිවිටෙකත් යවන්න එපා.
| Method | Path | Response | API key endpoint category |
|---|---|---|---|
| POST | /v1/sound-generation |
Native audio bytes | elevenlabs |
| POST | /v1/music |
Native audio bytes | music |
| POST | /v1/music/stream |
Streaming audio bytes | music |
| POST | /v1/music/detailed |
Native multipart audio and composition plan | music |
| POST | /v1/music/detailed/stream |
Native SSE metadata and audio chunks | music |
| POST | /v1/music/plan |
JSON composition plan | music |
මෙම endpoints දැනට පවතින /v1/audio/speech, /v1/audio/transcriptions,
/v1/voices, /v1/text-to-speech/{voiceId} සහ /v1/speech-to-text routes වලට අමතරව ක්රියා කරයි. Native JSON fields සහ output_format හා enable_logging වැනි query parameters සංරක්ෂණය කෙරේ. /v1/music/detailed responses ඒවායේ multipart boundaries සංරක්ෂණය කරයි; ඒවා multipart ලෙස parse කරන්න. /v1/music/detailed/stream මඟින් composition metadata සහ SSE events තුළ base64 audio chunks සහිත text/event-stream ලබා දෙයි. මෙම routes හයම CORS preflight සඳහා සහාය දක්වයි.
export OMNIROUTE_BASE_URL="http://localhost:20128"
export OMNIROUTE_API_KEY="your-omniroute-api-key"
# කෙටි ශබ්ද ප්රයෝගයක්. කාලසීමාව: තත්පර 0.5 සිට 30 දක්වා.
curl --fail-with-body "$OMNIROUTE_BASE_URL/v1/sound-generation?output_format=mp3_44100_128" \
-H "Authorization: Bearer $OMNIROUTE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"text":"A single soft bell chime","duration_seconds":1,"model_id":"eleven_text_to_sound_v2"}' \
--output effect.mp3
# සංගීත කාලසීමාව මිලි තත්පරවලින් දැක්වේ: 3000 සිට 600000 දක්වා.
curl --fail-with-body "$OMNIROUTE_BASE_URL/v1/music?output_format=mp3_44100_128" \
-H "Authorization: Bearer $OMNIROUTE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"prompt":"Gentle instrumental piano","music_length_ms":10000,"force_instrumental":true,"model_id":"music_v1"}' \
--output music.mp3
incremental audio delivery සඳහා එම JSON body එක සමඟ /v1/music/stream භාවිත කරන්න. Composition එක prompt හෝ composition_plan වලින් හරියටම එකක් පිළිගනී; /v1/music/plan සඳහා prompt අවශ්ය වන අතර, විකල්ප වශයෙන් source_composition_plan පිළිගනී. Native schemas මඟින් අමතර provider fields සංරක්ෂණය කරන බැවින් composition-plan versions සහ fine-tuning options ElevenLabs වෙත ළඟා වේ.
Unified /v1/music/generations endpoint එක elevenlabs/music_v1, elevenlabs/music_v2 සහ elevenlabs/music_v2_5 ද පිළිගනී. සක්රීය ElevenLabs connection එකක් ඇති විට, මෙම models music catalog එක මඟින් නිරාවරණය කෙරේ. මෙම endpoint එක {"created":...,"data":[{"b64_json":"...","format":"mp3"}]} ලබා දෙයි. එහි duration field එක තත්පරවලින් වන අතර music_length_ms වෙත map වේ; පැහැදිලිව දක්වා ඇති music_length_ms හට ප්රමුඛතාව ලැබේ. instrumental යන්න force_instrumental වෙත map වන අතර, native field එකට ප්රමුඛතාව ලැබේ. Streaming සඳහා native streaming endpoints ද, composition plan එකක් මත පමණක් පදනම් වූ requests සඳහා native composition endpoint එක ද භාවිත කරන්න.
curl --fail-with-body "$OMNIROUTE_BASE_URL/v1/music/generations" \
-H "Authorization: Bearer $OMNIROUTE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model":"elevenlabs/music_v1","prompt":"Gentle instrumental piano","duration":10,"instrumental":true}'
Upstream call එකකට පෙර endpoint, model, budget සහ connection restrictions ක්රියාත්මක වේ. Native routes upstream status codes සහ error bodies වෙනස් නොකර ආපසු ලබා දෙයි; මෙයට plan restriction එකක් සඳහා 402 සහ quota limit එකක් සඳහා 429 ද ඇතුළත් වේ. පවතින විට character-cost, song-id, request-id සහ retry-after headers සංරක්ෂණය කෙරේ. නොමිලේ credit balance එකක් තිබීම සෑම music model එකකටම, output format එකකටම හෝ API feature එකකටම ප්රවේශය සහතික නොකරයි: එක් එක් request එක සඳහා entitlement තීරණය කරන්නේ ElevenLabs විසිනි. Unified endpoint එක OmniRoute හි normalized error envelope තුළ error status codes සංරක්ෂණය කරයි.
Upstream contracts: sound effects, music composition සහ streaming music details.
ගැළපුම් අන්ත ලක්ෂ්ය
| Method | Path | Format |
|---|---|---|
| POST | /v1/chat/completions |
OpenAI |
| POST | /v1/messages |
Anthropic |
| POST | /v1/responses |
OpenAI Responses |
| POST | /v1/embeddings |
OpenAI |
| POST | /v1/images/generations |
OpenAI Images |
| POST | /v1/images/edits |
OpenAI Images (සංස්කරණය/ඇතුළත්-පින්තාරු) |
| POST | /v1/videos/generations |
OpenAI-ශෛලියේ වීඩියෝ උත්පාදනය |
| POST | /v1/music/generations |
OpenAI-ශෛලියේ සංගීත උත්පාදනය |
| POST | /v1/audio/transcriptions |
OpenAI Audio (STT) |
| POST | /v1/audio/speech |
OpenAI TTS (ශ්රව්ය අන්තර්ගතය ආපසු ලබා දෙයි) |
| POST | /v1/rerank |
Cohere/Voyage-ශෛලියේ නැවත ශ්රේණිගත කිරීම |
| POST | /v1/classify |
Jina වර්ගීකරණය (api.jina.ai) |
| POST | /v1/segment |
Jina ඛණ්ඩකය (segment.jina.ai) |
| POST | /v1/moderations |
OpenAI Moderations |
| GET | /v1/models |
OpenAI |
| POST | /v1/models/query |
පෙරහන් කළ ආකෘති කෙටි ලැයිස්තුව |
| POST | /v1/messages/count_tokens |
Anthropic |
| GET | /v1beta/models |
Gemini |
| POST | /v1beta/models/{...path} |
Gemini generateContent |
| POST | /v1/api/chat |
Ollama |
| GET | /api/v1/vscode/{token}/ |
OpenAI නාමාවලි අන්වර්ථය |
| GET | /api/v1/vscode/{token}/models |
OpenAI models අන්වර්ථය |
| POST | /api/v1/vscode/{token}/chat/completions |
OpenAI ටෝකනීකෘත අන්වර්ථය |
| POST | /api/v1/vscode/{token}/responses |
OpenAI Responses ටෝකනීකෘත අන්වර්ථය |
| POST | /api/v1/vscode/{token}/api/chat |
Ollama ටෝකනීකෘත අන්වර්ථය |
| GET | /api/v1/vscode/{token}/api/tags |
Ollama tags ටෝකනීකෘත අන්වර්ථය |
සියලුම POST මාර්ග එකම ආකෘතිය අනුගමනය කරයි: Bearer your-api-key + Zod මඟින් වලංගු කරන ලද JSON body (v1RerankSchema, v1ModerationSchema, v1AudioSpeechSchema ආදිය; src/shared/validation/schemas.ts බලන්න). ස්කීමා වලංගු කිරීම අසමත් වූ විට 4xx ආපසු ලබා දේ.
Authorization: Bearer ... එක් කළ නොහැකි සේවාදායකයන් සඳහා, OmniRoute URL තුළ API යතුරු ද පිළිගනී. එය query-string ගැළපුම (?token=..., ?apiKey=..., ?api_key=..., ?key=...) හෝ පහත ලේඛනගත කර ඇති විශේෂිත /api/v1/vscode/{token}/... අන්ත ලක්ෂ්ය හරහා සිදු කළ හැක.
# නැවත ශ්රේණිගත කිරීම (cloud registry provider එකක් හෝ "<prefix>/<model>" ලෙස OpenAI-අනුකූල provider node එකක්)
POST /v1/rerank { "model": "jina-ai/jina-reranker-v3.5", "query": "...", "documents": ["..."] }
# Jina වර්ගීකරණය (Foundation API credentials)
POST /v1/classify { "model": "jina-embeddings-v5-text-small", "input": ["..."], "labels": ["a", "b"] }
# Jina ඛණ්ඩකය
POST /v1/segment { "content": "...", "return_chunks": true }
# Jina සෙවුම (s.jina.ai; provider aliases: jina-search, jina-ai, jina)
POST /v1/search { "query": "...", "provider": "jina-search" }
# මධ්යස්ථකරණය
POST /v1/moderations { "model": "omni-moderation-latest", "input": "..." }
# TTS — audio/mpeg (හෝ ඉල්ලූ ආකෘතියේ) අන්තර්ගතය ආපසු ලබා දෙයි
POST /v1/audio/speech { "model": "openai/tts-1", "input": "Hello", "voice": "alloy" }
# Soniox TTS සඳහා භාෂාවක් සහ හඬක් අවශ්ය වේ: `language` හි පෙරනිමි අගය "en" වේ; voice එකක් නොමැති නම්
# හෝ OpenAI හි පෙරනිමි voice නාමයක් (alloy, nova, …) ලබා දී ඇත්නම් එය "Adrian" බවට පත් වේ
POST /v1/audio/speech { "model": "soniox/tts-rt-v1", "input": "Xin chào", "voice": "Adrian", "language": "vi" }
# රූප සංස්කරණය (multipart)
POST /v1/images/edits -F image=@input.png -F prompt="..." -F mask=@mask.png
# වීඩියෝ / සංගීත උත්පාදනය (provider-prefixed model id)
POST /v1/videos/generations { "model": "runway/gen-3", "prompt": "..." }
POST /v1/music/generations { "model": "kie/suno-v4.0", "prompt": "..." }
Rerank සැපයුම්කරු නෝඩ්:
POST /v1/rerankමඟින්<node-prefix>/<model>ලෙස ලිපිනගත කර ඇති OpenAI-අනුකූල සැපයුම්කරු නෝඩ් (oMLX, vLLM, Infinity, gateway එකක් පිටුපස ඇති TEI, …) වෙතද මාර්ගගත කරයි. Loopback නෝඩ් (localhost,127.0.0.1,172.16.0.0/12) සැමවිටම සුදුසු වන අතර,OMNIROUTE_LOCAL_PROVIDER_NODE_HOSTSහි ක්රියාකරු ලැයිස්තුගත කරන hostname ද එසේම සුදුසු වේ (උදාහරණයක් ලෙසhttp://reranker:8080/v1වැනි Docker/Compose සේවා නාමයක්; මේවා සෘජුවම අමතනු ලබන අතර, කිසිවිටෙකHTTP(S)_PROXYහරහා හෝ සම්බන්ධතාවයක නියම කර ඇති proxy එක හරහා නොයයි). වෙනත් ඕනෑම host එකක ඇති නෝඩ් — LAN පරිගණකයක් හෝ Tailscale peer එකක් — ක්රියාකරු විසින්RERANK_REMOTE_PROVIDER_NODESfeature flag එක සක්රීය කළ විට සහ නෝඩයේ මූලික URL එක provider outbound URL ප්රතිපත්තිය (OMNIROUTE_ALLOW_LOCAL_PROVIDER_URLS/OMNIROUTE_ALLOW_PRIVATE_PROVIDER_URLS) සපුරාලන විට පමණක් සුදුසු වේ. Memory engine හි rerank පියවර මෙම route එක loopback හරහා අමතන බැවින්, Memory settings හි ඇතිrerankProviderModelසඳහාද එම නීතියම බලපායි.දේශීය server හැඩතල: නෝඩය
<base>/v1/rerankවෙතත්, 404 ලැබුණහොත්<base>/rerankවෙතත් අමතනු ලබයි (Infinity, TEI). upstream body එකෙහි Cohere/OpenAI අක්ෂර වින්යාසය (documents,return_documents) සහ TEI අක්ෂර වින්යාසය (texts,return_text) යන දෙකම අඩංගු වන අතර, upstream response එක Cohere envelope එකට සාමාන්යකරණය කරනු ලබයි: TEI හි bare[{index, score, text}], සිහින් gateway වලින් ලැබෙන{results: [{index, score}]}, සහ Voyage ආකාරයේ{data: [...]}යන සියල්ල client වෙත{results: [{index, relevance_score, document?}]}ලෙස, score අනුව වර්ගීකරණය කරtop_nදක්වා සීමා කර ආපසු ලැබේ.
සැපයුම්කරු-නෝඩ් සොයාගැනීම: OpenAI-අනුකූල සැපයුම්කරු නෝඩයක ඇති models, නෝඩ් prefix එක යටතේ
GET /v1/modelsතුළ දිස්වේ. endpoint metadata නොමැති rows (දේශීය/v1/modelsලැයිස්තුගත කිරීම් සඳහා සාමාන්ය) නෝඩයේapiTypeඅගය උරුම කරගනී. එබැවින්embeddingsනෝඩයක modelstype: "embedding"ලෙසත්,rerankනෝඩයක modelstype: "rerank"ලෙසත් සලකනු ලබන අතර, පෙරනිමියෙන් chat ලෙස නොසලකයි; synchronized හෝ අතින් එක් කළ row එකක පැහැදිලිsupportedEndpointsතිබේ නම් එයට තවමත් ප්රමුඛත්වය ලැබේ.
කැපවූ සැපයුම්කරු මාර්ග
POST /v1/providers/{provider}/chat/completions
POST /v1/providers/{provider}/embeddings
POST /v1/providers/{provider}/images/generations
නොමැති නම් provider prefix එක ස්වයංක්රීයව එක් කරනු ලබයි. නොගැළපෙන models සඳහා 400 ආපසු ලැබේ.
Files API
කණ්ඩායම් ආදානය/ප්රතිදානය සහ ගොනු-අරමුණු උඩුගත කිරීම් සඳහා OpenAI-අනුකූල ගොනු endpoint එක.
| Method | Path | Description |
|---|---|---|
| POST | /v1/files |
ගොනුවක් උඩුගත කරන්න (multipart: file, purpose, expires_after[anchor], expires_after[seconds]) — උපරිමය 512 MiB |
| GET | /v1/files |
සත්යාපිත API යතුර සඳහා ගොනු ලැයිස්තුගත කරන්න |
| GET | /v1/files/[id] |
ගොනුවක පාර-දත්ත ලබා ගන්න |
| DELETE | /v1/files/[id] |
ගොනුවක් මකන්න |
| GET | /v1/files/[id]/content |
අමු ගොනු අන්තර්ගතය ප්රවාහනය කර ආපසු ලබා දෙන්න |
Auth: Bearer API යතුර — getApiKeyRequestScope හරහා ගොනු එක් එක් API යතුර අනුව සීමා කෙරේ. එක් යතුරකට එහිම ගොනු පමණක් දැකීමට, බාගත කිරීමට සහ මැකීමට හැකිය; යතුරක් නොමැති dashboard සැසියකට සම්පූර්ණ instance එක කියවිය හැකිය; හිමිකරුවෙකු නොමැති ගොනුවක් (නිර්නාමික හෝ dashboard-සැසි උඩුගත කිරීමක්) කිසිදු non-session caller කෙනෙකුට අවසර නොදේ. GET /v1/files නිර්නාමික caller කෙනෙකු — සහ resolve නොවන ඉදිරිපත් කළ යතුරක් — REQUIRE_API_KEY=false වූ විට පවා, 401 සමඟ ප්රතික්ෂේප කරයි. එමඟින් සෑම tenant එකකම ගොනු ලැයිස්තුගත වීම වළක්වයි (GHSA-m3hp-hq9g-fpmv, GHSA-2jm2-mpx8-6523).
Batches API
OpenAI-අනුකූල කණ්ඩායම් සැකසීම.
| Method | Path | Description |
|---|---|---|
| POST | /v1/batches |
කණ්ඩායමක් සාදන්න — සිරුර v1BatchCreateSchema (input_file_id, endpoint, completion_window) මගින් වලංගු කෙරේ |
| GET | /v1/batches |
කණ්ඩායම් ලැයිස්තුගත කරන්න |
| GET | /v1/batches/[id] |
කණ්ඩායම් තත්ත්වය + request_counts ලබා ගන්න |
| DELETE | /v1/batches/[id] |
අවසන් වූ/අසාර්ථක වූ කණ්ඩායමක් මකන්න |
| POST | /v1/batches/[id]/cancel |
ප්රගතියේ පවතින කණ්ඩායමක් අවලංගු කරන්න |
Auth: Bearer API යතුර. Batches, files සඳහා වන එම තුන්-මාර්ග නීතිය යටතේ එක් එක් API යතුර අනුව සීමා කෙරේ: තමන්ගේම යතුරට පමණක්, dashboard සැසියට instance-පුරාම, null-owner වාර්තා සෑම non-session caller කෙනෙකුටම ප්රතික්ෂේප කෙරේ (retrieve, delete, cancel සහ create මත ඇති input_file_id පරීක්ෂාව සඳහා). GET /v1/batches නිර්නාමික caller කෙනෙකු REQUIRE_API_KEY=false වූ විට පවා 401 සමඟ ප්රතික්ෂේප කරයි.
API සොයන්න
Web/search සපයන්නා වියුක්ත කිරීම (Tavily, Brave, Exa, Serper, ආදිය).
| ක්රමය | මාර්ගය | විස්තරය |
|---|---|---|
| GET | /v1/search |
වින්යාසගත සෙවුම් සපයන්නන්ගේ + හැකියාවන් ලැයිස්තුගත කරන්න |
| POST | /v1/search |
v1SearchSchema මගින් වලංගු කරන ලද සෙවුම් විමසුමක් — ශරීරය ධාවනය කරන්න, caching/coalescing සඳහා සහය දක්වයි |
| GET | /v1/search/analytics |
එක්-සැපයුම්කරු hit/latency/cache සංඛ්යා ලේඛන |
සත්යාපනය: දරන්නා API යතුර (extractApiKey + isValidApiKey). සෙවුම් ප්රතිපත්තිය enforceApiKeyPolicy හරහා බලාත්මක කර ඇත.
ස්වයං-තේරීම: provider නොමැතිව, වින්යාසගත සම්බන්ධතාවයක් සහිත ලාභම සැපයුම්කරු පළමුව ක්රියාත්මක වන අතර ඊළඟ ලාභම අසාර්ථකත්වය වේ. නොමිලේ අවසන් සේවා සපයන්නන් (duckduckgo-free) භාවිතා කරනු ලබන්නේ වෙනත් කිසිවක් වින්යාස කර නොමැති විට පමණි. ස්වයං-සත්කාරක SearXNG එහි සම්බන්ධතාවය සැබෑ baseUrl ගබඩා කළ පසු වින්යාස කළ ලෙස ගණන් ගනු ලැබේ (නාමාවලිය පෙරනිමි http://localhost:8888/search නොවේ): එය පසුව යතුරු කරන ලද ඒවාට වඩා $0 සපයන්නෙකු ලෙස ශ්රේණිගත වේ, SearXNG 400, 401, 40403 වලංගු නොවන පිළිතුරු baseUrl, අසාර්ථක ලෙස ලාභම යතුරු සපයන්නා සමඟ ශ්රේණිගත වේ URL http(s) වලාකුළු-පාර-දත්ත ලිපිනයක ඇති ලකුණු ගණන් නොගනී. ටෝකනයක් ගබඩා කරන SearXNG සම්බන්ධතාවයක් මේ ආකාරයෙන් ශ්රේණිගත වන්නේ https:// හෝ loopback http:// හරහා පමණි. දුරස්ථ සරල http:// හරහා එය කිසිවිටෙක අසාර්ථක නොවන අතර අවසාන විසඳුම ලෙස පවතී, වෙනත් කිසිදු සැපයුම්කරුවෙකු වින්යාස කර නොමැති විට හෝ නමෙන් ඉල්ලා සිටින විට පමණක් භාවිතා කරයි, එබැවින් එය එම අවස්ථා දෙකේදී පැහැදිලි පෙළකින් ටෝකනය යවයි.
Exa සහ Tavily provider_options
Exa සහ Tavily නම් පරතරය සහිත බෑගයකින් සපයන්නා-විශේෂිත ක්ෂේත්ර කියවන්න: provider_options.exa (හෝ provider_options["exa-search"]) සහ provider_options.tavily (හෝ provider_options["tavily-search"]). පහත යතුරු පමණක් යොමු කෙරේ. සෑම එකක්ම open-sse/handlers/search/providerOptionsPassthrough.ts හි තමන්ගේම Zod යෝජනා ක්රමයට එරෙහිව පරීක්ෂා කරනු ලබන අතර, වැරදි වර්ගය සහිත යතුරක් හෙළනු ලැබේ. auth, base URL, stream සහ outputSchema ඇතුළුව වෙනත් ඕනෑම යතුරක් නොසලකා හරිනු ලැබේ. වෙනත් සපයන්නන් විසින් භාවිතා කරන පැතලි යතුරු (cx, depth, ...) පෙර පරිදිම ක්රියා කරයි.
| සපයන්නා | ඉහළ මට්ටමේ ක්ෂේත්ර | කූඩු කළා |
|---|---|---|
| Exa | type, category, userLocation, moderation, additionalQueries, objective, systemPrompt, compliance (පැතලි ප්රාථමික), startPublishedDate, endPublishedDate |
contents.{text, highlights, summary, extras, livecrawlTimeout, maxAgeHours} පෙරනිමි { text: true, highlights: true } හරහා ඒකාබද්ධ විය |
| ටවිලි | search_depth, chunks_per_source, time_range, start_date, end_date, include_published_date, filter_by_published_date, include_answer, include_raw_content, include_images, include_image_descriptions, include_favicon, include_domains_mode, language, filter_by_language, auto_parameters, exact_match, include_usage, safe_search |
— |
සාමාන්ය ක්ෂේත්ර සැමවිටම ජය ගනී: query, max_results, filters (වසම්), country සහ search_type වෙතින් ව්යුත්පන්න වූ මාතෘකාව. Exa හි, search_type: "news" category: "news" තබා ගනී. Tavily search_type: "finance" (topic: "finance") ද පිළිගනී.
ෆයර්ක්රෝල් සෙවුම් පිරිවැය වාර්තා කරන ලද ප්රතිඵල 10 කින් ආරම්භ කරන ලද කොටසකට, වාරිකයකට ඩොලර් 0.002 (බැර 2) සහ ඇමතුමකට අවම වශයෙන් එක් වාරණ ( ෆයර්ක්රෝල් බිල්පත් ): 11 ප්රතිඵල සඳහා ඩොලර් 0.004 ක් වැය වේ.
සාමාන්ය time_range දැන් සපයන්නන් දෙදෙනාටම ළඟා වේ: Exa හට startPublishedDate (ISO වේලා මුද්රාව) සහ Tavily start_date (YYYY-MM-DD) ලබා ගනී. provider_options හි පැහැදිලි දිනයක් සිතියම්ගත කළ දිනය අභිබවා යයි.
Exa ප්රතිඵල id, highlights (සෑම උද්දීපනයක්ම, snippet ලෙස භාවිතා කරන පළමු එක පමණක් නොවේ), highlight_scores, summary, subpages, entities සහ extras provider_raw හි තබා ගනී. Tavily ප්රතිඵල images සහ favicon තබා ගන්න.
Linkup සෙවුම් පිරිවැය depth fast සහ standard සඳහා $0.005 සහ deep සඳහා $0.05 ( Linkup මිලකරණය ), depth පැමිණෙන්නේ provider_options හෝ සම්බන්ධතා සැකසුම් වලින් වුවද.
Exa type: "lite" (Exa 3.0) කුඩා ක්ෂේත්ර කට්ටලයක් පිළිගන්නා අතර වෙනත් ඕනෑම ක්ෂේත්රයක් සකසා ඇති විට සම්පූර්ණ ඉල්ලීම ප්රතික්ෂේප කරයි. lite සඳහා, additionalQueries, systemPrompt සහ text සහ highlights හැර සෑම contents යතුරක්ම ඇමතුමට පෙර අත්හරිනු ලැබේ. අත්හරින ලද subpages, subpageTarget, highlights.numSentences සහ highlights.highlightsPerUrl තවදුරටත් යොමු නොකෙරේ.
පිරිවැය ගිණුම්කරණය යනු Exa ගේම මිලකරණය අනුගමනය කරන Exa හැර, පැතලි රෙජිස්ට්රි costPerQuery වේ: auto සඳහා ඇමතුමකට $0.007 (සහ උරුමය fast) හෝ lite සඳහා $0.004 (සහ උරුමය instant), ප්රතිඵල 10ක් ආවරණය කරයි; එක් එක් ප්රතිඵලයක් සඳහා $0.001; සහ contents.summary සකසා ඇති විට ලැබෙන ප්රතිඵලයකට $0.001. Tavily search_depth basic, fast සහ ultra-fast සඳහා ණය 1 ($0.008) ලෙසත්, advanced සඳහා ණය 2 ($0.016) ( Tavily API ණය ) ලෙසත් සටහන් වේ. Tavily උසස් වෙත උත්ශ්රේණි කරන auto_parameters: true සහිත ඇමතුමක් තවමත් ණය 1කින් වාර්තා වේ.
Web Fetch API
වින්යාස කළ web-fetch provider එකක් (Firecrawl, Jina Reader, Tavily Extract, TinyFish Fetch, Nimble Extract, Parallel Extract) හරහා URL එකකින් අන්තර්ගතය උපුටා ගන්න.
Parallel Extract (parallel-search, Parallel Search සඳහා භාවිත කරන API key එකම) ලබා දෙන්නේ Markdown
පමණි — වෙනත් ඕනෑම format එකක් 400 දෝෂයකට හේතු වේ — සහ අන්තර්ගතය අක්ෂර 100,000කට සීමා කරයි. ඉලක්ක පිටුවම උපුටා ගත නොහැකි විට, upstream සේවාව එය HTTP 200ක් ඇතුළත වාර්තා කරයි;
OmniRoute එය ස්ථාවර පණිවිඩයක් සහිත 422 ලෙස ඉදිරිපත් කරයි.
| ක්රමය | මාර්ගය | විස්තර |
|---|---|---|
| POST | /v1/web/fetch |
URL එක fetch/scrape කිරීම — body එක v1WebFetchSchema මගින් වලංගු කරයි |
Auth: Bearer API key (extractApiKey + isValidApiKey). ප්රතිපත්තිය enforceApiKeyPolicy හරහා බලාත්මක කරයි.
Quota-aware fallback (#8297): පැහැදිලි provider එකක් ලබා නොදුන් විට, pool එක
(firecrawl → jina-reader → tavily-search → tinyfish → nimble-search →
parallel-search) ස්ථාවර
ප්රමුඛතා අනුපිළිවෙළකින් (fill-first) පරීක්ෂා කරයි — rate-limited නමුත් වින්යාස කර ඇති provider එකක් request එක කෙටි කර නතර කිරීම වෙනුවට මඟ හරියි, සහ නැවත උත්සාහ කළ හැකි/quota upstream failure එකක් (HTTP 429 සැමවිටම; Firecrawl/Tavily/TinyFish quota ආකාරයේ free tiers සඳහා 402/403 —
Jina Reader සඳහා නොවේ, සහ සාමාන්ය 400 bad request එකක් සඳහා කිසිවිටෙක නොවේ) request කරන අවස්ථාවේදී තවමත් උත්සාහ නොකළ credential සහිත ඊළඟ provider වෙත යොමු කරයි. Pool එකේ සෑම provider එකක්ම අවසන් වූ විට, endpoint එක පෙර තිබූ සාමාන්ය 400 වෙනුවට Retry-After header එකක් සහිත තනි 429 එකක් ලබා දෙයි. පැහැදිලි provider එකක් ඉල්ලා ඇති විට, නිහඬ fallback එකක් නොමැත — rate-limited හෝ අසාර්ථක වූ පැහැදිලි provider එක තමන්ගේම දෝෂය ඉදිරිපත් කරයි (rate-limited නම් 429, එසේ නොමැතිනම් upstream status එක).
WebSocket Streaming
GET /v1/ws?handshake=1
WebSocket upgrade handshake එකක් වලංගු කර wire protocol උදාහරණ පණිවිඩ (request, cancel) ලබා දෙයි. සැබෑ WS frames Next.js route table එකෙන් පිටත bundled WS server එක මගින් හසුරුවයි.
Auth: handshake අතරතුර Bearer API key.
WebSocket හරහා Responses API (codex පමණි)
# HTTP API එකේම host:port එක (පෙරනිමිය 20128); සම්බන්ධතාව upgrade කරන්න:
wscat -c "ws://localhost:20128/v1/responses?api_key=<OMNIROUTE_API_KEY>"
# (හෝ: -H "Authorization: Bearer <OMNIROUTE_API_KEY>")
# පළමු frame එක අනිවාර්යයෙන්ම response.create විය යුතුය:
{ "type": "response.create", "model": "gpt-5.5", "input": [ { "role": "user", "content": "hi" } ] }
Responses-API-over-WebSocket proxy එක codex වෙත පමණක් (ChatGPT backend) විශේෂයෙන් සම්බන්ධ කර ඇත. එය API/dashboard එකට සමාන port එකේ /v1/responses,
/responses, සහ /api/v1/responses යන paths මත අසයි. පළමු response.create frame එකේදී එය අභ්යන්තර codex-responses-ws bridge එක හරහා authenticate + prepare කර, codex OAuth connection එකක් තෝරා, wreq-js transport එක හරහා
wss://chatgpt.com/backend-api/codex/responses වෙත tunnel කරයි. codex නොවන models ප්රතික්ෂේප කරයි (codex_ws_provider_required).
Quota-share routing සඳහා model: "qtSd/<group>/codex/<model>" භාවිත කරන්න. මෙය
app/server-ws.mjs + scripts/dev/responses-ws-proxy.mjs + src/app/api/internal/codex-responses-ws/route.ts තුළ ක්රියාත්මක කර ඇත.
Auth: handshake අතරතුර Bearer API key. Bundled HTTP server (server-ws.mjs)
සක්රිය entrypoint එක විය යුතුය (app/server-ws.mjs පවතින විට පෙරනිමියෙන් එය එසේ වේ).
Model id: bare ChatGPT id එක භාවිත කරන්න (codex/ prefix එකක් නොමැතිව)
OpenAI Codex CLI එක supports_websockets = true වූ විට model name එක client-side වලංගු කරයි, සහ codex/gpt-5.5 වැනි provider-prefixed ids ප්රතික්ෂේප කරයි (The 'codex/gpt-5.5' model is not supported when using Codex with a ChatGPT account). Bare id එක යවන්න (උදා: gpt-5.5). OmniRoute හි bridge එක codex-only බැවින්, upstream වෙත tunnel කිරීමට පෙර එය bare id එකක් codex model එකක් ලෙස නැවත විසඳයි
(resolveCodexWsModelInfo) — එසේ නොවුවහොත් bare gpt-5.5 HTTP හරහා වෙනත් provider එකකට යොමු වනු ඇත.
OpenAI Codex CLI වින්යාස කිරීම
WebSocket සහාය සහිත custom provider එකක් ~/.codex/config.toml වෙත එක් කිරීමෙන් Codex CLI එක OmniRoute වෙත යොමු කරන්න (පවතින config එකකට බලපෑමක් නොවන පරිදි වෙනම CODEX_HOME එකක් භාවිත කරන්න):
model = "gpt-5.5" # bare id — "codex/gpt-5.5" නොවේ
model_provider = "omniroute"
[model_providers.omniroute]
name = "OmniRoute (WS)"
base_url = "http://localhost:20128/v1" # අවසාන slash එකක් නොමැත; WS URL එක ව්යුත්පන්න කරයි (production තුළ https/wss භාවිත කරන්න)
wire_api = "responses" # Feb 2026 සිට සහාය දක්වන එකම අගය
supports_websockets = true # Responses-over-WS transport එක සක්රිය කරයි
env_key = "OMNIROUTE_API_KEY" # OmniRoute API key (Bearer) තබා ගනී
export OMNIROUTE_API_KEY=sk-... # OmniRoute API key එකක් (REQUIRE_API_KEY=false නම් ඕනෑම key එකක්)
codex exec "Responda apenas: PONG"
CLI එක base_url + /responses WebSocket එකක් බවට upgrade කර, OmniRoute එය තෝරාගත් codex OAuth connection එක වෙත tunnel කරයි. දේශීය server එකට එරෙහිව end-to-end වලංගු කර ඇත: ChatGPT codex.rate_limits + response.created ලබා දී completion එක stream කරයි.
කෝටා සහ ගැටලු වාර්තාකරණය
| ක්රමය | මාර්ගය | විස්තරය |
|---|---|---|
| GET | /v1/quotas/check |
ලියාපදිංචි කළ යතුරක් නිකුත් කිරීමට පෙර provider + accountId සඳහා කෝටාව පූර්ව වලංගු කිරීම |
| POST | /v1/issues/report |
GitHub වෙත කෝටා/යතුරු නිකුත් කිරීමේ අසාර්ථකත්වයක් වාර්තා කිරීම (GITHUB_ISSUES_REPO + ටෝකනය අවශ්ය වේ) |
සත්යාපනය: Bearer API යතුර (isAuthenticated).
කෝටා සැසිය ප්රතිසාධනය (විකල්පයෙන් සක්රීය කළ හැක)
ප්රවාහගත නොවන POST /v1/chat/completions හෝ POST /v1/responses ඉල්ලීමක්
අවසන් කෝටා දෝෂයකින් (402/429/503, එහි body එකේ කෝටාව හෝ credits අවසන් වී ඇති බව සඳහන් වන විට)
අසාර්ථක වුවහොත්, දෝෂය ආපසු ලබා දීම වෙනුවට එය තාවකාලිකව තබා පසුව නැවත ධාවනය කළ හැක. ඉල්ලීම්කරු එක් එක්
ඉල්ලීම සඳහා පහත headers තුන සමඟ මෙය සක්රීය කරයි:
| Header | අගය |
|---|---|
x-omniroute-quota-recovery |
auto |
x-omniroute-session |
සැසි id, [A-Za-z0-9._:-]{1,128} |
x-omniroute-recovery-turn |
සැසිය තුළ අනන්ය turn id (එම නීතියම) |
stream: false වන, tools, tool history හෝ previous_response_id නොමැති, සහ
x-omniroute-connection pin එකක් නොමැති turns පමණක් සුදුසු වන අතර, STORAGE_ENCRYPTION_KEY සකසා තිබිය යුතුය
(ඉල්ලීම පැය 24ක් දක්වා සංකේතනය කර ගබඩා කරනු ලැබේ). එවිට ප්රතිචාරය
202 සහ recovery.poll සමඟ ලැබේ; GET /v1/quota-recoveries/{id} මඟින් විමසන්න (pending අතරතුර 202,
සම්පූර්ණ වූ විට ප්රතිසාධනය කළ body එක සමඟ 200) හෝ DELETE මඟින් අවලංගු කරන්න. ටිකට්පත් සෑදූ API
යතුරට පමණක් දෘශ්ය වේ. ප්රතිඵලය අවිනිශ්චිත වන නැවත ධාවනයක් දෙවරක් යැවීම වෙනුවට
needs_confirmation තත්ත්වයෙන් අවසන් වේ. මූලාශ්රය: src/lib/quota/quotaSessionRecovery.ts.
ස්වයං සේවා භාවිතය (/api/usage/om-usage)
ඕනෑම API යතුරක් කියවිය හැක** තමන්ගේම** භාවිතය සහ කෝටා — කළමනාකරණ සත්යාපනය නැත. සේවාලාභියෙකු (CLI, OmniCopilot පැනලය) යතුරු දරන්නෙකුට තම වියදම් පෙන්වීමට භාවිතා කරන අවසාන ලක්ෂ්යය මෙයයි.
# Text form (the historical contract — plain text for a terminal)
curl -H "Authorization: Bearer <your-api-key>" \
http://localhost:20128/api/usage/om-usage
# Structured form — what a UI consumes
curl -H "Authorization: Bearer <your-api-key>" \
"http://localhost:20128/api/usage/om-usage?format=json"
යතුර තිබිය යුතුය**allowUsageCommand** සබල කර ඇත (පෙරනිමියෙන් අක්රියයි — උපකරණ පුවරුවේ API-යතුරු කළමනාකරු එය යතුරකට ටොගල් කරයි). එය නොමැතිව අවසාන ලක්ෂ්යය පිළිතුරු දෙයි 403.
?format=json වෙනස් කොට සැලකූ හැඩයක් ලබා දෙයි, එබැවින් ඇමතුමක් ලබා දෙන්නෙකු ප්රතික්ෂේප කිරීමකින් දත්ත ක්ෂේත්රයක් කිසි විටෙක කියවන්නේ නැත. සාර්ථකත්වය මත:
{
"allowed": true,
// present only when the key opted into per-key usage limits (daily/weekly/5-hour USD):
"personal": {
"dailySpentUsd": 1.25,
"dailyLimitUsd": 5,
"dailyResetAtIso": "…",
"weeklySpentUsd": 8,
"weeklyLimitUsd": 20,
"weeklyResetAtIso": "…" /* … */,
},
// the selected provider quota snapshot, or null when nothing is cached yet:
"provider": { "connectionId": "…", "provider": "claude", "plan": "…", "quotas": {/* … */} },
// every connection's snapshot, so a UI can render several providers side by side:
"providers": [
{ "connectionId": "…", "provider": "claude" /* … */ },
{ "provider": "codex" /* … */ },
],
}
ප්රතික්ෂේප කිරීමේදී (401 නරක යතුර / 403 අවසර නැත) එම මාර්ගයම { "allowed": false, "error": { "message": "…" } } — වත්මන්-නමුත්-හිස් personal/provider (යතුර අවසර දී ඇත, තවම කිසිවක් ඉගෙන ගෙන නැත) ප්රතික්ෂේප කිරීමකින් වෙනස් තත්වයක් වන අතර JSON ආකෘතිය පමණක් ඒවා වෙන්කර හඳුනා ගනී.
සත්යාපනය: අමතන්නාගේම Bearer API යතුර, isValidApiKey — සමඟ වලංගු වන මෙය not කළමනාකරණ මතුපිට (/api/keys/…) වේ, එය requireManagementAuth පිටුපසින් පවතී.
අමු එදිරිව කඩඉම්-ගැළපුම් කෝටා ප්රතිශතය
/api/usage/om-usage පරිභෝජනය කරන විට, අමතන්නන් විසින් ඉදිරිපත් කරන ලද ප්රතිශත අතර වෙනස සටහන් කළ යුතුය** සරල පෙළ ප්රතිදානය** සහ ව්යුහගතJSON ප්රතිදානය :
| පැතිකඩ | සරල පෙළ ආකෘතිය (/api/usage/om-usage / @@om-usage) |
JSON ආකෘතිය (?format=json) |
|---|---|---|
| ප්රතිදාන ක්ෂේත්රය | NN% left (උදා, 20% left) |
provider.quotas / providers[].quotas |
| මැනීම | කඩඉම් ගැලපුම් භාවිතා කළ හැකි දීමනාව : කැපුම් සීමාවට ඉහලින් ඉතිරි ධාරිතාව | Raw upstream කෝටාව : සකස් නොකළ සැපයුම්කරු මැනීම |
| කඩඉම් පරිමාණය | effectiveRemainingPercent() හරහා පරිමාණය කර ඇති නිසා ආරක්ෂිත රක්ෂිතය 0% left ලෙස කියවේ |
කිසිවක් නැත (සැපයුම්කරු විසින් වාර්තා කර ඇති පරිදි raw snapshot අගයන්) |
| සීමාව දත්ත | ප්රදර්ශනය කරන ලද ප්රතිශතයට ඇතුළත් කර ඇත | එක් සම්බන්ධතාවයකට quotaWindowThresholds හි ගබඩා කර ඇත (හෝ සේවාදායක පෙරනිමිය) |
| ප්රාථමික පාරිභෝගිකයා | අන්තර් ක්රියාකාරී CLIs, පර්යන්ත විමසුම්, මානව ක්රියාකරුවන් | ක්රමලේඛන ඒකාබද්ධ කිරීම්, උපකරණ පුවරු, විශ්ලේෂණ, බිල්පත් ට්රැකර් |
කඩඉම් ගැලපුම් සූත්රය
OmniRoute උඩුගං විඩාව වැලැක්වීමට ක්රියාශීලී කෝටා කඩඉම් සඳහා සහය දක්වයි (සම්බන්ධතාවය quotaWindowThresholds, සැපයුම්කරු පෙරනිමි හෝ ගෝලීය ඔරොත්තු දීමේ සැකසුම් හරහා වින්යාස කර ඇත). කඩඉම් එළිපත්තක් (උදා, cutoff = 25%) කෝටා කවුළුවක ක්රියාත්මක වන විට, පෙළ විදැහුම්කරු ඉතිරි දීමනාව මෙසේ ගණනය කරයි:
remaining <= cutoffනම්:0%ආපසු ලබා දෙයි.remaining > cutoffනම්:((remaining - cutoff) / (100 - cutoff)) * 100ආපසු ලබා දෙයි.
ෆෝමැට් කරන ලද පෙළ ප්රතිදානය මෙය ආසන්නතම පූර්ණ සංඛ්යාවට වට කරයි (Math.round(...)).
නිදර්ශන උදාහරණය
සමඟ සැපයුම්කරු කවුළුවක් සලකා බලන්න** 60% අමු භාවිතය** (එබැවින්** 40% අමු ඉතිරි කෝටාව** ) සහ වින්යාස කර ඇත** 25% ඉතිරි-කෝටා කප්පාදුව** එළිපත්ත:
| නියෝජනය | ගණනය කිරීම | ඉතිරි | ව්යංගයෙන් භාවිතා කරන ලදී |
|---|---|---|---|
අමු JSON (?format=json) |
Upstream snapshot (quotas[window]) |
40% | 60% |
පෙළ ආකෘතිය (NN% left) |
((40 - 25) / (100 - 25)) * 100 = (15 / 75) * 100 |
20% | 80% ( 100 - remaining ගණනය කරන්නේ නම්) |
- පෙළ 20% ඉතිරිව ඇත්තේ ඇයි: ගිණුමේ ඉතිරිව ඇති 40% භෞතික කෝටාවෙන් 25% කඩඉම් ප්රතිපත්තිය මගින් වෙන් කර ඇත. රවුටරය මෙම සබැඳුම වෙත ගමන් කිරීම නැවැත්වීමට පෙර ඇමතුම්කරුට ඉතිරිව ඇත්තේ 75% භාවිත කළ හැකි හිස් කාමරයෙන් 15%ක් පමණි. පරිමාණ කිරීම මඟින් මාර්ගගත කිරීම නතර වන විට සම්බන්ධතා සංඥා ක්ෂය වීම (
0% left) සහතික කරයි. - JSON අමු අගයන් ආරක්ෂා කරන්නේ ඇයි: JSON ගෙවීමේ ප්රමාණය නිශ්චිත සැපයුම්කරුගේ ස්නැප්ෂොට් (
UsageSnapshot) ලබා දෙයි, එබැවින් බාහිර මෙවලම්වලට සර්වර්-පාර්ශ්වික පාඩු සහිත පරිමාණයකින් තොරව භූ-සත්ය උඩු යටිකුරු භාවිතය සහ සම්බන්ධතා මට්ටමේquotaWindowThresholdsවෙත ප්රවේශය ඇත.
පාරිභෝගික සංක්රමණ මාර්ගෝපදේශය
බාහිර අනුකලනයක් (සංස්කාරක ප්ලගිනයක් හෝ නියෝජිත දිගුවක් වැනි) පෙර පෙළ අන්ත ලක්ෂ්යය (NN% left) ඉවත් කර භාවිත කළ ප්රතිශතය 100 - NN ලෙස ගණනය කළේ නම්, ?format=json වෙත සංක්රමණය වීම යනු:
- raw JSON අගයන් කියවීමෙන් පිළිබිඹු වේ** සැබෑ උඩුගත පරිභෝජනය** (ඉහත උදාහරණයේ 60% භාවිතා කර ඇත).
- අනුකලනයට පෙළ අන්ත ලක්ෂ්යයේ භාවිත කළ හැකි දීමනා අර්ථකථනය ආරක්ෂා කිරීමට අවශ්ය නම්, සම්බන්ධතා මට්ටමේ අභිබවා යාම සඳහා
quotaWindowThresholdsභාවිතයෙන් ඵලදායී ඉතිරි සූත්රය සේවාදායක පැත්ත ඇගයීමට ලක් කළ හැක.
සෙමැන්ටික් කෑෂය
# කෑෂ් සංඛ්යාලේඛන ලබා ගන්න
GET /api/cache/stats
# සියලුම කෑෂ් හිස් කරන්න
DELETE /api/cache/stats
ප්රතිචාර උදාහරණය:
{
"semanticCache": {
"memorySize": 42,
"memoryMaxSize": 500,
"dbSize": 128,
"hitRate": 0.65
},
"idempotency": {
"activeKeys": 3,
"windowMs": 5000
}
}
ප්රමාදයට ඇති බලපෑම
සෙමැන්ටික් කෑෂයක HIT එකක් ප්රතිචාරය කෑෂයෙන් සපයන්නේ upstream
ඇමතුමක් නොකරමිනි, එබැවින් වාර්තා කරන ලද
X-OmniRoute-Response-Latency අගය මුල් upstream ප්රමාදය නොසලකා
ශුන්යයට ආසන්න වේ. ප්රමාදයට සංවේදී සේවාදායකයන්
(මිණුම්කරණය, p50/p99 නිරීක්ෂණය) ප්රතිචාර ශීර්ෂයේ ඇති
X-OmniRoute-Cache-Latency පරීක්ෂා කළ යුතුය:
| අගය | අර්ථය |
|---|---|
synthetic |
ප්රතිචාරය කෑෂයෙන් සපයන ලදී; ප්රමාදය සැබෑ upstream කාලය නොවේ |
| (නොමැත) | සැබෑ upstream ඇමතුමකින් ලැබුණු ප්රතිචාරය |
එක් යතුරකට කෑෂ් මඟහැරීම
cacheDefaultMode හරහා API යතුරුවලට සෙමැන්ටික් කෑෂ් කියවීම්වලින් ඉවත් විය හැක:
| අගය | හැසිරීම |
|---|---|
legacy |
සාමාන්ය කෑෂ් හැසිරීම (පෙරනිමිය) |
bypass |
කෑෂ් සෙවීම සම්පූර්ණයෙන් මඟහරින්න; සැමවිටම upstream වෙත යන්න |
යතුර නිර්මාණය කිරීමේදී (POST /api/keys) හෝ යාවත්කාලීන කිරීමේදී (PATCH /api/keys/[id]) සකසන්න:
{ "cacheDefaultMode": "bypass" }
එක් ඉල්ලීමකට කෑෂ් මඟහැරීම
යතුරු සැකසුම් නොසලකා ඕනෑම ඉල්ලීමකට කෑෂය මඟහැරිය හැක:
X-OmniRoute-No-Cache: true
CLIProxyAPI කළමනාකරණ අනුකූලතාව
භාවිත උපකරණ පුවරු Claude සහ Codex දායකත්ව සීමා කියවීමට අමතන
CLIProxyAPI කළමනාකරණ endpoint තුනට OmniRoute ප්රතිචාර දක්වයි
(උදාහරණයක් ලෙස T3 Code හි cliproxy භාවිත-සීමා මූලාශ්රය). සේවාදායකයාගේ මූලික URL එක
OmniRoute වෙත යොමු කර, කළමනාකරණ යතුර ලෙස manage scope එක සහිත API යතුරක් භාවිත කරන්න. මාර්ග
/v0/management/* සහ /api/v0/management/* යන ස්ථානවල සපයනු ලැබේ.
| ක්රමය | මාර්ග | විස්තර |
|---|---|---|
| GET | /v0/management/auth-files |
{ files: [{ id, auth_index, provider, email, disabled, id_token }] } ලෙස Claude සහ Codex OAuth සම්බන්ධතා. ටෝකන නොමැත |
| POST | /v0/management/api-call |
Body { auth_index, method, url, header?, data? }. ගිණුමේ ටෝකනය සමඟ allowlist කර ඇති එක් ඉල්ලීමක් යවා { status_code, body } ආපසු ලබා දෙයි |
| POST | /v0/management/reset-quota |
Body { auth_index }. එක් ගිණුමක සම්බන්ධතා cooldown, model lockouts සහ Codex එක්-scope cooldowns හිස් කරයි |
auth_indexයනු OmniRoute සම්බන්ධතා id එකයි.providerයනුclaudeහෝcodexවේ (OAuth සම්බන්ධතා සඳහා පමණි;anthropicAPI-key provider එක ලැයිස්තුගත නොවේ). Codex සඳහා,id_token.chatgpt_account_idයනු ගබඩා කර ඇති workspace id එක වන අතරplan_typeයනු ගබඩා කර ඇති plan එකයි.api-callයනු සාමාන්ය proxy එකක් නොවේ. එය ClaudeGET https://api.anthropic.com/api/oauth/usageසහ CodexGET https://chatgpt.com/backend-api/wham/usage,GET .../wham/rate-limit-reset-creditsසහPOST .../wham/rate-limit-reset-credits/consumeපමණක් පිළිගනී. ඒ සෑම එකක්ම ගැළපෙන provider එක සහිත ගිණුමක් සඳහා පමණි. වෙනත් ඕනෑම දෙයක් upstream සම්බන්ධ කර නොගෙන403ආපසු ලබා දෙයි. අමතන්නාගේAuthorizationශීර්ෂය ($TOKEN$placeholder එක ඇතුළුව) නොසලකා හරිනු ලැබේ: OmniRoute සම්බන්ධතාවේ access token එක ඇතුළත් කරයි, එය කල් ඉකුත්වීමට ආසන්න නම් පළමුව අලුත් කරයි, සහ allowlist කර ඇති ශීර්ෂ පමණක් (anthropic-beta;OpenAI-Beta,Originator,Chatgpt-Account-Id;Accept,Content-Type) ඉදිරියට යවයි.Chatgpt-Account-Idනොමැති විට ගබඩා කර ඇති workspace id එක පෙරනිමියෙන් භාවිත වේ. ඉල්ලීම් තත්පර 15කට පසු කාලය ඉකුත් වන අතර සම්බන්ධතාවේ proxy එක භාවිත කරයි.reset-quotaමඟින් අවසාන තත්ත්වයන් (banned, expired, credits_exhausted) වෙනස් නොකරයි. නොදන්නාauth_indexඑකක්404ආපසු ලබා දෙයි.
සත්යාපනය: login අක්රිය කර තිබුණද dashboard session එකක් හෝ manage-scoped API key එකක් අවශ්ය වේ
(මෙම මාර්ග ALWAYS_PROTECTED_API_PATHS තුළ ඇත). Inference-only යතුරුවලට 403 ලැබේ. මූලාශ්රය:
src/lib/cliproxyCompat/managementApi.ts.
උපකරණ පුවරුව සහ කළමනාකරණය
කළමනාකරණ මාර්ග (පොදු auth/login හැර /api/* ) වේ** නැත** සාමාන්ය අනුමාන API යතුරු මගින් අවසර දී ඇත. අක්තපත්ර පවුල්, විෂය පථයන් සහ කර්ල් උදාහරණ: කළමනාකරණ සත්යාපනය.
සත්යාපනය
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/auth/login |
POST | ඇතුල් වන්න |
/api/auth/logout |
POST | පිටවීම |
/api/settings/require-login |
GET/POST | පිවිසුම් තත්ත්වය (GET, පොදු). POST මුරපදය සකසයි / පිවිසුම් ටොගල් කරයි: ක්රියාකරු-මුරපදයක් පවතින විට පමණි (උපකරණ පුවරුවේ සැසිය, දේශීය CLI, හෝ පිවිසුම් අක්රිය — API යතුරු සහ oma_ ටෝකන 403 ලබා ගනී ); ඩෑෂ්බෝඩ් සැසියක් මුරපදය ප්රතිස්ථාපනය කිරීමට currentPassword යවයි |
සැපයුම්කරු කළමනාකරණය
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/providers |
GET/POST | සපයන්නන් ලැයිස්තුගත කරන්න / සාදන්න |
/api/providers/[id] |
GET/PUT/DELETE | සැපයුම්කරුවෙකු කළමනාකරණය කරන්න |
/api/providers/[id]/test |
POST | පරීක්ෂණ සැපයුම්කරු සම්බන්ධතාවය |
/api/providers/[id]/models |
GET | සපයන්නාගේ ආකෘති ලැයිස්තුගත කරන්න |
/api/providers/validate |
POST | සපයන්නාගේ වින්යාසය වලංගු කරන්න |
/api/providers/bulk |
POST | ONE සපයන්නා සඳහා API යතුරු තොග වශයෙන් එකතු කරන්න |
/api/providers/import |
POST | විග්රහ කරන ලද CSV/JSON ගොනුවකින් (#6836) විෂමජාතීය සැපයුම්කරුවෙකු LIST ආයාත කරන්න; එක් පේළියක අර්ධ-අසාර්ථක ප්රතිඵල |
/api/provider-nodes* |
විවිධ | සැපයුම්කරු නෝඩ් කළමනාකරණය |
/api/provider-models |
GET/POST/PUT/PATCH/DELETE | අභිරුචි ආකෘති සහ එක්-ආකෘතිය අභිබවා යාම (එකතු කරන්න, යාවත්කාලීන කරන්න, hide/show, මකන්න) |
/api/provider-models/validate-and-add |
POST | කළමනාකරණය-සත්යාපිත, දැඩි-සම්බන්ධතා වලංගුකරණය සහ පරමාණුක අභිරුචි-ආදර්ශ ලියාපදිංචිය; ආදර්ශ වලංගු කිරීම බලන්න |
synced/imported ආකෘති සඳහා, PUT /api/provider-models provider, modelId, සහ maxOutputTokenOverride පිළිගනී: ධන නිඛිලයක් අතින් ප්රතිදාන-ටෝකන් තොප්පිය සකසයි, සහ පෙරනිමිය ප්රතිසාධනය කිරීමට null එය හිස් කරයි. GET /api/provider-models?provider=<provider> අභිරුචි-ආකෘති පේළියක් නොමැති ආකෘති ඇතුළුව modelOutputOverrides හි මෙම අගයන් ලබා දෙයි. ප්රතික්ෂේප කිරීම ධාවන කාල max_output_tokens හැකියාව භාවිතා කරන අතර ආදර්ශ නැවත සමමුහුර්ත කිරීමකින් බේරෙයි. OpenAI-අනුකූල සැපයුම්කරු පිටුව එකම edit/clear පාලනයන් ලබා දෙන අතර පැහැදිලි දෘෂ්ඨි සහාය ඇතිව ආකෘති සලකුණු කරයි.
ගැළපෙන සපයන්නාගේ නෝඩයක, ලිවීමේ මාර්ග (POST, PUT, PATCH, DELETE සහ /api/provider-models/validate-and-add) ආකෘති හැඳුනුම්පත හිස් උඩුගත id ලෙස ගබඩා කරයි: උපසර්ග ලැයිස්තුවකින් අලවන ලද id එකක node හි ම උපසර්ගයේ කිසියම් ප්රමුඛ පෙළේ තොගයක් ඇති අතර, ගබඩා කළ ප්රතිචාර id එක දෝංකාර දෙයි. කැනොනිකල් සපයන්නන්ගේ slashed ids (උදා nvidia/nemotron-…) වාචිකව ගබඩා කර ඇත. /v1/models කිසිවිටෙක ගොඩගැසූ <prefix>/<prefix>/<model> හැඳුනුම්පතක් නිකුත් නොකරයි.
Custom Chat Completions nodes adapt explicit reasoning opt-outs to the upstream backend. A successful connection test automatically selects chat-template controls for each exact model ID whose /models entry proves a recognized owned_by value: vllm, sglang, or llamacpp. Transparent OpenAI-compatible wrappers may preserve the original model entry inside a nested openai object; detection follows up to three such envelopes. Models with missing, unknown, or conflicting ownership keep ordinary OpenAI behavior. Detection reuses the existing catalog request, generates no completion tokens, and is invalidated when the connection endpoint changes.
එම පාර-දත්ත හෙළි නොකරන පසුබිමක් සඳහා හැසිරීම් සම්බන්ධ කිරීමට, පවතින අර්ධ සැපයුම්කරු යාවත්කාලීන API භාවිතා කරන්න:
{
"providerSpecificData": {
"reasoningControl": "chat-template"
}
}
ඒ ශරීරය PUT /api/providers/<connection-id> සමඟ යවන්න. එම සම්බන්ධය මත, none හි පැහැදිලි තර්කන උත්සාහයක් chat_template_kwargs.thinking=false සහ chat_template_kwargs.enable_thinking=false ලෙස යවනු ලැබේ. සේවාදායක පාර්ශ්ව තර්ක රීතියක් උත්සාහයක් බල නොපාන්නේ නම් මිස පැහැදිලි ස්වදේශීය අච්චු අගයන් අධිකාරී ලෙස පවතී. සැකසුම අදාළ වන්නේ අභිරුචි OpenAI-අනුකූල සම්බන්ධතාවයක් Chat Completions ශරීරයක් යවන විට පමණි; ප්රතිචාර ඉල්ලීම් සහ සාමාන්ය සපයන්නන් ඔවුන්ගේ දේශීය ඉල්ලීම් හැඩය තබා ගනී. සාමාන්ය OpenAI reasoning_effort passthrough බල කිරීමට reasoningControl openai ලෙස සකසන්න, නැතහොත් ස්වයංක්රීය හඳුනාගැනීම භාවිත කිරීමට it/set එය null වෙත අතහරින්න.
Claude කේතය ස්වයංක්රීය මාදිලියේ වර්ගීකාරකය පැහැදිලි තර්ක පාලනයක් නොමැති විට අක්රීය කිරීමට පෙරනිමි ස්වදේශීය චින්තනය ඉල්ලා සිටී. හඳුනාගැනීම ක්ලෝඩ්-ආකෘතියේ ඉල්ලීම් තුළ වර්ගීකරණයේ පද්ධති සලකුණ භාවිතා කරයි, ආකෘති නම් හෝ සම්පූර්ණ කිරීමේ සීමාවන් නොවේ. පැහැදිලි ශරීර පාලනයන්, සහාය දක්වන effort/thinking ශීර්ෂයන්, මාර්ගගත කිරීමේ නීති සහ විසඳන ලද ආදර්ශ උත්සාහයන් ඔවුන්ගේ පවතින ප්රමුඛතාවය තබා ගනී. වර්ගීකරණ අදියර දෙකම ඒවායේ විමසුම්, සම්පූර්ණ කිරීමේ සීමාවන්, නැවතුම් අනුපිළිවෙලවල් සහ සැබෑ උඩු ගංවතුර අවසර විනිශ්චයන් රඳවා තබා ගනී; දෙවන අදියර තවමත් එහි ඉල්ලූ දෘශ්ය තර්කය සාමාන්ය පෙළ ලෙස නිපදවිය හැක.
OAuth ගලා යයි
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/oauth/[provider]/[action] |
විවිධ | සැපයුම්කරු-විශේෂිත OAuth |
මාර්ගගත කිරීම සහ වින්යාස කිරීම
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/models |
GET/PUT | ආකෘති ලැයිස්තුව / අන්වර්ථ යාවත්කාලීන කිරීම |
/api/models/alias |
GET/POST | ආදර්ශ අන්වර්ථ නාම |
/api/models/catalog |
GET | සපයන්නාගේ + වර්ගය අනුව සියලුම මාදිලි |
/api/combos* |
විවිධ | සංයුක්ත කළමනාකරණය |
/api/keys* |
විවිධ | API යතුරු කළමනාකරණය |
/api/pricing |
GET | ආදර්ශ මිලකරණය |
ආදර්ශ සීමාව ප්රභවය
GET /api/models?withLimits=1 ( true; 0/false හෝ එය මඟ හැරීම පෙරනිමි පැටවුම නොවෙනස්ව තබා ගනී) සෑම මාදිලි පේළියකටම contextWindow, maxInputTokens, maxOutputTokens සහ capsSource වස්තුවක් එක් කරයි. capsSource එක් එක් සීමාව සැපයූ රීතිය නම් කරයි, එබැවින් පුදුම සහගත සීමාවක් (උදාහරණයක් ලෙස 1M ආකෘතියක 128k) එහි මූලාරම්භය සොයා ගත හැක. නිරාකරණය කළ අගයන් මාර්ගගත භාවිතයන්ම වේ; ධජය ක්ෂේත්ර එකතු කරන අතර කිසි විටෙකත් අගයක් වෙනස් නොකරයි. වෙනත් ඕනෑම withLimits අගයක් 400 සමඟ ප්රතික්ෂේප වේ.
capsSource අගය |
සම්භවය |
|---|---|
override:context |
දිගටම පවතින සන්දර්භය-කවුළු අභිබවා යාම (model_context_overrides) |
override:max_input / override:max_output |
දිගටම පවතින max_input_tokens / max_output_tokens හැකියාව අභිබවා යාම |
static-authoritative:<provider>/<model> |
ස්ථිතික බලයලත් සන්දර්භය-කවුළු වගුව |
synced:<provider>/<model> |
models.dev සමමුහුර්ත කළ හැකියාව පේළිය |
registry:<provider>/<model> |
සපයන්නාගේ රෙජිස්ට්රි ප්රවේශය |
spec:<model> |
ස්ථිතික මාදිලි පිරිවිතර |
effort-base: උපසර්ගය |
ප්රයත්න ප්රත්යන්ත ප්රභේදයක මූලික ආකෘතියෙන් පේළිය ණයට ගන්නා ලදී |
none |
කිසිදු මූලාශ්රයක් සීමාව ප්රකාශ නොකරයි (අගය null) |
ක්රියාත්මක කිරීම: src/lib/modelCapabilities.ts හි getResolvedModelCapabilitiesWithLimitSources() සහ src/lib/modelCapabilityLimits.ts හි ප්රමුඛතා දාම .
භාවිතය සහ විශ්ලේෂණ
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/usage/history |
GET | භාවිත ඉතිහාසය |
/api/usage/logs |
GET | භාවිත ලඝු-සටහන් |
/api/usage/request-logs |
GET | ඉල්ලීම් මට්ටමේ ලඝු-සටහන් |
/api/usage/[connectionId] |
GET | එක් සම්බන්ධතා භාවිතය |
/api/usage/token-limits |
GET/POST/DELETE | එක්-ඒපීඅයි-යතුරු ටෝකන්-සීමා අයවැය |
/api/usage/model-latency-stats |
GET | per-provider/model ප්රමාද සමස්ථය (avg/p50/p95/p99, සාර්ථකත්ව අනුපාතය); පෙරහන්: windowHours/minSamples/maxRows/provider/model (#6873) |
/api/usage/cache-health |
GET | call_logs — write/read අනුපාතය මත ක්ෂණික-හැඹිලි සෞඛ්ය සාරාංශය, p50/p90/p99 ලිවීමේ ප්රමාණයේ බෙදා හැරීම, අධික ලෙස ලිවීමේ සාන්ද්රණය, එක්-ආදර්ශ බෙදීම, සහ healthy/degraded/thrash/no-data තීන්දුවක්; විමසුම් පරාමිති range (1h| 24h| 7d| 30d, පෙරනිමි 24h) සහ විකල්ප model (#8827) |
API යතුරු අවසර
PATCH /api/keys/{id} දැනට පවතින යතුරක අවසර යාවත්කාලීන කරයි. සෑම /api/keys* මාර්ගයකටම මෙන් එයට කළමනාකරණ අවසරය අවශ්ය වේ ( කළමනාකරණ සත්යාපනය බලන්න), අනුමාන යතුරක් නොවේ. ඔබට වෙනස් කිරීමට අවශ්ය ක්ෂේත්ර පමණක් යවන්න; No valid fields to update සමඟින් ඉල්ලීමක් ප්රතික්ෂේප කරනු ලැබේ. පිළිගත් ක්ෂේත්ර src/shared/validation/schemas/keys.ts හි updateKeyPermissionsSchema මගින් අර්ථ දක්වා ඇත.
| ක්ෂේත්රය | ටයිප් කරන්න | සටහන් |
|---|---|---|
name |
නූල්, අක්ෂර 1-200 | |
isActive |
බූලියන් | |
isBanned |
බූලියන් | |
expiresAt |
ISO 8601 දින වේලාව හෝ null |
null කල් ඉකුත්වීම ඉවත් කරයි |
modelAccessMode |
all | restricted |
මාදිලිය all වන විට allowedModels හිස් විය යුතුය |
allowedModels, blockedModels |
1000 දක්වා වූ නූල් පෙළක් | |
allowedCombos |
500 දක්වා වූ නූල් මාලාවක් | යතුර ඒකාබද්ධ කරන දොරටු ඇමතීමට හැකිය; සෘජු මාදිලි modelAccessMode / allowedModels මගින් පාලනය වේ |
connectionAccessMode |
all | restricted |
allowedConnections restricted විට හිස් නොවිය යුතු අතර all විට හිස් විය යුතුය |
allowedConnections |
UUIDs අරාව, 100 දක්වා | |
allowAutoCombos |
බූලියන් | false මෙම යතුර සමඟ auto/* ආකෘති සඳහා ඉල්ලීම් ප්රතික්ෂේප කරයි; කිසිවිටෙක එය සකසා නැති යතුරු වලට අවසර ඇත |
catalogScope |
all | combos | models |
මෙම යතුර සඳහා GET /v1/models ලැයිස්තුගත කරන්නේ කුමක්ද (combos පමණි, ආකෘති පමණි, හෝ දෙකම); එය යතුර හැඳින්විය හැකි දේ වෙනස් නොකරයි |
forcedModel |
අක්ෂර 300 ක් දක්වා තන්තුව, හෝ null |
X-Route-Model සහ body.model හරහා මෙම model/combo වෙත කතාබස් ඉල්ලීම් මාර්ග; යතුරේ සීමාවන් තවමත් අදාළ වේ |
noLog, autoResolve |
බූලියන් | |
throttleDelayMs |
පූර්ණ සංඛ්යාව, 0-300000 | |
maxSessions |
පූර්ණ සංඛ්යාව, 0-10000 | |
rateLimits |
{ limit, window } අරාව (ධන පූර්ණ සංඛ්යා, 50 දක්වා) හෝ null |
null සීමාවන් ඉවත් කරයි |
accessSchedule |
උපලේඛන වස්තුව හෝ null |
null කාලසටහන හිස් කරයි |
scopes |
නූල් අරාව, 32 දක්වා | |
allowedEndpoints |
නූල් පෙළ, 20 දක්වා | |
streamDefaultMode |
legacy | json |
|
cacheDefaultMode |
legacy | bypass |
එක්-යතුර හැඹිලි බයිපාස් බලන්න |
compressionEnabled |
බූලියන් | |
codexServiceMode |
Codex සේවා මාදිලි වලින් එකක් | |
disableNonPublicModels |
බූලියන් | |
allowUsageCommand |
බූලියන් | |
usageLimitEnabled |
බූලියන් | |
dailyUsageLimitUsd, weeklyUsageLimitUsd |
අංකය >= 0 හෝ null |
|
fiveHourUsageLimitUsd |
අංකය >= 0 හෝ null |
දෛනික සහ සතිපතා සීමාවන් (usageLimitEnabled, UNPRICED_USAGE_BUDGET_POLICY) මෙන් බලාත්මක කරන ලද පැය 5 USD අයවැය රෝල් කිරීම. retry-after යනු කවුළුව තුළ පැරණිතම වියදම් කිරීම වයසින් මුහුකුරා ගිය විට ය, එහි සීමාව ඉක්මවා යතුරක් තවමත් අවහිර කළ හැකිය. |
chaosModeEnabled |
බූලියන් |
curl -X PATCH "$OMNIROUTE_URL/api/keys/$KEY_ID" \
-H "Authorization: Bearer <management-credential>" \
-H "Content-Type: application/json" \
-d '{ "allowAutoCombos": false, "catalogScope": "combos" }'
සැකසීම්
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/settings |
GET/PUT/PATCH | සාමාන්ය සැකසුම්. ආරක්ෂක ප්රතිපත්ති යතුරු (requireLogin, newPassword, oidc*, corsOrigins, bruteForceProtection) සඳහා currentPassword අවශ්ය වන අතර ක්රියාකරු අක්තපත්ර — API යතුරු සහ oma_ ටෝකන 403 ලබා ගනී; සෑම විකෘතියකටම admin ප්රවේශ-ටෝකන් විෂය පථය අවශ්ය වේ |
/api/settings/proxy |
GET/PUT | ජාල ප්රොක්සි වින්යාසය |
/api/settings/proxy/test |
POST | ප්රොක්සි සම්බන්ධතාවය පරීක්ෂා කරන්න |
/api/settings/ip-filter |
GET/PUT | IP allowlist/blocklist |
/api/settings/thinking-budget |
GET/PUT | Thinking/reasoning** ඉල්ලීම** නැවත ලිවීමේ මාදිලිය (passthrough / auto-strip / custom / අනුවර්තනය). සම්පීඩනය ස්වාධීන. THINKING_BUDGET.md බලන්න . |
/api/settings/system-prompt |
GET/PUT | ගෝලීය පද්ධති විමසුම |
/api/settings/compression |
GET/PUT | ගෝලීය සම්පීඩන වින්යාසය |
/api/settings/purge-request-history |
POST | ඉල්ලීම් ලොග් පේළි සහ දේශීය ඇමතුම්-ලොග් පුරාවස්තු හිස් කරන්න |
සන්දර්භය සහ සම්පීඩනය
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/compression/preview |
POST | off/lite/standard/aggressive/ultra/RTK/stacked සම්පීඩනය පෙරදසුන් කරන්න |
/api/compression/language-packs |
GET | පවතින Caveman භාෂා ඇසුරුම් ලැයිස්තුගත කරන්න |
/api/compression/rules |
GET | Caveman රීති පාරදත්ත ලැයිස්තුගත කරන්න |
/api/context/caveman/config |
GET/PUT | Caveman-විශේෂිත සැකසුම් අන්වර්ථය |
/api/context/rtk/config |
GET/PUT | අභිරුචි පෙරහන් සහ අමු-ප්රතිදාන රඳවා තබා ගැනීම ඇතුළුව RTK-විශේෂිත සැකසුම් |
/api/context/rtk/filters |
GET | RTK පෙරහන් නාමාවලිය සහ අභිරුචි-පෙරහන රෝග විනිශ්චය |
/api/context/rtk/test |
POST | පෙළ ගෙවීමකට එරෙහිව RTK preview/test ධාවනය කරන්න |
/api/context/rtk/raw-output/[id] |
GET | පොයින්ටර් හැඳුනුම්පත මගින් රඳවා ගත් නැවත සකස් කළ අමු ප්රතිදානය කියවන්න |
/api/context/combos |
GET/POST | සම්පීඩන කොම්බෝ list/create |
/api/context/combos/[id] |
GET/PUT/DELETE | සම්පීඩන කොම්බෝ detail/update/delete |
/api/context/combos/[id]/assignments |
GET/PUT | රවුටින් කොම්බෝ වලට සම්පීඩන සංයෝජන පවරන්න |
/api/context/analytics |
GET | සම්පීඩන විශ්ලේෂණ අන්වර්ථය |
අධීක්ෂණය
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/sessions |
GET | ක්රියාකාරී සැසි ලුහුබැඳීම |
/api/rate-limits |
GET | එක් ගිණුමකට අනුපාත සීමාවන් |
/api/monitoring/health |
GET | සෞඛ්ය පරීක්ෂාව + සපයන්නාගේ සාරාංශය (catalogCount, configuredCount, activeCount, monitoredCount). කළමනාකරණ දර්ශනයට credentialHealth ඇතුළත් වේ : probe-cache Scalar, failedConnections when failed>0, සහ staleDbNonOkCount (SQLite ඇලෙන සුළු test_status, මානය නොවේ). MONITORING_GUIDE.md බලන්න. |
/api/cache/stats |
GET/DELETE | හැඹිලි සංඛ්යාලේඛන / පැහැදිලි |
/api/modality-bridge/stats |
GET | මතකයේ ඇති attempts, successes/bridged, අසාර්ථක වීම්, හැඹිලි පහරවල්, totalLatencyMs, latencySamples, නියැදි-නම් කරන ලද averageLatencyMs, සහ අවසාන භාවිත කාලය (නැවත ආරම්භ කිරීමේදී යළි පිහිටුවීම; කළමනාකරණ සත්යාපනය) |
/api/modality-bridge/video/runtime |
GET | කළමනාකරණයට පෙර දැඩි විශ්වාසනීය-ලූප්බැක් පරීක්ෂාව auth/probe; සනීපාරක්ෂක FFmpeg/ffprobe ලබා ගැනීමේ හැකියාව සහ අනුවාද (ගබඩා නොමැති) |
/api/modality-bridge/video/extract |
POST | අභ්යන්තර සත්යාපිත විශ්වාසවන්ත-ලූප්බැක් බයිට් තැරැව්කරු; 50 MiB ආදානය, සීමා වූ queue/32 MiB ප්රතිදානය, 503 ධාරිතාව, 499 විසන්ධි කිරීම, 504 අවසාන දිනය; පොදු උඩුගත කිරීමක් නොවේ API |
වීඩියෝ රාමු සරඹ-පහළ
GET /api/v1/video-bridge/drilldown පැහැදිලිවම එකඟ වූ වීඩියෝ පාලම් ඉල්ලීමකින් පසුව x-omniroute-video-drilldown හි ආපසු ලබා දුන් කුලී නිවැසියන්-බැඳුණු පාරාන්ධ හසුරුව කියවයි. කියවීම් සහ DELETE යන දෙකටම සැමවිටම වලංගු API යතුරක් සහ ක්රියාකරුගේ ස්වාධීන modalityBridgeVideoDrilldownRemoteEnabled අවසරය අවශ්ය වේ. නිෂ්පාදන රඳවා තබා ගැනීම සඳහා අමතර වශයෙන් modalityBridgeVideoDrilldownEnabled සහ දැඩි එක් කොටසකට drilldown: true අවශ්ය වේ. යතුරට හිස් නොවන අන්ත ලක්ෂ්ය අවසර ලැයිස්තුවක් තිබේ නම්, එය අමතන්නා /v1 හෝ /api/v1 භාවිතා කළත් GET සහ DELETE යන දෙකටම video ඇතුළත් විය යුතුය.
GET විමසුම: අවශ්ය handle; විකල්ප variant (preview, standard, detail), limit (1–8; උරුම frames පිළිගනු ලබන නමුත් limit සමඟ ඒකාබද්ධ කළ නොහැක), ශුන්ය පදනම් වූ page, සහ start/end තත්පර. නාභිගත සීමාවන් දෙකම සපයන විට, end start ට වඩා වැඩි විය යුතුය. Duplicate/unknown විමසුම් යතුරු ප්රතික්ෂේප වේ. සාර්ථක ප්රතිචාරවල derivation, durationSeconds, frames, hasMore, page, variant, සහ විකල්ප focusWindow අඩංගු වේ; ගබඩා රහිත JSON Base64 ඇතුළුව MiB 32 ට සීමා කර ඇත. අති විශාල ප්රතිදානය ප්රතිලාභ 413; අඩු රාමු ඉල්ලන්න.
DELETE /api/v1/video-bridge/drilldown?handle=... { "removed": 0|1 } ආපසු ලබා දෙයි. නොදන්නා, කල් ඉකුත් වූ සහ හරස් යතුර GETs වෙන්කර හඳුනාගත නොහැකි ප්රතිචාර 404; හරස් යතුර DELETE හිමිකරුගේ ප්රවේශය ඉවත් කළ නොහැක. ආබාධිත ප්රවේශය ප්රතිලාභ 403, missing/invalid සත්යාපනය 401, වලංගු නොවන විමසුම් 400, අවලංගු කිරීම 499 සහ තාවකාලික දෝෂ 503. හැන්ඩ්ල් ක්රියාවලි-දේශීය වේ, මිනිත්තු දහයකට පසු කල් ඉකුත් වන අතර නැවත ආරම්භ කිරීමෙන් නොනැසී පවතී. නව හැසිරවීම් v1. සහ 32-byte අහඹු Base64URL ටෝකනයක් භාවිතා කරයි; ටෝකන් හැෂ් පමණක් තබා ඇත. ලෙගසි 64-හෙක්ස් ටෝකන ගැළපුම සඳහා වාක්යානුකූලව කියවිය හැකිය. කැමැත්ත, කෝටා සහ ප්රභේද ව්යුත්පන්න විස්තර සඳහා වීඩියෝ පාලම් ආරක්ෂක වැට බලන්න.
උපස්ථ සහ Export/Import
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/db-backups |
GET | පවතින උපස්ථ ලැයිස්තුගත කරන්න |
/api/db-backups |
PUT | අතින් උපස්ථයක් සාදන්න |
/api/db-backups |
POST | නිශ්චිත උපස්ථයකින් ප්රතිසාධනය කරන්න |
/api/db-backups |
PATCH | උපස්ථ රඳවා ගැනීමේ සැකසුම් සුරකින්න (ක්රියාකරුට පමණි) |
/api/db-backups |
DELETE | ගබඩා කර ඇති උපස්ථ රඳවා තබා ගැනීමේ සිටුවම්වලට කප්පාදු කරන්න (ක්රියාකරුට පමණි) |
/api/db-backups/export |
GET | දත්ත සමුදාය .sqlite ගොනුව ලෙස බාගන්න |
/api/db-backups/import |
POST | දත්ත සමුදාය ප්රතිස්ථාපනය කිරීමට .sqlite ගොනුව උඩුගත කරන්න (?dryRun=true වලංගු වන්නේ පමණි) |
/api/db-backups/exportAll |
GET | සම්පූර්ණ උපස්ථය .tar.gz සංරක්ෂිතය ලෙස බාගන්න |
/api/db-backups/export, /api/db-backups/exportAll සහ /api/settings/export-json ගබඩා කර ඇති සෑම අක්තපත්රයක්ම ලබා දෙයි, එබැවින් ඔවුන්ට උපකරණ පුවරු සැසිය හෝ ප්රාදේශීය CLI (හෝ පුරනය වීම අබල කර ඇත) අවශ්ය වේ. ඕනෑම විෂය පථයක API යතුරු සහ oma_ ප්රවේශ ටෝකන 403 ලබා ගනී. ප්රතිසාධනයන් එකම මායිමක් දරයි: POST /api/db-backups/import (dryRun=true ඇතුළත්), POST /api/db-backups (ID මගින් ප්රතිසාධනය කරන්න) සහ POST /api/settings/import-json සජීවී දත්ත සමුදාය හෝ සිටුවම් ප්රතිස්ථාපනය කරයි, එබැවින් යන්ත්ර අක්තපත්රයක් එහිද 403 ලබා ගනී; omniroute sync import දේශීය CLI අක්තපත්රය යවයි. එබැවින් DELETE /api/db-backups (ගබඩා කළ උපස්ථ කප්පාදු කිරීම) සහ PATCH /api/db-backups (රඳවා ගැනීමේ සිටුවම්: සෑම උපස්ථයකටම පසු ස්වයංක්රීය කප්පාදුව දිගටම පවතින අගයන් මඟින් සිදු කරයි). ලැයිස්තුගත කිරීම (GET) සහ අතින් උපස්ථයක් නිර්මාණය කිරීම (PUT) සාමාන්ය කළමනාකරණ සත්යාපනය තබා ගන්න.
Cloud Sync
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/sync/cloud |
විවිධ | වලාකුළු සමමුහුර්ත මෙහෙයුම් |
/api/sync/initialize |
POST | සමමුහුර්ත කිරීම ආරම්භ කරන්න |
/api/cloud/* |
විවිධ | වලාකුළු කළමනාකරණය |
උමං මාර්ග
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/tunnels/cloudflared |
GET | උපකරණ පුවරුව සඳහා Cloudflare Quick Tunnel install/runtime තත්ත්වය කියවන්න |
/api/tunnels/cloudflared |
POST | Cloudflare ඉක්මන් උමග (action=enable/disable) සබල කරන්න හෝ අබල කරන්න |
/api/tunnels/ngrok |
GET | උපකරණ පුවරුව සඳහා ngrok උමං ධාවන කාල තත්ත්වය කියවන්න |
/api/tunnels/ngrok |
POST | ngrok උමග (action=enable/disable) සබල කරන්න හෝ අක්රිය කරන්න |
CLI මෙවලම්
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/cli-tools/claude-settings |
GET | Claude CLI තත්ත්වය |
/api/cli-tools/codex-settings |
GET | Codex CLI තත්ත්වය |
/api/cli-tools/droid-settings |
GET | Droid CLI තත්ත්වය |
/api/cli-tools/openclaw-settings |
GET | OpenClaw CLI තත්ත්වය |
/api/cli-tools/runtime/[toolId] |
GET | සාමාන්ය CLI ධාවන කාලය |
CLI ප්රතිචාරවලට ඇතුළත් වන්නේ: installed, runnable, command, commandPath, runtimeMode, reason.
ACP නියෝජිතයන්
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/acp/agents |
GET | සියලුම අනාවරණය කරගත් නියෝජිතයන් (බිල්ට්-ඉන් + අභිරුචි) තත්ත්වය සමඟ ලැයිස්තුගත කරන්න |
/api/acp/agents |
POST | අභිරුචි නියෝජිතයා එක් කරන්න හෝ හඳුනාගැනීමේ හැඹිලිය නැවුම් කරන්න |
/api/acp/agents |
DELETE | id විමසුම් පරාමිතිය මගින් අභිරුචි නියෝජිතයෙකු ඉවත් කරන්න |
GET ප්රතිචාරයට agents[] (id, නම, ද්විමය, අනුවාදය, ස්ථාපිත, ප්රොටෝකෝලය, isCustom) සහ summary (මුළු, ස්ථාපිත, notFound, builtIn, අභිරුචි) ඇතුළත් වේ.
ඔරොත්තු දීමේ හැකියාව සහ අනුපාත සීමාවන්
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/resilience |
GET/PATCH | Get/update ඉල්ලීම් පෝලිම, සම්බන්ධතා සිසිල් කිරීම, සැපයුම්කරු බිඳීම සහ රැඳී සිටීමේ සිටුවම් |
/api/resilience/reset |
POST | සැපයුම්කරුගේ පරිපථ කඩන යන්ත්ර නැවත සකසන්න |
/api/resilience/model-cooldowns |
GET | ඉතිරි කාලය අනුව වර්ග කරන ලද, සක්රිය එක් (සැපයුම්කරු, සම්බන්ධතාවය, ආකෘතිය) අගුලු දැමීම් ලැයිස්තුගත කරන්න |
/api/resilience/model-cooldowns |
DELETE | සියල්ල පිසදැමීමට ආදර්ශ lockout — body {provider, model} හෝ {all: true} හිස් කරන්න |
/api/rate-limits |
GET/POST | එක් ගිණුමකට අනුපාත සීමාව තත්ත්වය (GET) හෝ සම්බන්ධතාවයක් සඳහා අනුපාත සීමා ආරක්ෂාව ටොගල කරන්න (POST {connectionId, enabled}). rateLimitProtection සඳහා සහය දක්වන ලිවීමේ මාර්ගය ( PUT /api/providers/[id] හරහා කිසිවිටෙක වෙනස් නොවේ). සටහන: enabled: false පැහැදිලි ආරක්ෂාව අබල කරන නමුත් ගෝලීය ස්වයංක්රීය සක්රීය ආරක්ෂණ ජාලයෙන් (autoEnableApiKeyProviders) ක්රියාකාරී API-යතුරු සම්බන්ධතාවයක් තෝරා නොගනී. |
/api/rate-limit |
GET | ගෝලීය අනුපාත සීමා වින්යාසය (අත් හරින ලද; අන්වර්ථය /api/rate-limits වෙත ) |
/api/resilience/*මාර්ග හතරම අවශ්යයි** කළමනාකරණ සහතිකය** (requireManagementAuth) සපයන්නාගේ බ්රේකර් එදිරිව සම්බන්ධතා කූල්ඩවුන් එදිරිව මාදිලි අගුලු දැමීමේ සම්පූර්ණ බිඳවැටීමක් සඳහා ප්රත්යාස්ථතාව (දිගු) බලන්න.
Evals
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/evals |
GET/POST | eval කට්ටල ලැයිස්තුගත කරන්න / ධාවන ඇගයීම |
ප්රතිපත්ති
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/policies |
GET/POST/DELETE | මාර්ගගත කිරීමේ ප්රතිපත්ති කළමනාකරණය කරන්න |
අනුකූල වීම
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/compliance/audit-log |
GET | අනුකූලතා විගණන සටහන (අවසන් N) |
v1beta (මිථුන-අනුකූල)
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/v1beta/models |
GET | Gemini ආකෘතියෙන් ආකෘති ලැයිස්තුගත කරන්න |
/v1beta/models/{...path} |
POST | Gemini generateContent අන්ත ලක්ෂ්යය |
මෙම අන්ත ලක්ෂ්ය දේශීය Gemini SDK ගැළපුම අපේක්ෂා කරන සේවාලාභීන් සඳහා Gemini හි API ආකෘතිය පිළිබිඹු කරයි.
අභ්යන්තර / පද්ධති APIs
| අන්ත ලක්ෂ්යය | ක්රමය | විස්තරය |
|---|---|---|
/api/init |
GET | පසුබිම් සමමුහුර්ත සේවා ආරම්භ කරන්න (කළමනාකරණ සත්යාපනය) |
/api/tags |
GET | Ollama-අනුකූල ආකෘති ටැග් ( Ollama සේවාදායකයින් සඳහා) |
/api/restart |
POST | අලංකාර සේවාදායක නැවත ආරම්භ කිරීම ක්රියාරම්භ කරන්න |
/api/shutdown |
POST | අලංකාර සේවාදායක වසා දැමීම ප්රේරණය කරන්න |
/api/system/env/repair |
POST | OAuth සපයන්නාගේ පරිසර විචල්යයන් අලුත්වැඩියා කරන්න |
/api/system/version |
GET | Current/latest අනුවාදය, යාවත්කාලීන තත්ත්වය, නාලිකාව මුදා හැරීම |
/api/system/version |
POST | නවතම අනුවාදය වෙත යෙදවීම-දැනුවත් යාවත්කාලීන කිරීම ආරම්භ කරන්න |
සටහන: මෙම අන්ත ලක්ෂ්ය පද්ධතිය විසින් අභ්යන්තරව හෝ Ollama සේවාදායක අනුකූලතාව සඳහා භාවිතා කරයි. ඒවා සාමාන්යයෙන් අවසාන පරිශීලකයින් විසින් හඳුන්වනු නොලැබේ.
OAuth පරිසර අලුත්වැඩියාව (v3.6.1 +)
POST /api/system/env/repair
Content-Type: application/json
{
"provider": "claude-code"
}
විශේෂිත සැපයුම්කරුවෙකු සඳහා අතුරුදහන් වූ හෝ දූෂිත OAuth පරිසර විචල්යයන් අලුත්වැඩියා කරයි. ප්රතිලාභ:
{
"success": true,
"repaired": ["CLAUDE_CODE_OAUTH_CLIENT_ID", "CLAUDE_CODE_OAUTH_CLIENT_SECRET"],
"backupPath": "/home/user/.omniroute/backups/env-repair-2026-04-11.bak"
}
අනුවාදය සහ නිකුත් කිරීමේ නාලිකාව
GET /api/system/version
Loopback-only management route (admin auth). ධාවන අනුවාදය, නවතම ප්රකාශිත අනුවාදය සහ ස්වයංක්රීය යාවත්කාලීන තත්ත්වය ලබා දෙයි. releaseChannel සහ channels යනු ආකලන ක්ෂේත්ර (රේල් 3.8.54); channel එහි තේරුම — උපකරණ පුවරුව යාවත්කාලීන කරන්නා භාවිතා කරන යෙදවුම් මාදිලිය (npm, source හෝ docker-compose) තබා ගනී.
{
"current": "3.8.52",
"latest": "3.8.52",
"updateAvailable": false,
"channel": "npm",
"autoUpdateSupported": true,
"autoUpdateError": null,
"news": null,
"releaseChannel": "latest",
"channels": { "latest": "3.8.52", "next": "3.8.53-rc.1" }
}
- ධාවන ගොඩනැගීමේ
releaseChannel— නාලිකාව:-nightly.*අනුවාද සඳහාnightly, වෙනත් පූර්ව නිකුතු සඳහාnext(-rc.*,-beta.*,-alpha.*),channels.latestට වඩා පැරණි මේජර් එකක ස්ථායී අනුවාදයක් සඳහාlts, එසේ නොමැති නම්latest. ප්රකාශන වේලාවේදී npm dist-tag තෝරා ගන්නාscripts/release/dist-tag.mjsට සමාන රීති. channels— ප්රකාශිත එක් එක් dist-tag හි ප්රධානියා,npm view omniroute dist-tags(registry HTTP Fallback) වෙතින්,latestලෙස එකම 10-මිනිත්තු TTL සමඟ හැඹිලිගත කර ඇත.latestසැමවිටම පවතී (නැවතlatestක්ෂේත්රයට වැටේ, පසුව"unavailable");next,nightlyසහltsදිස්වන්නේ එම dist-tag පවතින විට පමණි.Cache-Control: no-cacheඉල්ලීමක් බැලීම් දෙකම නැවුම් කරයි.
නාලිකා ආකෘතිය (latest = v3 දක්වා 4.0 GA, next = rc, nightly = develop builds, lts = v3 පැච් 4.0 GA ට පසුව) docs/ops/RELEASE_STRATEGY.md හි විස්තර කෙරේ.
ශ්රව්ය පිටපත්කරණය
POST /v1/audio/transcriptions
Authorization: Bearer your-api-key
Content-Type: multipart/form-data
වින්යාස කර ඇති ඕනෑම STT සැපයුම්කරුවෙකු භාවිතයෙන් ශ්රව්ය ගොනු පිටපත් කරන්න. පථයේ පළමු
කොටස native සැපයුම්කරු තෝරයි (openai/…, deepgram/…). වෙනත් වෙළෙන්දෙකුගේ ආකෘතිය
නැවත නිරාවරණය කරන ගේට්වේ සුදුසුකම් ලත් id එකක් භාවිත කරයි
(openrouter/deepgram/nova-3).
ඉල්ලීම:
curl -X POST http://localhost:20128/v1/audio/transcriptions \
-H "Authorization: Bearer your-api-key" \
-F "file=@recording.mp3" \
-F "model=openai/whisper-1"
ප්රතිචාරය:
{
"text": "Hello, this is the transcribed audio content.",
"task": "transcribe",
"language": "en",
"duration": 12.5
}
උදාහරණ ආකෘති ids: openai/whisper-1 (OpenAI යතුරක් අවශ්ය වේ),
openrouter/deepgram/nova-3 (OpenRouter යතුරක් අවශ්ය වේ),
deepgram/nova-3 (native Deepgram යතුරක් අවශ්ය වේ). හිස්
deepgram/nova-3 ඉල්ලීමක් OpenRouter භාවිත නොකරයි.
සහාය දක්වන ආකෘති: mp3, wav, m4a, flac, ogg, webm.
Gemini Live (gemini/gemini-3.5-transcribe-live): Gemini Live
WebSocket හරහා ගොනු-මාදිලි පිටපත්කරණය (Gemini API යතුරක් අවශ්ය වේ). උඩුගත කිරීම
ffmpeg භාවිතයෙන් 16 kHz mono PCM වෙත පරිවර්තනය කර (ffmpeg PATH මත තිබිය
යුතුය, ගොනුව දැනටමත් 16 kHz mono PCM WAV එකක් නොවේ නම්), සැසිය වෙත ප්රවාහනය කර,
අවසන් කළ පෙළ { "text": "..." } ලෙස ආපසු ලබා දෙයි. විකල්ප language සහ prompt පෝරම ක්ෂේත්ර
ඉදිරියට යොමු කෙරේ. සීමාවන්: 25 MiB ඉක්මවන උඩුගත කිරීම් හෝ විකේතනය කළ ශ්රව්යයේ
දිග මිනිත්තු 10කට වඩා වැඩි නම් 413 ප්රතිචාරයක් ලැබේ; පරිවර්තනය තත්පර 60කට
වඩා දිගු කාලයක් ධාවනය වුවහොත් එය නවතා 504 ප්රතිචාරයක් ලබා දෙයි. API යතුර
යවනු ලබන්නේ x-goog-api-key ශීර්ෂය තුළ පමණක් වන අතර, කිසිවිටෙක WebSocket URL එක තුළ නොවේ.
Ollama අනුකූලතාව
Ollama හි API ආකෘතිය භාවිත කරන සේවාලාභීන් සඳහා:
# Chat endpoint (Ollama ආකෘතිය)
POST /v1/api/chat
# ආකෘති ලැයිස්තුගත කිරීම (Ollama ආකෘතිය)
GET /api/tags
ඉල්ලීම් Ollama සහ අභ්යන්තර ආකෘති අතර ස්වයංක්රීයව පරිවර්තනය කෙරේ.
Token සහිත VS Code / Header රහිත අන්වර්ථ නාම
අනුකලනයකට Authorization ශීර්ෂයක් ඇතුළත් කළ නොහැකි විට සහ API යතුර මූල URL තුළ ඇතුළත් කිරීමට අවශ්ය වූ විට මෙම අන්වර්ථ නාම භාවිත කරන්න.
# OpenAI-ශෛලියේ නාමාවලි අන්වර්ථ නාමය
GET /api/v1/vscode/{token}/
GET /api/v1/vscode/{token}/models
# OpenAI-ශෛලියේ chat අන්වර්ථ නාම
POST /api/v1/vscode/{token}/chat/completions
POST /api/v1/vscode/{token}/responses
# Ollama-ශෛලියේ අන්වර්ථ නාම
POST /api/v1/vscode/{token}/api/chat
GET /api/v1/vscode/{token}/api/tags
උදාහරණය:
curl https://your-host.example/api/v1/vscode/YOUR_API_KEY/models
curl -X POST https://your-host.example/api/v1/vscode/YOUR_API_KEY/chat/completions \
-H "Content-Type: application/json" \
-d '{"model":"auto","messages":[{"role":"user","content":"hello"}]}'
සටහන්:
- Token සහිත අන්වර්ථ නාම
/v1/*සහ/api/tagsසඳහා භාවිත කරන handler ම භාවිත කරයි; ප්රතිචාර ආකෘති එලෙසම පවතී. - සේවාලාභියා අභිරුචි ශීර්ෂ සඳහා සහාය දක්වන සෑම විටම
Authorization: Bearer ...භාවිත කිරීමට ප්රමුඛතාව දෙන්න. - URL මත පදනම් වූ token OmniRoute වලින් පිටත reverse-proxy ලොග්, බ්රවුසර ඉතිහාසය සහ telemetry තුළ දිස් විය හැක. ඒවා පෙරනිමි සත්යාපන ක්රමය ලෙස නොව, අනුකූලතා විකල්පයක් ලෙස සලකන්න.
Telemetry
# ප්රමාද telemetry සාරාංශය ලබා ගන්න (සෑම සපයන්නෙකු සඳහාම p50/p95/p99)
GET /api/telemetry/summary
ප්රතිචාරය:
{
"providers": {
"claudeCode": { "p50": 245, "p95": 890, "p99": 1200, "count": 150 },
"github": { "p50": 180, "p95": 620, "p99": 950, "count": 320 }
}
}
අයවැය
# සියලුම API යතුරු සඳහා අයවැය තත්ත්වය ලබා ගන්න
GET /api/usage/budget
# අයවැයක් සකසන්න හෝ යාවත්කාලීන කරන්න
POST /api/usage/budget
Content-Type: application/json
{
"apiKeyId": "key-123",
"dailyLimitUsd": 5.00,
"weeklyLimitUsd": 30.00,
"monthlyLimitUsd": 100.00,
"warningThreshold": 0.8,
"resetInterval": "monthly"
}
Schema සටහන් (
setBudgetSchema):apiKeyIdඅවශ්ය වේ;dailyLimitUsd,weeklyLimitUsd, හෝmonthlyLimitUsdඅතරින් අවම වශයෙන් එකක් ශුන්යයට වඩා වැඩි විය යුතුය. විකල්ප ක්ෂේත්ර:warningThreshold(0–1),resetInterval(daily|weekly|monthly),resetTime(HH:MM). පැරණි{keyId, limit, period}ආකෘතිය400 Bad Requestආපසු ලබා දෙයි.
ටෝකන් සීමා
එක් API යතුරකට අදාළ token අයවැය (ඉහත සඳහන් USD-පාදක අයවැයෙන් වෙනස්). ඉල්ලීම් මාර්ගයේදී inline ලෙස බලපැවැත්වේ: යතුරක වත්මන් window භාවිතය එහි සීමාවට ළඟා වූ විට, ඉල්ලීම් 429 Too Many Requests සමඟ ප්රතික්ෂේප කෙරේ. සීමා විශේෂිත model එකකට, provider එකකට සීමා කළ හැකි අතර, යතුර පුරා global ලෙසද යෙදිය හැක; ඉල්ලීමකට සීමා කිහිපයක් ගැළපෙන විට, වඩාත් දැඩි සීමාව ක්රියාත්මක වේ.
# යතුරක ටෝකන් සීමා ලැයිස්තුගත කරන්න (සජීවී window භාවිතයද ඇතුළත් වේ)
GET /api/usage/token-limits?apiKeyId=key-123
# ටෝකන් සීමාවක් සාදන්න හෝ යාවත්කාලීන කරන්න
POST /api/usage/token-limits
Content-Type: application/json
{
"apiKeyId": "key-123",
"scopeType": "model",
"scopeValue": "openai/gpt-4o",
"tokenLimit": 1000000,
"resetInterval": "monthly",
"enabled": true
}
# id මගින් ටෝකන් සීමාවක් මකන්න
DELETE /api/usage/token-limits?id=tl-abc
Schema සටහන් (
setTokenLimitSchema):apiKeyIdසහscopeType(model|provider|global) අනිවාර්ය වේ.scopeTypeglobalනොවන විටscopeValueඅනිවාර්ය වේ (modelscope සඳහා model id එකක්,providerscope සඳහා provider id එකක් වැනි).tokenLimitධන පූර්ණ සංඛ්යාවක් විය යුතුය (string එකකින් coercion කෙරේ). විකල්ප:id(නිර්මාණය සඳහා ඉවත් කරන්න, යාවත්කාලීන කිරීම සඳහා සපයන්න),resetInterval(daily|weekly|monthly, පෙරනිමියmonthly),resetTime(HH:MM),enabled(පෙරනිමියtrue).GETප්රතිචාර මඟින් එක් එක් සීමාවටtokensUsed,remaining,windowStart,periodStartAt, සහnextResetAtඑක් කරනු ලැබේ. මෙය කළමනාකරණ-පන්තියේ endpoint එකකි (සත්යාපනය authz pipeline මඟින් මධ්යගතව බලපැවැත්වේ).
ඉල්ලීම් සැකසීම
- Client
/v1/*වෙත ඉල්ලීම යවයි - Route handler
handleChat,handleEmbedding,handleAudioTranscription, හෝhandleImageGenerationකැඳවයි - Model එක විසඳනු ලැබේ (සෘජු provider/model හෝ alias/combo)
- ගිණුම් ලබාගත හැකි බව පෙරීම සමඟ, දේශීය DB එකෙන් credentials තෝරා ගනු ලැබේ
- Chat සඳහා:
handleChatCoresemantic/signature cache පරීක්ෂා කර combo compression සැකසුම් විසඳයි - සක්රීය කළ විට provider translation කිරීමට පෙර proactive compression ක්රියාත්මක වේ (
lite, Caveman, RTK, හෝ stacked) - Provider executor upstream ඉල්ලීම යවයි
- ප්රතිචාරය client ආකෘතියට (chat) පරිවර්තනය කර නැවත යවනු ලැබේ, නැතහොත් එය තිබූ ආකාරයෙන්ම (embeddings/images/audio) ආපසු ලබා දේ
- භාවිතය, compression analytics, සහ request logs වාර්තා කෙරේ
- combo නීති අනුව දෝෂ ඇති විට fallback යෙදේ
සම්පූර්ණ architecture reference: ARCHITECTURE.md
Combo කළමනාකරණය
ඉහළ මට්ටමේ routing combos (/api/combos* යටතේ දැනටමත් සාරාංශ කර ඇති) model id රටාවකින් 1:1 ලෙස map කළ හැකි අතර, එමඟින් OpenAI-style model id එකක් combo එකකට විනිවිද පෙනෙන ලෙස යොමු කළ හැක.
| Method | Path | විස්තර |
|---|---|---|
| GET | /api/model-combo-mappings |
සියලු model→combo mappings ලැයිස්තුගත කරන්න |
| POST | /api/model-combo-mappings |
Mapping එකක් සාදන්න — body: {pattern, comboId, priority?, enabled?, description?} |
| GET | /api/model-combo-mappings/[id] |
තනි mapping එකක් ලබාගන්න |
| PUT | /api/model-combo-mappings/[id] |
පවතින mapping එකක ක්ෂේත්ර යාවත්කාලීන කරන්න |
| DELETE | /api/model-combo-mappings/[id] |
Mapping එකක් ඉවත් කරන්න |
සත්යාපනය: කළමනාකරණ session/API key (requireManagementAuth).
Webhooks
OmniRoute සිදුවීම් (ඉල්ලීම් සම්පූර්ණ වීම, කෝටා අවසන් වීම, යතුරු භ්රමණය වීම ආදිය) සඳහා පිටතට යැවෙන webhook දායකත්ව.
| ක්රමය | මාර්ගය | විස්තරය |
|---|---|---|
| GET | /api/webhooks |
Webhook ලැයිස්තුගත කරන්න (රහස් <prefix>... ලෙස ආවරණය කර ඇත) |
| POST | /api/webhooks |
Webhook එකක් සාදන්න — අන්තර්ගතය: {url, events?: ["*"], secret?, description?} |
| GET | /api/webhooks/[id] |
Webhook එකක් ලබා ගන්න |
| PUT | /api/webhooks/[id] |
url/events/secret/description යාවත්කාලීන කරන්න |
| DELETE | /api/webhooks/[id] |
Webhook එකක් ඉවත් කරන්න |
| POST | /api/webhooks/[id]/test |
Webhook URL වෙත පරීක්ෂණ payload එකක් යවා බෙදාහැරීමේ තත්ත්වය ආපසු ලබා දෙන්න |
සත්යාපනය: කළමනාකරණ session/API key (requireManagementAuth).
ලියාපදිංචි කළ යතුරු (ස්වයංක්රීය කළමනාකරණය)
දෛනික/පැයක කෝටා සහිත, පසුබිම් provider/account එකකට එරෙහිව API යතුරු නිකුත් කිරීමට සහ භ්රමණය කිරීමට ස්වයංක්රීය යතුරු කළමනාකරණ උපපද්ධතිය භාවිත කරයි.
| ක්රමය | මාර්ගය | විස්තරය |
|---|---|---|
| GET | /api/v1/registered-keys |
ලියාපදිංචි කළ යතුරු ලැයිස්තුගත කරන්න (ආවරණය කළ prefix පමණි) |
| POST | /api/v1/registered-keys |
නව ලියාපදිංචි කළ යතුරක් නිකුත් කරන්න — අන්තර්ගතය: {name, provider?, accountId?, idempotencyKey?, expiresAt?, dailyBudget?, hourlyBudget?}. මුල් යතුර එක් වරක් පමණක් ආපසු ලබා දෙයි. කෝටා ප්රතික්ෂේපයකදී 429 ආපසු ලබා දෙයි. |
| GET | /api/v1/registered-keys/[id] |
ලියාපදිංචි කළ යතුරක පාර-දත්ත ලබා ගන්න (මුල් දත්ත නොමැත) |
| DELETE | /api/v1/registered-keys/[id] |
ලියාපදිංචි කළ යතුරක් අවලංගු කරන්න |
| POST | /api/v1/registered-keys/[id]/revoke |
පැහැදිලි අවලංගු කිරීමේ endpoint එක (DELETE හා සමාන බලපෑමක්) |
සත්යාපනය: කළමනාකරණ session/API key (requireManagementAuth) — /api/keys සඳහා භාවිත කරන එකම ආරක්ෂක පරීක්ෂකය: dashboard session එකක්, දේශීය CLI token එකක්, හෝ manage/admin scope සහිත API key එකක්; inference-only API keys සඳහා 403 ලැබේ. /v1/quotas/check සහ /v1/issues/report ද බලන්න.
නියෝජිත ප්රොටෝකෝලය
OmniRoute පරිශීලකයන් වෙනුවෙන් දුරස්ථව ක්රියාත්මක කරන Cloud agent කාර්යයන් (Claude Code, Codex Cloud, OpenHands ආදිය).
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/agents/tasks |
කාර්ය ලැයිස්තුව — විකල්ප ?provider=, ?status=, ?limit= (1–500, පෙරනිමිය 50) |
| POST | /api/v1/agents/tasks |
කාර්යයක් සාදන්න — සිරුර CreateCloudAgentTaskSchema මඟින් වලංගු කරයි (providerId, prompt, source, options?). කාර්ය envelope සමඟ 201 ලබා දෙයි |
| DELETE | /api/v1/agents/tasks?id=... |
කාර්යයක් මකන්න |
| GET | /api/v1/agents/tasks/[id] |
කාර්යය කියවන්න — external_id සකසා ඇති විට upstream cloud agent වෙතින් තත්ත්වය සමකාලීනව නැවුම් කරයි |
| POST | /api/v1/agents/tasks/[id] |
වෙන් කළ ක්රියාව: {action: "approve"}, {action: "message", message}, හෝ {action: "cancel"} |
| DELETE | /api/v1/agents/tasks/[id] |
id මඟින් නිශ්චිත කාර්යයක් මකන්න |
සත්යාපනය: සෑම ක්රමයකටම management auth අවශ්ය වේ (
requireCloudAgentManagementAuth). v3.8.0 ට පෙර මේවා සත්යාපනයකින් තොරව තිබූ අතර — බිඳවැටීමක් ඇති කළ වෙනස සඳහා commit588a0333බලන්න.
# Claude Code cloud task එකක් සාදන්න
curl -X POST http://localhost:20128/api/v1/agents/tasks \
-H "Authorization: Bearer your-management-key" \
-H "Content-Type: application/json" \
-d '{"providerId":"claude-code-cloud","prompt":"Fix the failing test","source":{"repo":"...","branch":"..."}}'
කළමනාකරණ ප්රොක්සි
providers, accounts හෝ ගෝලීයව පැවරිය හැකි පිටතට යන HTTP(S)/SOCKS ප්රොක්සි.
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/management/proxies |
ප්රොක්සි ලැයිස්තුගත කරන්න (?id= සමඟ එකක් ලබා දෙයි; ?id=&where_used=1 සමඟ පැවරුම් ප්රස්තාරය ලබා දෙයි) |
| POST | /api/v1/management/proxies |
ප්රොක්සියක් සාදන්න — සිරුර createProxyRegistrySchema මඟින් වලංගු කරයි |
| PATCH | /api/v1/management/proxies |
ප්රොක්සිය යාවත්කාලීන කරන්න — සිරුර updateProxyRegistrySchema මඟින් වලංගු කරයි (id අවශ්යයි) |
| DELETE | /api/v1/management/proxies?id=...&force=1 |
ප්රොක්සිය මකන්න (පැවරුම් වෙන් කිරීමට force=1 භාවිත කරන්න) |
| GET | /api/v1/management/proxies/assignments |
පැවරුම් ලැයිස්තුගත කරන්න — proxy_id, scope, scope_id මඟින් පෙරහන් කළ හැක; සම්බන්ධතාවයක් සඳහා සක්රිය ප්රොක්සිය විසඳීමට resolve_connection_id=<id> යවන්න |
| PUT | /api/v1/management/proxies/assignments |
පවරන්න — සිරුර proxyAssignmentSchema මඟින් වලංගු කරයි ({scope, scopeId?, proxyId?}). dispatcher හැඹිලිය හිස් කරයි |
| PUT | /api/v1/management/proxies/bulk-assign |
සමූහ වශයෙන් පවරන්න — සිරුර bulkProxyAssignmentSchema මඟින් වලංගු කරයි ({scope, scopeIds[], proxyId?}) |
| GET | /api/v1/management/proxies/health?hours=24 |
කාල කවුළුවක් තුළ සමස්ත ප්රොක්සි සෞඛ්යය (සාර්ථක/අසාර්ථක ගණන්, ප්රමාදය) |
සත්යාපනය: සෑම route එකකටම management session/API key අවශ්ය වේ (requireManagementAuth).
කාර්ය විස්තරයේ සඳහන්
POST /api/v1/management/proxies/[id]/assignmentsසහPOST /api/v1/management/proxies/[id]/healthඉහත පෙන්වා ඇති flat/assignmentsසහ/healthroutes මඟින් සපයනු ලැබේ — codebase තුළ එක් එක් id සඳහා වෙනම subroutes නොමැත.
ඔරොත්තු දීමේ හැකියාව (විස්තීර්ණ)
OmniRoute මඟින් ස්වාධීන තාවකාලික-අසාර්ථකත්ව යාන්ත්රණ තුනක් සපයයි; පහත කළමනාකරණ endpoint මඟින් ක්රියාකරුවන්ට ඒවා කියවීමට සහ override කිරීමට හැකිය:
| විෂය පථය | තත්ත්ව ගබඩාව | කියවීම | යළි සකසන්න / හිස් කරන්න |
|---|---|---|---|
| Provider breaker | domain_circuit_breakers + මතකය තුළ |
/api/monitoring/health |
POST /api/resilience/reset |
| සම්බන්ධතා cooldown | provider සම්බන්ධතාවල rateLimitedUntil |
/api/rate-limits, /api/providers/[id] |
(අලස ලෙස යළි සක්රීය කරයි; provider PUT හරහා හිස් කරන්න) |
| Model lockout | මතකය තුළ model-availability registry | GET /api/resilience/model-cooldowns |
DELETE /api/resilience/model-cooldowns |
PATCH /api/resilience මඟින් providerBreaker.oauth සහ providerBreaker.apikey යටතේ provider breaker override පිළිගනී. සෑම profile එකක්ම degradationThreshold, failureThreshold, සහ resetTimeoutMs සඳහා සහාය දක්වයි; එම ක්ෂේත්ර Dashboard → Settings → Resilience තුළද නිරාවරණය කර ඇත.
# තනි model lockout එකක් හිස් කරන්න
curl -X DELETE http://localhost:20128/api/resilience/model-cooldowns \
-H "Cookie: auth_token=..." \
-H "Content-Type: application/json" \
-d '{"provider":"openai","model":"gpt-4o-mini"}'
# සියලුම lockout හිස් කරන්න
curl -X DELETE http://localhost:20128/api/resilience/model-cooldowns \
-H "Cookie: auth_token=..." \
-d '{"all":true}'
සම්පූර්ණ සංකල්පීය යොමුව සහ breaker පෙරනිමි අගයන් සඳහා: CLAUDE.md → "Resilience Runtime State" සහ docs/architecture/RESILIENCE_GUIDE.md බලන්න.
Rate-Limit පෝලිම සහ ස්වයංක්රීය-සක්රීය කිරීමේ ආරක්ෂිත ජාලය
- සහාය දක්වන ලිවීමේ මාර්ගය:
POST /api/rate-limitsහි{"connectionId": "<id>", "enabled": true|false}body එක සමඟ connection එකක් සඳහා rate-limit ආරක්ෂණය toggle කිරීමට සහාය දක්වන කළමනාකරණ endpoint එක වේ.PUT /api/providers/[id]මඟින්rateLimitProtectionහිතාමතාම වෙනස් කිරීම හෝ flip කිරීම සිදු නොකරයි (#11278). enabled: falseහි අර්ථය:enabled: falseසැකසීමෙන් connection එක සඳහා පැහැදිලි ආරක්ෂණය ඉවත් කරයි, නමුත් සක්රීය API-key connection එකක් ගෝලීය ස්වයංක්රීය-සක්රීය කිරීමේ ආරක්ෂිත ජාලයෙන් (autoEnableApiKeyProviders = true) ඉවත් නොකරයි.reconcileEnabledConnections(open-sse/services/rateLimitManager.ts) තුළfalseසහundefinedසමාන වේ; පැහැදිලි ආරක්ෂණයක් නොමැති සක්රීය API-key connections ස්වයංක්රීය-සක්රීය කිරීමේ ආරක්ෂිත ජාලය යටතේ ආරක්ෂිතව පවතී.- ගෝලීය අක්රීය කිරීම: rate-limit queues නොමැතිව API-key connections ධාවනය කිරීමට,
RATE_LIMIT_AUTO_ENABLE=false(env) හරහා හෝresilienceSettings.requestQueue.autoEnableApiKeyProviders = false(Settings → Resilience /PATCH /api/resilience) හරහා ආරක්ෂිත ජාලය ගෝලීයව අක්රීය කරන්න.
කුසලතා
අභිරුචි ක්රියාත්මක කළ හැකි handlers සමඟ OmniRoute විස්තාරණය කිරීම සඳහා වූ කුසලතා framework එක සහ marketplace ඒකාබද්ධ කිරීම්.
| Method | Path | විස්තරය |
|---|---|---|
| GET | /api/skills |
ස්ථාපනය කර ඇති skills ලැයිස්තුගත කරන්න — ?q=, ?mode=on|off|auto, ?source=skillsmp|skillssh|local මඟින් filter කළ හැකි, පිටුගත කළ |
| GET | /api/skills/[id] |
එක් skill එකක් ලබා ගන්න |
| PUT | /api/skills/[id] |
skill එක යාවත්කාලීන කරන්න (name, description, mode, schema, handler, tags) |
| DELETE | /api/skills/[id] |
skill එක uninstall කරන්න |
| POST | /api/skills/install |
raw manifest එකකින් skill එකක් ස්ථාපනය කරන්න — body: {name, version, description, schema:{input, output}, handlerCode, apiKeyId?} |
| GET | /api/skills/executions |
මෑත skill executions ලැයිස්තුගත කරන්න (inputs/outputs/duration සහිත audit trail) |
| GET | /api/skills/marketplace?q=... |
SkillsMP marketplace වෙතින් සෙවීම/ජනප්රිය ලැයිස්තුව ( skillsmpApiKey setting අවශ්ය වේ) |
| POST | /api/skills/marketplace/install |
SkillsMP වෙතින් id මඟින් skill එකක් ස්ථාපනය කරන්න |
| GET | /api/skills/skillssh?q=&limit= |
skills.sh registry එක සොයන්න |
| POST | /api/skills/skillssh/install |
skills.sh වෙතින් id මඟින් skill එකක් ස්ථාපනය කරන්න |
සත්යාපනය: කළමනාකරණ session/API key. Marketplace සෙවුම් routes සඳහා කළමනාකරණ auth හෝ Bearer API key එකක් (isAuthenticated) පිළිගනී.
මතකය
ස්ථිර සංවාදමය/තථ්යමය මතක ගබඩාව, එක් API යතුරක් / සැසියක් සඳහා සීමා කර ඇත.
| Method | Path | Description |
|---|---|---|
| GET | /api/memory |
මතක ලැයිස්තුව — ?apiKeyId=, ?type=, ?sessionId=, ?q=, offset/limit හෝ page/limit pagination සමඟ |
| POST | /api/memory |
මතකයක් සාදන්න — Zod මඟින් වලංගු කරන body: {content, key, type?, sessionId?, apiKeyId?, metadata?, expiresAt?} |
| GET | /api/memory/[id] |
එක් මතකයක් ලබාගන්න |
| DELETE | /api/memory/[id] |
මතකයක් මකන්න |
| GET | /api/memory/health |
මතක උපපද්ධතියේ සෞඛ්ය තත්ත්වය (DB සම්බන්ධතාව, embeddings පසුබිම, vector index තත්ත්වය) |
Auth: කළමනාකරණ සැසිය/API යතුර (requireManagementAuth). type enum: FACTUAL, EPISODIC, SEMANTIC, PROCEDURAL (src/lib/memory/types.ts හි MemoryType බලන්න).
MCP සේවාදායකය
OmniRoute මඟින් transports 3ක් (stdio, SSE, streamable-http) සහ scope කළ tools සහිත, ඇතුළත් Model Context Protocol සේවාදායකයක් සපයයි. පහත dashboard endpoints මඟින් තත්ත්වය/audit දත්ත කියවා HTTP transports සඳහා proxy ලෙස ක්රියා කරයි.
| Method | Path | Description | |
|---|---|---|---|
| GET | /api/mcp/status |
Heartbeat, transport, සබැඳි තත්ත්වය, අවසන් call එක, ප්රමුඛ tools, පැය 24ක සාර්ථකතා අනුපාතය | |
| GET | /api/mcp/tools |
name, description, scopes, phase, auditLevel, sourceEndpoints සහිත MCP tools ලැයිස්තුව |
|
| GET | /api/mcp/sse |
SSE transport සඳහා විවෘත SSE stream එකක් ආරම්භ කරන්න (MCP අබල කර ඇත්නම් හෝ transport නොගැළපේ නම් 503 ආපසු ලබා දෙයි) |
|
| POST | /api/mcp/sse |
SSE transport මත JSON-RPC frame එකක් යවන්න | |
| GET | /api/mcp/stream |
Streamable HTTP transport හි SSE පැත්ත විවෘත කරන්න (සේවාදායකය මඟින් ආරම්භ කරන පණිවිඩ) | |
| POST | /api/mcp/stream |
Streamable HTTP transport මත JSON-RPC frame එකක් යවන්න | |
| DELETE | /api/mcp/stream |
Streamable HTTP සැසියක් අවසන් කරන්න | |
| GET | /api/mcp/audit |
audit log විමසන්න — ?limit=, ?offset=, ?tool=, `?success=true |
false, ?apiKeyId=` |
| GET | /api/mcp/audit/stats |
සමස්ත audit සංඛ්යාලේඛන (මුළු ගණන, සාර්ථකතා අනුපාතය, සාමාන්ය කාලය, ප්රමුඛ tools) |
Auth: sse/stream transports MCP-විශේෂිත auth surface එකට අනුකූල වේ (mcp scope සහිත Bearer API යතුරක්); status/tools/audit* routes dashboard වෙතින් කියවිය හැකිය (dashboard host වෙත ළඟාවීමට අවශ්ය අමතර auth එකක් නොමැත).
HTTP transports දෙකම
settings.mcpEnabledසහsettings.mcpTransportමඟින් සීමා කර ඇත — transport නොගැළපීමක්400ආපසු ලබා දෙයි, MCP අබල කළ තත්ත්වයක්503ආපසු ලබා දෙයි.
A2A සේවාදායකය
OmniRoute මඟින් A2A (Agent-to-Agent) JSON-RPC 2.0 endpoint එකක් සහ පරීක්ෂණ/ඩෑෂ්බෝඩ් භාවිතය සඳහා REST wrapper එකක් ලබා දෙයි.
JSON-RPC
POST /a2a
Authorization: Bearer your-api-key # OMNIROUTE_API_KEY සකසා නොමැති නම් විකල්පයකි
Content-Type: application/json
{
"jsonrpc": "2.0",
"id": 1,
"method": "message/send",
"params": {
"skill": "smart-routing",
"messages": [{"role": "user", "content": "Route this coding task"}]
}
}
සහාය දක්වන methods (සියල්ල settings.a2aEnabled මත පාලනය වේ):
| Method | Description |
|---|---|
message/send |
සමමුහුර්ත skill ක්රියාත්මක කිරීම; {task, artifacts, metadata} ලබා දෙයි |
message/stream |
එම skill කට්ටලයම භාවිත කරන streaming SSE ක්රියාත්මක කිරීම |
tasks/get |
taskId මඟින් task එකක් ලබා ගැනීම |
tasks/cancel |
taskId මඟින් task එකක් අවලංගු කිරීම |
Built-in skills: smart-routing, quota-management, provider-discovery, cost-analysis, health-report.
Agent Card
GET /.well-known/agent.json
පොදු A2A agent card එක (නම, විස්තරය, හැකියාවන්, skill catalog, auth scheme) ලබා දෙයි — පැය 1ක් සඳහා පොදු ලෙස cache කරනු ලැබේ. Auth අවශ්ය නොවේ.
REST helpers
| Method | Path | Description |
|---|---|---|
| GET | /api/a2a/status |
A2A සක්රියද යන්න + task සංඛ්යාලේඛන + cache කර ඇති agent card සාරාංශය |
| GET | /api/a2a/tasks |
Tasks ලැයිස්තුගත කිරීම — ?state=submitted|working|completed|failed|cancelled, ?skill=, ?limit= (≤200), ?offset= |
| POST | /api/a2a/tasks |
(REST helper එකක් ලෙස ක්රියාත්මක කර නොමැත — JSON-RPC message/send හරහා සාදන්න) |
| GET | /api/a2a/tasks/[id] |
එක් task එකක් ලබා ගැනීම |
| POST | /api/a2a/tasks/[id]/cancel |
Task එකක් අවලංගු කිරීම |
Auth: REST helpers management auth නොමැතිව ක්රියාත්මක වේ (ඩෑෂ්බෝඩ් මඟින් කියවිය හැක); JSON-RPC /a2a route එක වින්යාස කර ඇත්නම් Bearer OMNIROUTE_API_KEY භාවිත කරයි.
Cloud, Evals සහ Assess
| Method | Path | Description | ||
|---|---|---|---|---|
| POST | /api/cloud/auth |
Bearer key එකක් සත්යාපනය කර cloud sync clients සඳහා mask කළ provider connections + model aliases ලබා දෙයි | ||
| POST | /api/cloud/credentials/update |
Cloud-synced provider එකක් සඳහා encrypted credentials යාවත්කාලීන කරයි | ||
| POST | /api/cloud/model/resolve |
Local routing table එක භාවිත කර logical model id එකක් concrete provider/model එකකට resolve කරයි | ||
| GET | /api/cloud/models/alias |
Cloud sync වෙත නිරාවරණය කරන model aliases ලැයිස්තුගත කරයි | ||
| GET | /api/assess |
නවතම assessment categorizations (provider/model එකකට) කියවයි | ||
| POST | /api/assess |
Assessment එකක් ධාවනය කරයි — body: `{scope: {type:"all"} | {type:"provider", providerId} | {type:"model", modelId}, trigger?}` |
| GET | /api/evals |
Built-in eval suites + නවතම runs ලැයිස්තුගත කරයි | ||
| POST | /api/evals |
Eval run එකක් ආරම්භ කරයි | ||
| POST | /api/evals/suites |
Custom eval suite එකක් සාදයි — body එක evalSuiteSaveSchema මඟින් validate කරයි |
||
| GET | /api/evals/suites/[id] |
Custom eval suite එකක් ලබා ගනී |
Auth: /api/cloud/auth Bearer key එකක් සෘජුව validate කර, manage / admin scope සහිත key එකක් සඳහා පමණක් එක් එක් connection එකේ mask කළ key සහ projectId ලබා දෙයි; අනෙකුත් /api/cloud/*, /api/evals/*, සහ /api/assess routes සඳහා management session/API key අවශ්ය වේ. /api/assess POST මඟින් discriminated-union scope schema සහිත validateBody භාවිත කරයි.
ACP (Agent Client Protocol) කළමනාකරණය
ළමා ක්රියාවලි ලෙස. මෙම endpoint මඟින් ACP agent හඳුනාගැනීම සහ අභිරුචි agent ලියාපදිංචි කිරීම කළමනාකරණය කරයි.
| Method | Path | Description |
|---|---|---|
| GET | /api/acp/agents |
ස්ථාපන තත්ත්වය, අනුවාදය සහ binary සමඟ දන්නා සියලුම CLI agent (ඇතුළත් කළ සහ අභිරුචි) ලැයිස්තුගත කරයි |
| POST | /api/acp/agents |
අභිරුචි ACP agent එකක් ලියාපදිංචි කිරීම හෝ cache එක නැවුම් කිරීම — body: {id, name, binary, versionCommand, providerAlias, spawnArgs, protocol} හෝ {action: "refresh"} |
| DELETE | /api/acp/agents |
අභිරුචි ACP agent එකක් ඉවත් කරයි — query param: ?id=<agentId> |
ප්රතිචාර උදාහරණය (GET /api/acp/agents):
{
"agents": [
{
"id": "claude",
"name": "Claude Code CLI",
"binary": "claude",
"version": "1.0.45",
"installed": true,
"protocol": "stdio",
"providerAlias": "claude",
"isCustom": false
},
{
"id": "my-custom-cli",
"name": "My Custom CLI",
"installed": false,
"protocol": "stdio",
"providerAlias": "my-provider",
"isCustom": true
}
],
"cacheTtlMs": 60000,
"cacheAge": 1234
}
අවසර සත්යාපනය: කළමනාකරණ සැසියක් (dashboard auth_token cookie) හෝ කළමනාකරණ පරාසයට සීමා කළ API key එකක් අවශ්ය වේ.
සම්පූර්ණ විස්තර සඳහා ACP Framework බලන්න.
විශ්ලේෂණ සහ නිරීක්ෂණ හැකියාව
Routing, compression සහ provider විවිධත්වය නිරීක්ෂණය කිරීම සඳහා තත්ය කාලීන
විශ්ලේෂණ endpoint. මේවා /dashboard/analytics/* පිටු බලගන්වයි.
ස්වයංක්රීය routing විශ්ලේෂණ
| Method | Path | Description |
|---|---|---|
| GET | /api/analytics/auto-routing |
සමස්ත ස්වයංක්රීය routing සංඛ්යාලේඛන: මුළු calls ගණන, strategy බෙදාහැරීම, tier බෙදාහැරීම සහ ඉහළම providers |
| GET | /api/analytics/auto-routing?days=7 |
කාල පරාසයක සංඛ්යාලේඛන (පෙරනිමිය පැය 24) |
ප්රතිචාර උදාහරණය:
{
"window": "24h",
"totalCalls": 1234,
"strategyBreakdown": {
"rules": 800,
"cost": 200,
"latency": 150,
"sla-aware": 50,
"lkgp": 34
},
"tierBreakdown": {
"ultra": 100,
"pro": 500,
"standard": 400,
"free": 234
},
"topProviders": [
{ "provider": "openai", "calls": 500, "avgLatencyMs": 850 },
{ "provider": "anthropic", "calls": 300, "avgLatencyMs": 1200 }
]
}
Compression විශ්ලේෂණ
| Method | Path | Description |
|---|---|---|
| GET | /api/analytics/compression |
සමස්ත compression සංඛ්යාලේඛන: සුරැකි tokens, ඉතිරිකිරීමේ %, mode බෙදාහැරීම සහ engine භාවිතය |
ප්රතිචාර උදාහරණය:
{
"window": "24h",
"totalOriginalTokens": 5000000,
"totalCompressedTokens": 3500000,
"totalSavings": 1500000,
"savingsPct": 30.0,
"modeBreakdown": {
"lite": 400,
"standard": 600,
"aggressive": 100,
"ultra": 50,
"rtk": 84
},
"engineBreakdown": {
"caveman": 800,
"rtk": 434
}
}
Provider විවිධත්ව ලුහුබැඳීම
| Method | Path | Description |
|---|---|---|
| GET | /api/analytics/diversity |
Shannon entropy මත පදනම් වූ විවිධත්ව ලුහුබැඳීම: provider ව්යාප්තිය මැනීමෙන් තනි අසාර්ථකතා ලක්ෂ්ය වළක්වයි |
ප්රතිචාර උදාහරණය:
{
"window": "24h",
"shannonEntropy": 2.45,
"maxEntropy": 3.17,
"diversityRatio": 0.77,
"providerUsage": {
"openai": 0.4,
"anthropic": 0.25,
"google": 0.2,
"kiro": 0.15
},
"warnings": ["OpenAI accounts for 40% of traffic — consider diversifying"]
}
අවසර සත්යාපනය: කළමනාකරණ සැසියක් හෝ කළමනාකරණ පරාසයට සීමා කළ API key එකක් අවශ්ය වේ.
පරිපාලන මෙහෙයුම්
පරිපාලකයන්ට පමණක් ලබාගත හැකි මෙහෙයුම් කළමනාකරණ endpoints.
| ක්රමය | මාර්ගය | විස්තර |
|---|---|---|
| GET | /api/admin/concurrency |
වත්මන් සමගාමීතා සීමා කියවන්න (ගෝලීය + එක් provider එකකට) |
| POST | /api/admin/concurrency |
සමගාමීතා සීමා යාවත්කාලීන කරන්න — body: {global?: number, perProvider?: Record<string, number>} |
පරිශීලක සත්යාපනය: පරිපාලක scope සහිත කළමනාකරණ සැසියක් අවශ්ය වේ.
CLI මෙවලම් කළමනාකරණය
OmniRoute සමඟ ඒකාබද්ධ වන CLI මෙවලම් කළමනාකරණය කරන්න (antigravity, commandCode, devin-cli ආදිය). සම්පූර්ණ ලැයිස්තුව සඳහා Provider Reference බලන්න.
| ක්රමය | මාර්ගය | විස්තර |
|---|---|---|
| GET | /api/cli-tools/all-statuses |
සියලුම CLI මෙවලම්වල තත්ත්වය (ස්ථාපිතද, අනුවාදය, අවසන් වරට දුටු වේලාව) |
| GET | /api/cli-tools/status |
එක් CLI මෙවලමක් සඳහා තත්ත්ව විස්තර (?tool= query) |
| POST | /api/cli-tools/apply |
මෙවලමක් සඳහා ජනනය කළ වින්යාසය ලියන්න (dryRun පෙරදසුන් පෙන්වයි; containerized වූ විට 422 + containerEphemeralTarget; migration මඟින් legacy Codex YAML එකක් සටහන් කරයි) |
| GET | /api/cli-tools/backups |
CLI මෙවලම් වින්යාස උපස්ථ ලැයිස්තුගත කරන්න |
| POST | /api/cli-tools/backups |
සියලුම CLI මෙවලම් වින්යාසවල උපස්ථයක් සාදන්න |
| POST | /api/cli-tools/backups |
ප්රතිස්ථාපනය: body තුළ {tool, backupId} සමඟ එම endpoint එක භාවිත කිරීමෙන් එම උපස්ථය ප්රතිස්ථාපනය කරයි |
| GET | /api/cli-tools/antigravity-mitm |
Antigravity MITM proxy තත්ත්වය ("antigravity-mitm" CLI මෙවලම) |
| POST | /api/cli-tools/antigravity-mitm/alias |
antigravity-mitm aliases වින්යාස කරන්න |
පරිශීලක සත්යාපනය: කළමනාකරණ සැසියක් අවශ්ය වේ.
Agent Skills
AI agent skills කළමනාකරණය කරන්න (agents සඳහා OpenAI හි custom GPTs වලට සමාන).
| ක්රමය | මාර්ගය | විස්තර |
|---|---|---|
| GET | /api/agent-skills |
සියලුම agent skills ලැයිස්තුගත කරන්න (අන්තර්නිර්මාණිත + අභිරුචි) |
| GET | /api/agent-skills/[id] |
නිශ්චිත agent skill එකක් ලබාගන්න |
| POST | /api/agent-skills |
අභිරුචි agent skill එකක් සාදන්න — body: {name, description, prompt, model?, temperature?} |
| PUT | /api/agent-skills/[id] |
අභිරුචි agent skill එකක් යාවත්කාලීන කරන්න |
| DELETE | /api/agent-skills/[id] |
අභිරුචි agent skill එකක් මකන්න |
| GET | /api/agent-skills/[id]/raw |
අමු prompt + metadata ලබාගන්න (ක්රියාත්මක කිරීමක් නොමැත) |
| POST | /api/agent-skills/generate |
ස්වාභාවික භාෂා විස්තරයකින් නව skill එකක් AI මඟින් ජනනය කරන්න |
පරිශීලක සත්යාපනය: කළමනාකරණ සැසියක් හෝ කළමනාකරණ scope සහිත API key එකක් අවශ්ය වේ.
හැඹිලි කළමනාකරණය
අර්ථවත් හැඹිලිය සහ තර්කන හැඹිලිය කළමනාකරණය කරන්න.
| Method | Path | Description |
|---|---|---|
| GET | /api/cache |
හැඹිලි දළ විශ්ලේෂණය: මුළු ඇතුළත් කිරීම්, භාවිත අනුපාතය, තැටියේ ප්රමාණය |
| GET | /api/cache/entries |
හැඹිලිගත ඇතුළත් කිරීම් ලැයිස්තුගත කරන්න (පිටුකරණය සහිතව) |
| DELETE | /api/cache/entries |
හැඹිලි ඇතුළත් කිරීම් මකා දමන්න (විමසුම් පරාමිතීන් අනුව පෙරහන් කරන්න) |
| GET | /api/cache/stats |
සවිස්තරාත්මක හැඹිලි සංඛ්යාලේඛන (සැපයුම්කරු අනුව, ආකෘතිය අනුව) |
| GET | /api/cache/reasoning |
තර්කන හැඹිලි තත්ත්වය (තර්කන නැවත ධාවනය සඳහා) |
| DELETE | /api/cache/reasoning |
තර්කන හැඹිලිය හිස් කරන්න — විමසුම් පරාමිතීන්: ?toolCallId=<id> (තනි එකක්) හෝ ?provider=<p> හෝ පරාමිතීන් නොමැතිව (සියල්ල) |
සත්යාපනය: කළමනාකරණ සැසියක් අවශ්ය වේ.
මතක පද්ධතිය
ස්ථිර මතකය (FTS5 + දෛශික embedding) කළමනාකරණය කරන්න.
| Method | Path | Description |
|---|---|---|
| GET | /api/memory |
මතක ඇතුළත් කිරීම් ලැයිස්තුගත කරන්න (විෂය පථය, වර්ගය, සෙවුම් විමසුම අනුව පෙරහන් කරන්න) |
| POST | /api/memory |
නව මතක ඇතුළත් කිරීමක් සාදන්න — අන්තර්ගතය: {scope, type, content, metadata?} |
| GET | /api/memory/[id] |
නිශ්චිත මතක ඇතුළත් කිරීමක් ලබා ගන්න |
| PUT | /api/memory/[id] |
මතක ඇතුළත් කිරීමක් යාවත්කාලීන කරන්න |
| DELETE | /api/memory/[id] |
මතක ඇතුළත් කිරීමක් මකා දමන්න |
| GET | /api/memory?q= |
මතකය සොයන්න (FTS5 + දෛශික) — සංඛ්යාලේඛන එම ප්රතිචාරයටම ඇතුළත් වේ |
සත්යාපනය: කළමනාකරණ සැසියක් හෝ කළමනාකරණ පරාසයක API යතුරක් අවශ්ය වේ.
Webhooks
සිදුවීම් සඳහා Webhook දායකත්ව කළමනාකරණය කරන්න.
| Method | Path | Description |
|---|---|---|
| GET | /api/webhooks |
සියලුම Webhook දායකත්ව ලැයිස්තුගත කරන්න |
| POST | /api/webhooks |
Webhook දායකත්වයක් සාදන්න — අන්තර්ගතය: {url, events[], secret?, active?} |
| GET | /api/webhooks/[id] |
නිශ්චිත Webhook දායකත්වයක් ලබා ගන්න |
| PUT | /api/webhooks/[id] |
Webhook දායකත්වයක් යාවත්කාලීන කරන්න |
| DELETE | /api/webhooks/[id] |
Webhook දායකත්වයක් මකා දමන්න |
| GET | /api/webhooks/[id]/deliveries |
Webhook එකක් සඳහා බෙදාහැරීම් ඉතිහාසය ලැයිස්තුගත කරන්න (සාර්ථක/අසාර්ථක ලොගය) |
| POST | /api/webhooks/[id]/test |
Webhook එකකට පරීක්ෂණ සිදුවීමක් යවන්න |
සත්යාපනය: කළමනාකරණ සැසියක් අවශ්ය වේ.
සම්පූර්ණ සිදුවීම් වර්ග සඳහා Webhooks රාමුව බලන්න.
කුසලතා රාමුව
කුසලතා (agentic extensions framework) කළමනාකරණය කරන්න.
| ක්රමය | මාර්ගය | විස්තරය |
|---|---|---|
| GET | /api/skills |
ස්ථාපනය කර ඇති සියලුම කුසලතා (built-in + custom) ලැයිස්තුගත කරන්න |
| POST | /api/skills/install |
දේශීය මාර්ගයකින් හෝ URL එකකින් කුසලතාවක් ස්ථාපනය කරන්න |
| DELETE | /api/skills/[id] |
කුසලතාවක් අස්ථාපනය කරන්න |
| PUT | /api/skills/[id] |
කුසලතාවක් සක්රීය හෝ අක්රීය කරන්න — body: {enabled?: boolean, mode?: "on" | "off" | "auto"} |
| POST | /api/skills/executions |
කුසලතාවක් ක්රියාත්මක කරන්න — body: {skillName, apiKeyId, input?, sessionId?} |
| GET | /api/skills/executions |
සියලුම කුසලතා සඳහා ක්රියාත්මක කිරීමේ ඉතිහාසය ලැයිස්තුගත කරන්න (?apiKeyId= මඟින් පෙරහන් කරන්න) |
සත්යාපනය: කළමනාකරණ සැසියක් හෝ කළමනාකරණ-පරාසගත API යතුරක් අවශ්ය වේ.
සම්පූර්ණ විස්තර සඳහා කුසලතා රාමුව බලන්න.
ප්ලගීන
OmniRoute ප්ලගීන (තෙවන පාර්ශ්වීය දිගු) කළමනාකරණය කරන්න.
| ක්රමය | මාර්ගය | විස්තරය |
|---|---|---|
| GET | /api/plugins |
ස්ථාපනය කර ඇති ප්ලගීන ලැයිස්තුගත කරන්න |
| POST | /api/plugins/marketplace/install |
marketplace වෙතින් ප්ලගිනයක් ස්ථාපනය කරන්න |
| DELETE | /api/plugins/[name] |
ප්ලගිනයක් අස්ථාපනය කරන්න |
| POST | /api/plugins/[name]/activate |
ප්ලගිනයක් සක්රීය කරන්න |
| POST | /api/plugins/[name]/deactivate |
ප්ලගිනයක් අක්රීය කරන්න |
| GET | /api/plugins/[name]/config |
ප්ලගින වින්යාසය ලබාගන්න |
| PUT | /api/plugins/[name]/config |
ප්ලගින වින්යාසය යාවත්කාලීන කරන්න |
සත්යාපනය: කළමනාකරණ සැසියක් අවශ්ය වේ.
සම්පූර්ණ විස්තර සඳහා ප්ලගීන රාමුව බලන්න.
Shadow Routing
සපයන්නන්ගේ Shadow / A-B සංසන්දනය ස්වාධීන REST surface එකක් නොවේ — එය combo routing හරහා වින්යාස කරනු ලැබේ (Auto-Combo බලන්න). එක් එක් combo හි සංසන්දන මිනුම් GET /api/combos/metrics මඟින් සපයනු ලැබේ.
ආරක්ෂක පාලන
ධාවන කාලයේ ආරක්ෂක පාලන (PII හඳුනාගැනීම, prompt injection හඳුනාගැනීම, vision bridging) පරීක්ෂා කරන්න. ආරක්ෂක පාලන සෑම ඉල්ලීමකදීම ක්රියාත්මක වේ; එක් එක් ඇමතුම සඳහා ඉවත් වීම x-omniroute-disabled-guardrails request header හරහා සිදු කරයි — ස්ථිර enable/disable surface එකක් නොමැත.
| ක්රමය | මාර්ගය | විස්තරය |
|---|---|---|
| GET | /api/guardrails |
ලියාපදිංචි කර ඇති ආරක්ෂක පාලන සහ ඒවායේ තත්ත්වය (name / enabled / priority) ලැයිස්තුගත කරන්න |
| POST | /api/guardrails/test |
නියැදි ආදානයක් මත pre-call pipeline එක dry-run කරන්න — body: {input, disabledGuardrails?} |
සත්යාපනය: කළමනාකරණ සැසියක් අවශ්ය වේ.
සම්පූර්ණ විස්තර සඳහා ආරක්ෂාව > ආරක්ෂක පාලන බලන්න.
සත්යාපනය
අක්තපත්ර පවුල් හතර (ඩෑෂ්බෝඩ් සැසිය, දේශීය CLI ටෝකනය, oma_live_… ප්රවේශ ටෝකනය, manage-ස්කෝප් කළ API යතුර) සහ ඒවා inference යතුරුවලින් වෙනස් වන ආකාරය සඳහා කළමනාකරණ සත්යාපනය බලන්න.
- ඩෑෂ්බෝඩ් මාර්ග (
/dashboard/*)auth_tokenකුකිය භාවිත කරයි - පිවිසීමේදී සුරකින ලද මුරපද හැෂය භාවිත කරයි; විකල්පයක් ලෙස
INITIAL_PASSWORDභාවිත කරයි /api/settings/require-loginහරහාrequireLoginටොගලය සක්රිය හෝ අක්රිය කළ හැකREQUIRE_API_KEY=trueවූ විට/v1/*මාර්ග සඳහා Bearer API යතුරක් විකල්ප වශයෙන් අවශ්ය වේ- මෙම යොමුවේ “කළමනාකරණ ටෝකනය” / “කළමනාකරණ-ස්කෝප් කළ API යතුර” යන්නෙන් අදහස් වන්නේ එම මාර්ගෝපදේශයේ සඳහන් පවුල්වලින් එකකි — අර්ථ දක්වා නොමැති අමතර රහස් වර්ගයක් නොවේ
බිඳෙනසුලු වෙනස (v3.8.0) —
/api/v1/agents/tasks/*සහ cooldown කළමනාකරණ අන්ත ලක්ෂ්ය සඳහා දැන් කළමනාකරණ සත්යාපනය (ඩෑෂ්බෝඩ්auth_tokenකුකිය හෝ කළමනාකරණ-ස්කෝප් කළ API යතුරක්) අවශ්ය වේ. මීට පෙර මෙම මාර්ග සත්යාපනයකින් තොරව ඇමතූ සේවාදායකයන්ට401 Unauthorizedලැබෙනු ඇත.588a0333(fix(auth): require management auth for agent and cooldown APIs) කමිට් එක බලන්න.