280 KiB
API Reference (हिन्दी)
🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇧🇦 bs · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇱 he · 🇭🇷 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 · 🇱🇰 si · 🇸🇰 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।
प्रत्येक डिप्लॉयमेंट /openapi.yaml पर अपनी विशिष्ट स्पेक की प्रति उपलब्ध कराता है, जो बिल्ड के दौरान docs/openapi.yaml से जनरेट होती है। इसमें बिल्ड का संस्करण और एक सापेक्ष सर्वर URL (./) शामिल होता है, इसलिए अनुरोध उसी होस्ट पर बने रहते हैं जिसने दस्तावेज़ उपलब्ध कराया है। डाउनलोड की गई फ़ाइल आयात करने वाले टूल के पास ऐसा कोई होस्ट नहीं होता और उसे बेस URL मैन्युअल रूप से सेट करना पड़ता है।
विषय-सूची
- चैट पूर्णताएँ
- विशिष्ट प्रबंधित सत्र लीज़
- एम्बेडिंग्स
- छवि निर्माण
- दस्तावेज़ OCR
- मॉडल सूचीबद्ध करें
- प्रदाता प्लगइन मैनिफेस्ट
- संगतता एंडपॉइंट
- Files API
- Batches API
- Search API
- WebSocket स्ट्रीमिंग
- कोटा और समस्याओं की रिपोर्टिंग
- सिमेंटिक कैश
- CLIProxyAPI प्रबंधन संगतता
- डैशबोर्ड और प्रबंधन
- कॉम्बो प्रबंधन
- Webhooks
- पंजीकृत कुंजियाँ (स्वचालित प्रबंधन)
- Agents प्रोटोकॉल
- प्रबंधन प्रॉक्सी
- लचीलापन (विस्तारित)
- 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
}
कस्टम हेडर
| Header | Direction | Description |
|---|---|---|
X-OmniRoute-No-Cache |
अनुरोध | कैश को बायपास करने के लिए true पर सेट करें |
x-omniroute-no-memory |
अनुरोध | इस अनुरोध के लिए मेमोरी + स्किल्स इंजेक्शन छोड़ने हेतु true पर सेट करें (no-cache के समान; प्रति-कॉल टोकन/लागत ओवरहेड से बचाता है) |
X-OmniRoute-Progress |
अनुरोध | प्रगति इवेंट के लिए true पर सेट करें |
X-Session-Id |
अनुरोध | बाहरी सेशन एफ़िनिटी के लिए स्टिकी सेशन कुंजी |
x_session_id |
अनुरोध | अंडरस्कोर वाला वैरिएंट भी स्वीकार किया जाता है (डायरेक्ट HTTP) |
X-OmniRoute-Session-Id |
अनुरोध | कॉलर द्वारा दिया गया सेशन/वार्तालाप टैग (मेमोरी में भी भेजा जाता है)। मौजूद होने पर, प्रति-सेशन लागत एट्रिब्यूशन (#8249) के लिए call_logs.session_tag में शब्दशः स्थायी रूप से सहेजा जाता है — अनुपस्थित होने पर कभी संश्लेषित नहीं किया जाता |
Idempotency-Key |
अनुरोध | डीडप कुंजी (5s विंडो) |
X-Request-Id |
अनुरोध | वैकल्पिक डीडप कुंजी |
x-omniroute-connection |
अनुरोध | एकल-मॉडल अनुरोध को किसी एक प्रोवाइडर कनेक्शन (अकाउंट) पर उसकी आईडी द्वारा पिन करें — प्रति अनुरोध अकाउंट पिनिंग देखें |
X-OmniRoute-Cache |
प्रतिक्रिया | HIT या MISS (नॉन-स्ट्रीमिंग) |
X-OmniRoute-Idempotent |
प्रतिक्रिया | डीडुप्लिकेट किए जाने पर true |
X-OmniRoute-Progress |
प्रतिक्रिया | प्रगति ट्रैकिंग चालू होने पर enabled |
X-OmniRoute-Session-Id |
प्रतिक्रिया | OmniRoute द्वारा उपयोग की गई प्रभावी सेशन आईडी |
X-OmniRoute-Request-Id |
प्रतिक्रिया | अनुरोध सहसंबंध आईडी (ज्ञात होने पर) |
X-OmniRoute-Version |
प्रतिक्रिया | OmniRoute बिल्ड वर्ज़न (हमेशा मौजूद) |
X-OmniRoute-Cost-Saved |
प्रतिक्रिया | HIT पर कैश द्वारा बचाई गई USD राशि (केवल कैश हिट) |
X-OmniRoute-Decision |
प्रतिक्रिया | रूटिंग ट्रेस: strategy=<name>; provider=<alias>; latency_ms=<n> (<name> कॉम्बो स्ट्रैटेजी है, या नॉन-कॉम्बो अनुरोध के लिए single) — पूर्णता प्रतिक्रियाओं पर हमेशा मौजूद |
Nginx नोट: यदि आप अंडरस्कोर वाले हेडर पर निर्भर हैं (उदाहरण के लिए
x_session_id), तोunderscores_in_headers on;सक्षम करें।
प्रति अनुरोध अकाउंट पिनिंग
जब किसी प्रोवाइडर के पास कई कनेक्शन (अकाउंट या कुंजियाँ) होते हैं, तो OmniRoute सामान्यतः अपनी अकाउंट-चयन रणनीति के माध्यम से किसी एक का चयन करता है। इसके बजाय, कोई अनुरोध x-omniroute-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"}]}'
- आईडी कहाँ खोजें। डैशबोर्ड में प्रदाता पृष्ठ खोलें
(Dashboard → Providers → ) और किसी कनेक्शन पंक्ति पर
xxxxxxxx…आईडी चिप पर क्लिक करें — इससे पूरी कनेक्शन आईडी कॉपी हो जाती है। - यह किन अनुरोधों पर लागू होती है।
/v1/chat/completions,/v1/messagesऔर/v1/responsesपर एकल-मॉडल अनुरोध (provider/model)। कॉम्बो इस हेडर को अनदेखा करते हैं: इसके बजाय प्रत्येक कॉम्बो चरण के अपने कनेक्शन के माध्यम से उस चरण के लिए एक खाता पिन करें। - पिन सख्त है, केवल प्राथमिकता नहीं। पिन किए गए कनेक्शन का विशेष रूप से उपयोग किया जाता है। अनुरोध के अंदर हुई विफलता खाते के कूलडाउन को दर्ज करती है, लेकिन उसी प्रदाता के किसी सहोदर खाते पर रोटेट नहीं करती।
- कूलडाउन और कोटा पिन जारी कर देते हैं। जब पिन किया गया कनेक्शन कूलडाउन में हो, कोटा समाप्त हो गया हो या कोटा नीति द्वारा अवरुद्ध हो, तो बाद के अनुरोध प्रदाता के अन्य कनेक्शनों पर फ़ॉलबैक हो जाते हैं, बिल्कुल बिना पिन किए गए ट्रैफ़िक की तरह।
- अज्ञात या अक्षम आईडी विफल हो जाती हैं। ऐसी आईडी जो प्रदाता के सक्रिय पूल में नहीं है (हटा दी गई, निष्क्रिय की गई, या किसी अन्य प्रदाता से संबंधित है), कोई पात्र खाता नहीं छोड़ती; इसलिए अनुरोध बिना चुपचाप कहीं और रूट हुए विफल हो जाता है।
Claude Code कस्टम हेडर ANTHROPIC_CUSTOM_HEADERS के माध्यम से भेजता है। इसे ~/.claude/settings.json के env ब्लॉक में रखें, या प्रति प्रोजेक्ट अलग खाता पिन करने के लिए प्रोजेक्ट-स्तरीय .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 (हेडर पढ़ना), src/sse/services/auth.ts और
src/sse/services/sessionAffinityPin.ts (पिन जारी करना और पूल से अनुपस्थित होने की जाँच)।
लागत टेलीमेट्री हेडर: गैर-स्ट्रीमिंग सफल प्रतिक्रियाओं में
X-OmniRoute-*लागत-टेलीमेट्री सेट भी शामिल होता है —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, और मीडिया एंडपॉइंट्स —/v1/embeddings,/v1/images/generations,/v1/audio/speech,/v1/audio/transcriptions,/v1/rerank,/v1/videos/generations,/v1/music/generations, और/v1/moderations— द्वारा जारी किए जाते हैं (लागत हमेशा0)। मीडिया लागत की गणना प्रति मोडैलिटी (प्रति-छवि, प्रति-सेकंड, प्रति-वर्ण, प्रति सर्च-यूनिट) की जाती है, जब मूल्य उपलब्ध हो; अन्यथा0(फ़ेल-ओपन)।
कैश-हिट लागत का अर्थ: किसी सिमेंटिक-कैश HIT (
X-OmniRoute-Cache-Hit: true) पर कोई अपस्ट्रीम कॉल नहीं की जाती, इसलिएX-OmniRoute-Response-Cost0.0000000000होता है (हिट प्रदान करने की वृद्धिशील लागत)। मूल/होने वाली लागत अलग सेX-OmniRoute-Cost-Savedमें रिपोर्ट की जाती है। बिलिंग उपभोक्ताओं कोX-OmniRoute-Response-Costका योग करना चाहिए (हिट की कोई लागत नहीं होती); कैश विश्लेषणX-OmniRoute-Cost-Savedको एकत्र कर सकता है।
एक्सक्लूसिव मैनेज्ड सेशन लीज़
एक्सक्लूसिव मैनेज्ड सेशन लीज़िंग एक वैकल्पिक, क्लाइंट-निरपेक्ष रूटिंग अनुबंध है: एक सक्रिय स्वामी एक योग्य OmniRoute कनेक्शन रखता है। यह किसी मॉडल को लीज़ नहीं करता, OAuth की आवश्यकता नहीं रखता, किसी विशेष क्लाइंट की पहचान नहीं करता, और किसी विशेष प्रदाता की आवश्यकता नहीं रखता।
प्रमाणीकरण करने वाली API key के पास lease:exclusive स्कोप और स्पष्ट, गैर-रिक्त
allowedConnections सूची होनी चाहिए। डेटाबेस म्यूटेशन सीमा key निर्माण और आंशिक अपडेट के समय
दोनों फ़ील्ड को एक साथ लागू करती है।
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 प्रतिक्रियाएँ टाइमस्टैम्प, state, और सटीक धनात्मक
generation दिखाती हैं, लेकिन चयनित कनेक्शन या क्रेडेंशियल कभी नहीं दिखातीं। Renew और release
JSON बॉडी में generation देते हैं:
{ "action": "renew", "generation": 1 }
{ "action": "release", "generation": 1, "reason": "OWNER_EXIT" }
एक सक्रिय लीज़ स्वामी अपने वर्तमान बाइंडिंग के लिए गोपनीयता-सुरक्षित डिस्प्ले मेटाडेटा का स्पष्ट रूप से अनुरोध कर सकता है:
{ "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 action एक ही डेटाबेस ट्रांज़ैक्शन में अपारदर्शी स्वामी, प्रमाणीकृत मैनेज्ड API key,
और सटीक सक्रिय generation द्वारा संरक्षित है। displayName केवल कॉन्फ़िगर किए गए कनेक्शन का
ट्रिम किया हुआ नाम है; सुरक्षित रूप से कॉन्फ़िगर किया गया नाम उपलब्ध न होने पर यह null होता है।
OmniRoute कभी भी ईमेल या जनरेट की गई अकाउंट पहचान का विकल्प नहीं रखता। provider मान एक
गैर-संवेदनशील डिस्प्ले लेबल है और कभी भी जनरेट किया गया compatible-provider identifier नहीं होता।
क्रेडेंशियल, टोकन, कुकीज़, raw connection या API key ids, owner hashes, fencing secrets, और
आंतरिक रूटिंग डेटा शामिल नहीं किए जाते।
गलत key, गलत owner, पुराने generation, अनुपलब्ध, समाप्त, रिलीज़ किए गए और अमान्य किए गए lookup
सभी कनेक्शन मेटाडेटा के बिना एक ही 409 LEASE_FENCE_STALE त्रुटि लौटाते हैं। जिस क्लाइंट को
capacity-wait प्रतिक्रिया मिली है, उसके निरीक्षण के लिए कोई सक्रिय बाइंडिंग नहीं होती। जब रूटिंग
किसी सक्रिय लीज़ को ट्रांज़िशन करती है, तो वही generation वैध रहता है और status परमाणु रूप से नई
बाइंडिंग लौटाता है, पुरानी बाइंडिंग कभी नहीं। मौजूदा क्लाइंट अपरिवर्तित रहते हैं क्योंकि acquire,
renew, release और waiting प्रतिक्रियाएँ अपने पिछले आकार में बनी रहती हैं।
यह सर्वर अनुबंध स्टॉक OpenAI Codex /status को नहीं बदलता। स्टॉक Codex वर्तमान में अपने
मॉडल प्रदाता और अंतर्निहित प्रमाणीकरण/अकाउंट स्थिति की रिपोर्ट करता है, लेकिन मनमाने कस्टम
प्रदाता अकाउंट मेटाडेटा को रेंडर नहीं करता; बाद के क्लाइंट इंटीग्रेशन को इस action को कॉल करना
होगा और यह तय करना होगा कि connection.displayName को कैसे दिखाया जाए।
हर मैनेज्ड inference request तब दोनों नियंत्रण हेडर भेजती है:
X-OmniRoute-Lease-Owner: vlo_<43-base64url-characters>
X-OmniRoute-Lease-Generation: 1
हर समर्थित upstream प्रयास से ठीक पहले सटीक owner, generation, सक्रिय कनेक्शन और प्रमाणीकृत API key को संरक्षित किया जाता है। किसी अन्य key के साथ owner और generation को दोहराने पर अनुरोध विफल हो जाता है, भले ही वह key उसी कनेक्शन की अनुमति देती हो। Raw owners को स्थायी रूप से संग्रहीत, लॉग, बनाए या request snapshot में सुरक्षित नहीं किया जाता, न ही upstream को भेजा जाता है।
अस्थायी विवाद Retry-After के साथ HTTP 429 और यह प्रतिक्रिया लौटाता है:
{
"state": "WAITING_FOR_CAPACITY",
"error": { "type": "lease_error", "code": "LEASE_CAPACITY_UNAVAILABLE" },
"reason": "NO_FREE_ELIGIBLE_CONNECTION",
"retryAfter": 30
}
इस प्रतिक्रिया का केवल यह अर्थ है कि सामान्य योग्य सेट गैर-रिक्त था और प्रत्येक मुक्त उम्मीदवार किसी विदेशी सक्रिय लीज़ के पास था। असमर्थित मॉडल/प्रदाता, नीति असंगति, cooldown, quota, health और अन्य सामान्य eligibility विफलताएँ अपनी मौजूदा OmniRoute प्रतिक्रियाएँ बनाए रखती हैं।
x-omniroute-compression
कंप्रेशन योजना का प्रति-अनुरोध ओवरराइड। सर्वोच्च प्राथमिकता — routing-combo ओवरराइड, सक्रिय प्रोफ़ाइल, auto-trigger और panel Default से भी ऊपर:
| मान | प्रभाव |
|---|---|
off |
इस अनुरोध के लिए कोई कंप्रेशन नहीं। |
default |
panel-derived Default प्रोफ़ाइल (सक्रिय प्रोफ़ाइल को अनदेखा करती है)। Lossy engines बंद रहते हैं। |
safe |
केवल dedup और whitespace folding। |
allow-lossy |
इस अनुरोध के लिए operator plan बनाए रखें, जिसमें summaries और style rewrites शामिल हैं। |
engine:<id> |
सक्षम होने पर एकल engine, जैसे engine:rtk। उस engine के लिए प्रति-अनुरोध opt-in। |
<combo> |
नामित combo, पहले नाम (case-insensitive) से, फिर id से मिलाया जाता है। |
नोट्स:
- अज्ञात मानों को अनदेखा किया जाता है (अनुरोध कभी अस्वीकार नहीं किया जाता); resolution सामान्य operator precedence के अनुसार आगे बढ़ता है।
- यदि कई combos का नाम समान है, तो deterministic match के लिए combo id भेजें।
- जिस combo का नाम
offयाdefaultहै, उसे नाम से चयनित नहीं किया जा सकता (इन keywords की पहले व्याख्या की जाती है); ऐसे combo को उसके id से संदर्भित करें। - master compression switch एक hard gate है: जब कंप्रेशन वैश्विक रूप से अक्षम हो, तो यह header इसे सक्षम नहीं कर सकता।
लागू की गई योजना प्रतिक्रिया हेडर में वापस दी जाती है:
X-OmniRoute-Compression: <mode>; source=<source>
जहाँ <source> इनमें से एक है: request-header, routing-override, active-profile, auto-trigger, default या off.
एम्बेडिंग
POST /v1/embeddings
Authorization: Bearer your-api-key
Content-Type: application/json
{
"model": "nebius/Qwen/Qwen3-Embedding-8B",
"input": "The food was delicious"
}
उपलब्ध प्रदाता: Nebius, OpenAI, Mistral, Together AI, Fireworks, NVIDIA, OpenRouter, Jina AI।
कैटलॉग आईडी provider/model होती हैं (उदाहरण: jina-ai/jina-embeddings-v5-omni-small)। रजिस्ट्री में दिखाई देने वाली बिना-प्रदाता वाली Jina मॉडल आईडी (उदाहरण के लिए, jina-embeddings-v5-text-small, jina-reranker-v3.5) भी हल हो जाती हैं। Jina embed/rerank/classify/segment पहले डैशबोर्ड के jina-ai क्रेडेंशियल का उपयोग करते हैं; JINA_AI_API_KEY का उपयोग केवल तब फ़ॉलबैक के रूप में होता है, जब कोई डैशबोर्ड कुंजी मौजूद न हो। jina-reader कार्ड केवल Reader / r.jina.ai के लिए है (POST /v1/web/fetch) और यह कभी भी embeddings या rerank उपलब्ध नहीं कराता।
मल्टीमोडल समर्थन का उल्लेख करने वाले रजिस्ट्री मॉडल अधिकतम 32 प्रदाता-निरपेक्ष संरचित आइटम भी स्वीकार करते हैं। मीडिया आइटम के प्रकार text, image, audio, video, और document हैं। उनका मीडिया 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,
और फ़ैमिली उपनाम jina-ai/jina-embeddings-v5-omni → omni-small) Jina के मूल
EmbeddingsV5Request दस्तावेज़ भी स्वीकार करता है और उन्हें बिना बदलाव के
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,..." }] }
]
}
मूल { image | audio | video | pdf } मान सार्वजनिक HTTPS URL, data: URI या रॉ
base64 हो सकते हैं। OmniRoute इन ऑब्जेक्ट को स्ट्रिंग में परिवर्तित नहीं करता और मूल image URL को फ़ेच नहीं करता — Jina स्वयं सार्वजनिक मीडिया प्राप्त करता है। अतिरिक्त Jina फ़ील्ड (task, normalized, truncate, embedding_type) फ़ॉरवर्ड किए जाते हैं। केवल-टेक्स्ट वाले Jina SKU अब भी गैर-टेक्स्ट दस्तावेज़ अस्वीकार करते हैं।
सुरक्षा और ट्रांसपोर्ट सीमाएँ:
- रिमोट मीडिया URL सार्वजनिक HTTPS होने चाहिए। कैनोनिकल
{type,source:url}आइटम सर्वर-साइड फ़ेच किए जाते हैं (रीडायरेक्ट पुनः सत्यापन, टाइमआउट, आकार सीमाएँ, सार्वजनिक DNS, कनेक्शन पिनिंग) और प्रदाता कॉल से पहले इनलाइन किए जाते हैं। Jina-मूल{image:"https://..."}आइटम समान सार्वजनिक-HTTPS जाँच के बाद जैसे के तैसे फ़ॉरवर्ड किए जाते हैं; URL को Jina फ़ेच करता है। - इनलाइन base64 मीडिया की सीमा प्रति आइटम 8 MiB डिकोडेड और पूरे अनुरोध में 16 MiB डिकोडेड है।
प्रदाता अनुवाद (कैनोनिकल आइटम कभी भी बिना बदलाव के फ़ॉरवर्ड नहीं किए जाते):
- Jina मल्टीमोडल मॉडल: प्रत्येक शीर्ष-स्तरीय आइटम एक modality-keyed ऑब्जेक्ट
(
text/image/audio/video/pdf) बन जाता है, जिसमें इनलाइन मीडिया के लिए data URI का उपयोग होता है; प्रत्येक शीर्ष-स्तरीय आइटम के लिए एक वेक्टर। - Gemini Embedding 2 फ़ैमिली: एक शीर्ष-स्तरीय array एकल मूल
models/{model}:embedContentअनुरोध में बदल जाता है, जिसमेंcontent.parts(textयाinline_data) होते हैं। - llama.cpp (
llama-cpp/<model>, स्थानीय सर्वर द्वारा लोड किया गया कोई भी मॉडल): कैनोनिकलtextआइटम साधारण strings बन जाते हैं, औरimage/audio/videoप्रत्येक एक{"content": [part]}ऑब्जेक्ट बन जाते हैं, जिसमें llama-server के chat content parts (image_url,input_audiowith formatwav/mp3/flac,input_video) और इनलाइन डेटा का उपयोग होता है; प्रत्येक शीर्ष-स्तरीय आइटम के लिए एक वेक्टर। सर्वर को--embedding --mmproj …के साथ चलना आवश्यक है; projector के बिना यह स्वयं मीडिया को अस्वीकार कर देता है।documentसमर्थित नहीं है। - स्पष्ट modality मेटाडेटा के बिना अज्ञात/डायनेमिक मॉडल संरचित इनपुट को 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"
}
असमर्थित मॉडल/मॉडैलिटी संयोजन आइटम को जबरन बदलने के बजाय HTTP 400 लौटाते हैं। पुराने string/token अनुरोधों में मौजूद गैर-इनपुट extension फ़ील्ड अब भी बिना बदलाव के आगे भेजे जाते हैं।
# सभी embedding मॉडल सूचीबद्ध करें
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), हाइपरबोलिक, NanoBanana शामिल हैं।OpenRouter ,ZenMux , SD WebUI (स्थानीय), ComfyUI (स्थानीय)।
n data[] में n छवियाँ लौटाता है। जिन प्रदाताओं का अपस्ट्रीम API प्रति कॉल एक छवि लौटाता है (ब्लैक फॉरेस्ट लैब्स, स्टेबिलिटी AI, लियोनार्डो, आइडियोग्राम, Haiper, हाइपरबोलिक, Magnific/Freepik, NVIDIA NIM, Cloudflare वर्कर्स AI) उन्हें n अलग अपस्ट्रीम कॉल मिलते हैं, उड़ान में अधिकतम 4। एक निश्चित seed कॉल इंडेक्स (seed, seed + 1,…) द्वारा ऑफसेट किया जाता है, इसलिए छवियां भिन्न होती हैं लेकिन प्रतिलिपि प्रस्तुत करने योग्य रहती हैं। n 10 पर सीमित कर दिया गया है। यदि कोई कॉल विफल हो जाती है तो अनुरोध पूरी तरह से विफल हो जाता है। फैन-आउट प्रारूपों की सूची open-sse/handlers/imageGeneration/fanOut.ts में SINGLE_IMAGE_FANOUT_FORMATS है।
ZenMux मौजूदा एपीआई-कुंजी कनेक्शन का पुन: उपयोग करता है और zenmux/ या zm/ उपसर्गों को स्वीकार करता है:
zenmux/openai/gpt-image-2ZenMux की OpenAI छवियाँ API उपयोग करता है। विकल्पों मेंsize,quality,n,output_format,output_compression,background, औरresponse_formatशामिल हैं।- अन्य प्रकाशक, जैसे
zm/meta/muse-image-1.0, ZenMux के वर्टेक्स 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के साथ अनुरोध किया जा सकता है।
यह एकीकरण टेक्स्ट-टू-इमेज जेनरेशन का समर्थन करता है, संदर्भ-छवि संपादन का नहीं। वर्टेक्स आउटपुट को data[].b64_json पर सामान्यीकृत किया जाता है; जब केवल छवि बाइट्स उपलब्ध हों तो response_format: "url" एक अपस्ट्रीम HTTPS URL या बेस 64 डेटा URL लौटाता है। Empty/filtered आउटपुट खाली सफलता के बजाय एक त्रुटि लौटाता है। मॉडल एक्सेस ZenMux खाते पर निर्भर करता है। ZenMux की वर्टेक्स 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 प्रीफ़िक्स के माध्यम से OCR प्रदाता चुनता है; केवल मॉडल आईडी (जैसे
mistral-ocr-latest) अपने पंजीकृत प्रदाता से रिज़ॉल्व होती है, और छोड़ा गया model डिफ़ॉल्ट रूप से
Mistral (mistral-ocr-latest) पर सेट होता है। पंजीकृत प्रदाता (open-sse/config/ocrRegistry.ts):
| प्रदाता आईडी | मॉडल आईडी | model मान |
टिप्पणियाँ |
|---|---|---|---|
mistral |
mistral-ocr-latest |
mistral/mistral-ocr-latest (या केवल mistral-ocr-latest) |
सिंक्रोनस — प्रतिक्रिया सीधे एकल upstream कॉल से लौटाई जाती है। |
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 पार्टनर endpoint के माध्यम से — प्रमाणीकरण/URL के लिए नीचे देखें। |
तीनों प्रदाता एक ही Mistral-आकार के बॉडी में प्रतिक्रिया देते हैं:
{
"pages": [{ "index": 0, "markdown": "# Extracted text..." }],
"model": "mistral-ocr-latest",
"usage_info": { "pages_processed": 1 }
}
Azure Document Intelligence पोल फ़्लो
Azure Document Intelligence का analyze API एसिंक्रोनस है: प्रारंभिक अनुरोध बॉडी के बजाय
Operation-Location हेडर लौटाता है, और परिणाम के लिए पोल करना आवश्यक होता है। हैंडलर
(open-sse/handlers/ocr.ts) हर सेकंड अधिकतम 30 प्रयासों तक उस URL पर पोल करता है, गैर-ok पोल प्रतिक्रिया
या "failed" स्थिति मिलने पर तुरंत विफल हो जाता है (पोलिंग जारी नहीं रखता), और यदि प्रयासों की सीमा समाप्त होने
के बाद भी ऑपरेशन चल रहा हो, तो 504 लौटाता है। अंतिम Azure प्रतिक्रिया को लौटाने से पहले Mistral द्वारा
उपयोग किए जाने वाले उसी pages/markdown आकार में सामान्यीकृत किया जाता है, इसलिए क्लाइंट कोड में प्रदाता के
अनुसार अलग-अलग व्यवहार करने की आवश्यकता नहीं होती।
Vertex AI DeepSeek OCR प्रमाणीकरण और endpoint रिज़ॉल्यूशन
vertex-deepseek-ocr उसी Vertex AI प्रमाणीकरण का पुनः उपयोग करता है जिसे OmniRoute पहले से
chat/image ट्रैफ़िक के लिए समर्थन करता है (open-sse/executors/vertex.ts): कनेक्शन की API key या तो
Service Account JSON क्रेडेंशियल होती है (JWT-bearer फ़्लो के माध्यम से अल्पकालिक OAuth access token के लिए
एक्सचेंज की जाती है) या पहले से मिंट किया गया OAuth access token, जिसका सीधे उपयोग किया जाता है। upstream
endpoint URL Vertex के सामान्य openapi/chat/completions पार्टनर endpoint का होता है, जिसे कनेक्शन के
प्रोजेक्ट और क्षेत्र से बनाया जाता है — स्पष्ट providerSpecificData.project/providerSpecificData.region
को हमेशा प्राथमिकता मिलती है; अन्यथा प्रोजेक्ट Service Account JSON के project_id से प्राप्त किया जाता है
और क्षेत्र डिफ़ॉल्ट रूप से us-central1 होता है। दोनों रिज़ॉल्यूशन
open-sse/handlers/ocr.ts (resolveVertexOcrAccessToken, resolveVertexOcrBaseUrl) में होते हैं,
जिनका उपयोग src/app/api/v1/ocr/route.ts handleOcr को डिस्पैच करने से पहले करता है।
मॉडल सूचीबद्ध करें
GET /v1/models
Authorization: Bearer your-api-key
→ 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, दशमलव स्ट्रिंग | OpenRouter-संगत, कभी भी घातांक संकेतन में नहीं। दोनों कैश फ़ील्ड केवल तभी दिखाई देते हैं जब कैश की कीमत हो। |
input, output, cached, cache_creation |
प्रति 1M टोकन USD, संख्या | पहले के कैटलॉग संस्करणों के फ़ील्ड, मौजूदा क्लाइंट के लिए रखे गए हैं। जब मूल्य-पंक्ति में ये हों, तो reasoning और long_context भी दिखाई देते हैं। |
- कॉम्बो अपने पहले दृश्यमान लक्ष्य की कीमत रखते हैं। अंतर्निहित
auto/*कॉम्बो अनुरोध के समय लक्ष्य चुनते हैं, इसलिए उनमेंpricingनहीं होता। - निःशुल्क मॉडल तब
"0"(और0) दिखाते हैं जब उनकी कीमत शून्य हो। जिस मॉडल की कोई मूल्य-पंक्ति नहीं है, वह भी"0"दिखाता है, जब कैटलॉग उसे निःशुल्क (free: true) चिह्नित करता है या अंतर्निहित निःशुल्क-मॉडल कैटलॉग में सूचीबद्ध करता है। - अज्ञात कीमत: एंट्री में
pricingकुंजी नहीं होती। - क्रेडिट-आधारित प्रदाता (जैसे Kiro) प्रति टोकन के बजाय प्रति अनुरोध बिल करते हैं। उनकी एंट्री में पहले से मौजूद प्रति-1M संख्यात्मक फ़ील्ड बने रहते हैं और उनमें प्रति-टोकन स्ट्रिंग फ़ील्ड नहीं होते।
- वेरिएंट (रीज़निंग-प्रयास आईडी, नो-थिंकिंग एलियास, डिस्कवरी और गेटवे मिरर) उस मॉडल की कीमत कॉपी करते हैं जिस पर वे रूट होते हैं।
- फ़ील्ड केवल आधार दरें रखते हैं। लंबे-संदर्भ स्तर (संख्यात्मक
long_contextफ़ील्ड) और सेवा-स्तर गुणक (उदाहरण के लिए Codex fast या flex)promptयाcompletionको नहीं बदलते। - ऑब्जेक्ट हर प्रमाणीकरण शैली के लिए समान होता है, जिसमें
x-api-keyऔरanthropic-versionवाला Anthropic-शैली अनुरोध भी शामिल है (प्रतिक्रिया{ "object": "list", "data": [...] }ही रहती है)। कार्यान्वयन:src/app/api/v1/models/catalogPricing.ts।
मॉडल आईडी प्रीफ़िक्स (?prefix=)
अधिकांश मॉडल प्रदाता प्रीफ़िक्स के अंतर्गत विज्ञापित किए जाते हैं। आपको कौन-सा प्रीफ़िक्स मिलता है, यह MODELS_CATALOG_PREFIX_MODE फ़ीचर फ़्लैग द्वारा नियंत्रित होता है और इसे क्वेरी पैरामीटर के माध्यम से प्रति अनुरोध ओवरराइड किया जा सकता है — यह उस क्लाइंट के लिए उपयोगी है जो सर्वर-व्यापी सेटिंग को बाकी सभी के लिए बदले बिना एक साफ़ सूची चाहता है:
GET /v1/models?prefix=alias # प्रति मॉडल एक आईडी — छोटा एलियास प्रीफ़िक्स
GET /v1/models?prefix=dual # दोनों रूप (सर्वर डिफ़ॉल्ट)
GET /v1/models?prefix=canonical # केवल पूर्ण प्रदाता-आईडी प्रीफ़िक्स
| मोड | उत्सर्जित | टिप्पणियाँ |
|---|---|---|
dual |
cc/claude-sonnet-4-6 और claude/claude-sonnet-4-6 |
डिफ़ॉल्ट। दोनों आईडी एक ही मॉडल पर रूट होती हैं; इन्हें इसलिए रखा गया है ताकि किसी भी रूप को हार्डकोड करने वाले क्लाइंट कॉन्फ़िगरेशन काम करते रहें। कैटलॉग लगभग दोगुना हो जाता है। |
alias |
cc/claude-sonnet-4-6 |
प्रति मॉडल एक एंट्री। अलग एलियास न रखने वाले प्रदाता भी अपनी एंट्री उत्सर्जित करते हैं, इसलिए कुछ भी खोता नहीं है। |
canonical |
claude/claude-sonnet-4-6 |
पूर्ण प्रदाता-आईडी प्रीफ़िक्स के अंतर्गत प्रति मॉडल एक एंट्री। अलग एलियास न रखने वाले प्रदाता (जैसे antigravity/…, agy/…) भी यहाँ अपनी एकल आईडी उत्सर्जित करते हैं, इसलिए कुछ भी खोता नहीं है। |
क्वेरी पैरामीटर के बिना भी dual-मोड मिरर पहचाना जा सकता है: इसमें प्राथमिक आईडी की ओर संकेत करने वाला parent फ़ील्ड होता है।
जो क्लाइंट मॉडल पिकर रेंडर करते हैं, उन्हें ?prefix=alias का अनुरोध करना चाहिए — OmniCopilot VS Code एक्सटेंशन यही करता है।
डिस्कवरी फ़िल्टर (?capability=, ?min_context=, ?kind=, ?q=)
GET /v1/models वैकल्पिक डिस्कवरी फ़िल्टर स्वीकार करता है। इनमें से किसी के बिना प्रतिक्रिया अपरिवर्तित रहती है। ये उस कैटलॉग को सीमित करते हैं जिसे कॉलर पहले से देख सकता है (API-कुंजी अनुमतियाँ पहले लागू होती हैं), और ये OpenAI-शैली के limit / after पेजिंग से पहले चलते हैं:
GET /v1/models?capability=vision&capability=tool_calling # सूचीबद्ध प्रत्येक क्षमता का true होना आवश्यक है
GET /v1/models?capability=vision,reasoning&min_context=200000
GET /v1/models?kind=embedding # कैटलॉग का `type`; जिन पंक्तियों में यह नहीं है वे `chat` हैं
GET /v1/models?q=sonnet&limit=10 # id या name पर केस-असंवेदी मिलान
| Param | Values |
|---|---|
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 उसी कैटलॉग से एक छोटी, नियतात्मक सूची लौटाता है, जिसमें
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 लौटाता है।
व्यक्तिगत रूप से छिपे हुए चैट मॉडल
जिस मॉडल को उसके प्रदाता पृष्ठ पर Hidden के रूप में चिह्नित किया गया है, उसे कैटलॉग से बाहर
रखा जाता है और स्पष्ट रूप से अनुरोध किए जाने पर HTTP 404 / model_not_found के साथ अस्वीकार
कर दिया जाता है। जाँच में resolved प्रदाता और मॉडल का उपयोग होता है, जिसमें प्रदाता उपनाम,
compatible-provider node prefixes और connection defaults भी शामिल हैं। कोई combo छिपे हुए
targets को छोड़ देता है और किसी दृश्यमान sibling का उपयोग कर सकता है; जब कोई executable
target शेष नहीं रहता, तो वही error code लौटाया जाता है। छिपाना हटाने का प्रभाव अगले अनुरोध
से लागू होता है। केवल इमेज के लिए किए गए visibility overrides उसी ID वाले चैट मॉडल को नहीं
छिपाते।
मॉडल की यह व्यक्तिगत सेटिंग
मॉडल exposure allow/deny lists से अलग है, जो कैटलॉग
विज्ञापन और auto-routing candidates को फ़िल्टर करती हैं, जबकि explicit dispatch को बनाए रखती
हैं। API-key model permissions स्वतंत्र रूप से लागू होती रहती हैं। डिफ़ॉल्ट catalog prefix mode
dual ही रहता है।
नो-थिंकिंग मॉडल variants
Thinking-सक्षम Claude मॉडलों के लिए /v1/models एक no-thinking variant भी विज्ञापित करता
है, जिसकी id claude-3-omniroute-no-thinking/ से शुरू होती है:
claude-3-omniroute-no-thinking/<provider>/<model>
इस id का चयन करने पर (उदाहरण के लिए ऐसे Claude Code config में जो हमेशा thinking block
जोड़ता है), यह वास्तविक <provider>/<model> पर वापस resolve होता है और reasoning को दबा देता
है — /v1/messages path पर thinking:{type:"disabled"}, या
/v1/chat/completions path पर reasoning/reasoning_effort fields को हटा दिया जाता है।
यह variant केवल उन Claude-family मॉडलों के लिए सूचीबद्ध किया जाता है जो thinking का समर्थन
करते हैं और disabled का सम्मान करते हैं (इसलिए, उदाहरण के लिए, disabled को अस्वीकार
करने वाले केवल-adaptive मॉडलों को बाहर रखा जाता है)। Operators प्रति मॉडल
ModelSpec.noThinkingAlias के माध्यम से variant को बलपूर्वक चालू या बंद कर सकते हैं।
प्रदाता प्लगइन मेनिफेस्ट
GET /api/v1/provider-plugin-manifest
Bifrost, CLIProxyAPI और भविष्य के साइडकार राउटर द्वारा उपयोग किया जाने वाला JSON-सुरक्षित प्रदाता प्लगइन मेनिफेस्ट लौटाता है। प्रतिक्रिया TypeScript प्रदाता रजिस्ट्री से जनरेट की जाती है और इसमें जानबूझकर OAuth क्लाइंट सीक्रेट, रनटाइम एनवायरनमेंट रिज़ॉल्यूशन, एक्ज़ीक्यूटर फ़ंक्शन, अनुरोध हेडर और अकाउंट डेटा शामिल नहीं किए जाते।
इस एंडपॉइंट का उपयोग तब करें जब कोई साइडकार आउट-ऑफ़-प्रोसेस चलता हो और सीधे
open-sse/config/providerPluginManifestRegistry.ts इम्पोर्ट न कर सकता हो।
ElevenLabs ऑडियो जनरेशन
अपनी ElevenLabs API कुंजी के साथ OmniRoute में elevenlabs प्रदाता कनेक्शन कॉन्फ़िगर करें।
क्लाइंट अपनी OmniRoute कुंजी (Authorization: Bearer $OMNIROUTE_API_KEY) से प्रमाणित होते हैं;
गेटवे संग्रहीत प्रदाता कुंजी को xi-api-key के रूप में भेजता है। ElevenLabs कुंजी को गेटवे
बेयरर टोकन के रूप में कभी न भेजें।
| विधि | पथ | प्रतिक्रिया | API कुंजी एंडपॉइंट श्रेणी |
|---|---|---|---|
| POST | /v1/sound-generation |
मूल ऑडियो बाइट्स | elevenlabs |
| POST | /v1/music |
मूल ऑडियो बाइट्स | music |
| POST | /v1/music/stream |
स्ट्रीमिंग ऑडियो बाइट्स | music |
| POST | /v1/music/detailed |
मूल मल्टीपार्ट ऑडियो और कंपोज़िशन प्लान | music |
| POST | /v1/music/detailed/stream |
मूल SSE मेटाडेटा और ऑडियो चंक्स | music |
| POST | /v1/music/plan |
JSON कंपोज़िशन प्लान | music |
ये एंडपॉइंट मौजूदा /v1/audio/speech, /v1/audio/transcriptions,
/v1/voices, /v1/text-to-speech/{voiceId} और /v1/speech-to-text रूट का पूरक हैं। मूल JSON फ़ील्ड
और output_format तथा enable_logging जैसे क्वेरी पैरामीटर सुरक्षित रखे जाते हैं।
/v1/music/detailed प्रतिक्रियाएँ अपने मल्टीपार्ट बाउंड्री को बनाए रखती हैं; उन्हें मल्टीपार्ट के रूप में पार्स करें।
/v1/music/detailed/stream कंपोज़िशन मेटाडेटा और SSE इवेंट में base64 ऑडियो चंक्स के साथ
text/event-stream लौटाता है। सभी छह रूट CORS प्रीफ़्लाइट का समर्थन करते हैं।
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
इंक्रीमेंटल ऑडियो डिलीवरी के लिए उसी JSON बॉडी के साथ /v1/music/stream का उपयोग करें। कंपोज़िशन
में prompt या composition_plan में से ठीक एक स्वीकार किया जाता है; /v1/music/plan के लिए prompt
आवश्यक है और इसमें वैकल्पिक रूप से source_composition_plan स्वीकार किया जाता है। मूल
स्कीमा अतिरिक्त प्रदाता फ़ील्ड को सुरक्षित रखती हैं, ताकि कंपोज़िशन-प्लान संस्करण और फ़ाइन-ट्यूनिंग विकल्प ElevenLabs तक पहुँच सकें।
यूनिफ़ाइड /v1/music/generations एंडपॉइंट elevenlabs/music_v1,
elevenlabs/music_v2 और elevenlabs/music_v2_5 को भी स्वीकार करता है। सक्रिय ElevenLabs कनेक्शन के साथ,
ये मॉडल संगीत कैटलॉग में उपलब्ध कराए जाते हैं। यह एंडपॉइंट
{"created":...,"data":[{"b64_json":"...","format":"mp3"}]} लौटाता है। इसका duration फ़ील्ड
सेकंड में होता है और music_length_ms पर मैप होता है; स्पष्ट रूप से दिया गया music_length_ms प्राथमिकता रखता है।
instrumental को force_instrumental पर मैप किया जाता है, जबकि मूल फ़ील्ड प्राथमिकता रखती है।
स्ट्रीमिंग के लिए मूल स्ट्रीमिंग एंडपॉइंट और केवल कंपोज़िशन प्लान द्वारा संचालित अनुरोधों के लिए
मूल कंपोज़िशन एंडपॉइंट का उपयोग करें।
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}'
अपस्ट्रीम कॉल से पहले एंडपॉइंट, मॉडल, बजट और कनेक्शन प्रतिबंध लागू किए जाते हैं। मूल
रूट अपस्ट्रीम स्थिति कोड और त्रुटि बॉडी को अपरिवर्तित लौटाते हैं, जिसमें प्लान प्रतिबंध के लिए
402 और कोटा सीमा के लिए 429 शामिल हैं। character-cost, song-id, request-id और retry-after
हेडर मौजूद होने पर सुरक्षित रखे जाते हैं। मुफ़्त क्रेडिट बैलेंस हर संगीत मॉडल, आउटपुट फ़ॉर्मैट या API सुविधा तक
पहुँच की गारंटी नहीं देता: ElevenLabs प्रत्येक अनुरोध के लिए पात्रता निर्धारित करता है।
यूनिफ़ाइड एंडपॉइंट OmniRoute के सामान्यीकृत त्रुटि एनवेलप में त्रुटि स्थिति कोड सुरक्षित रखता है।
अपस्ट्रीम कॉन्ट्रैक्ट: ध्वनि प्रभाव, संगीत कंपोज़िशन और स्ट्रीमिंग संगीत विवरण।
संगतता एंडपॉइंट
| 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 (edit/inpaint) |
| POST | /v1/videos/generations |
OpenAI-style video generation |
| POST | /v1/music/generations |
OpenAI-style music generation |
| POST | /v1/audio/transcriptions |
OpenAI Audio (STT) |
| POST | /v1/audio/speech |
OpenAI TTS (returns audio body) |
| POST | /v1/rerank |
Cohere/Voyage-style rerank |
| POST | /v1/classify |
Jina classify (api.jina.ai) |
| POST | /v1/segment |
Jina segmenter (segment.jina.ai) |
| POST | /v1/moderations |
OpenAI Moderations |
| GET | /v1/models |
OpenAI |
| POST | /v1/models/query |
Filtered model shortlist |
| 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 catalog alias |
| GET | /api/v1/vscode/{token}/models |
OpenAI models alias |
| POST | /api/v1/vscode/{token}/chat/completions |
OpenAI tokenized alias |
| POST | /api/v1/vscode/{token}/responses |
OpenAI Responses tokenized alias |
| POST | /api/v1/vscode/{token}/api/chat |
Ollama tokenized alias |
| GET | /api/v1/vscode/{token}/api/tags |
Ollama tags tokenized alias |
सभी POST रूट एक ही संरचना का पालन करते हैं: Bearer your-api-key + Zod-validated JSON body (v1RerankSchema, v1ModerationSchema, v1AudioSpeechSchema, आदि, src/shared/validation/schemas.ts देखें)। स्कीमा विफल होने पर 4xx लौटाया जाता है।
जिन क्लाइंट्स में Authorization: Bearer ... संलग्न नहीं किया जा सकता, उनके लिए OmniRoute URL में API कुंजियाँ स्वीकार करता है। इसके लिए या तो क्वेरी-स्ट्रिंग संगतता (?token=..., ?apiKey=..., ?api_key=..., ?key=...) या नीचे दस्तावेज़ीकृत समर्पित /api/v1/vscode/{token}/... एंडपॉइंट का उपयोग किया जा सकता है।
# री-रैंक (क्लाउड रजिस्ट्री प्रदाता, या "<prefix>/<model>" के रूप में OpenAI-संगत प्रदाता नोड)
POST /v1/rerank { "model": "jina-ai/jina-reranker-v3.5", "query": "...", "documents": ["..."] }
# Jina वर्गीकरण (Foundation API क्रेडेंशियल)
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; प्रदाता एलियास: 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" है; अनुपस्थित
# वॉइस या OpenAI की स्टॉक वॉइस का नाम (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
# वीडियो / संगीत जनरेशन (प्रदाता-प्रिफ़िक्स वाला मॉडल आईडी)
POST /v1/videos/generations { "model": "runway/gen-3", "prompt": "..." }
POST /v1/music/generations { "model": "kie/suno-v4.0", "prompt": "..." }
Rerank प्रदाता नोड:
POST /v1/rerankअब OpenAI-संगत प्रदाता नोड्स (oMLX, vLLM, Infinity, गेटवे के पीछे TEI, …) पर भी रूट करता है, जिन्हें<node-prefix>/<model>के रूप में संबोधित किया जाता है। लूपबैक नोड्स (localhost,127.0.0.1,172.16.0.0/12) हमेशा पात्र होते हैं, और वे होस्टनेम भी पात्र होते हैं जिन्हें ऑपरेटरOMNIROUTE_LOCAL_PROVIDER_NODE_HOSTSमें सूचीबद्ध करता है (उदाहरण के लिए,http://reranker:8080/v1जैसा Docker/Compose सेवा नाम; इन्हें सीधे कॉल किया जाता है, कभी भीHTTP(S)_PROXYया कनेक्शन के पिन किए गए प्रॉक्सी के माध्यम से नहीं)। किसी अन्य होस्ट — LAN मशीन या Tailscale पीयर — पर मौजूद नोड्स तभी पात्र होते हैं जब ऑपरेटरRERANK_REMOTE_PROVIDER_NODESफीचर फ़्लैग सक्षम करता है और नोड का बेस URL प्रदाता आउटबाउंड URL नीति (OMNIROUTE_ALLOW_LOCAL_PROVIDER_URLS/OMNIROUTE_ALLOW_PRIVATE_PROVIDER_URLS) को पास करता है। मेमोरी इंजन का rerank चरण इस रूट को लूपबैक के माध्यम से कॉल करता है, इसलिए यही नियम Memory सेटिंग्स में मौजूदrerankProviderModelपर भी लागू होता है।स्थानीय सर्वर संरचनाएँ: नोड को
<base>/v1/rerankपर और 404 मिलने पर<base>/rerank(Infinity, TEI) पर कॉल किया जाता है। अपस्ट्रीम बॉडी में Cohere/OpenAI स्पेलिंग (documents,return_documents) और TEI स्पेलिंग (texts,return_text) दोनों शामिल होती हैं, और अपस्ट्रीम प्रतिक्रिया को Cohere एन्वेलप में सामान्यीकृत किया जाता है: TEI का बिना रैपर वाला[{index, score, text}], पतले गेटवे से प्राप्त{results: [{index, score}]}और Voyage-शैली का{data: [...]}— ये सभी क्लाइंट के पास{results: [{index, relevance_score, document?}]}के रूप में वापस आते हैं, स्कोर के अनुसार क्रमबद्ध औरtop_nतक सीमित।
प्रदाता-नोड खोज: OpenAI-संगत प्रदाता नोड पर मौजूद मॉडल
GET /v1/modelsमें नोड प्रीफ़िक्स के अंतर्गत दिखाई देते हैं। जिन पंक्तियों में कोई एंडपॉइंट मेटाडेटा नहीं होता (स्थानीय/v1/modelsलिस्टिंग के लिए सामान्य), वे नोड केapiTypeको इनहेरिट करती हैं, इसलिए एकembeddingsनोड के मॉडलtype: "embedding"और एकrerankनोड के मॉडलtype: "rerank"होते हैं, न कि डिफ़ॉल्ट रूप से chat; सिंक की गई या मैन्युअल रूप से जोड़ी गई पंक्ति में मौजूद स्पष्टsupportedEndpointsको फिर भी प्राथमिकता मिलती है।
समर्पित प्रदाता रूट
POST /v1/providers/{provider}/chat/completions
POST /v1/providers/{provider}/embeddings
POST /v1/providers/{provider}/images/generations
यदि प्रदाता प्रीफ़िक्स मौजूद न हो, तो उसे स्वतः जोड़ा जाता है। मेल न खाने वाले मॉडल 400 लौटाते हैं।
फ़ाइल API
बैच इनपुट/आउटपुट और फ़ाइल-उद्देश्य अपलोड के लिए OpenAI-संगत फ़ाइल एंडपॉइंट।
| विधि | पथ | विवरण |
|---|---|---|
| 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 |
कच्चे फ़ाइल बॉडी को स्ट्रीम करें |
प्रमाणीकरण: Bearer API कुंजी — getApiKeyRequestScope के माध्यम से फ़ाइलें प्रति-API-कुंजी के दायरे में होती हैं। कोई कुंजी
केवल अपनी फ़ाइलों को देख, डाउनलोड और हटा सकती है; बिना कुंजी वाला डैशबोर्ड सत्र
पूरे इंस्टेंस को पढ़ सकता है; बिना स्वामी वाली फ़ाइल (अनाम या डैशबोर्ड-सत्र अपलोड) को प्रत्येक
गैर-सत्र कॉलर के लिए अस्वीकृत किया जाता है। GET /v1/files किसी अनाम कॉलर — और ऐसी प्रस्तुत कुंजी, जिसका
समाधान न हो — को 401 से अस्वीकार करता है, भले ही REQUIRE_API_KEY=false हो, बजाय इसके कि प्रत्येक टेनेंट की
फ़ाइलों की सूची दी जाए (GHSA-m3hp-hq9g-fpmv, GHSA-2jm2-mpx8-6523)।
बैच API
OpenAI-संगत बैच प्रोसेसिंग।
| विधि | पथ | विवरण |
|---|---|---|
| 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 |
प्रगति में चल रहे बैच को रद्द करें |
प्रमाणीकरण: Bearer API कुंजी। बैचों का दायरा फ़ाइलों के समान उसी तीन-पक्षीय नियम के तहत प्रति-API-कुंजी निर्धारित होता है:
केवल अपनी कुंजी, डैशबोर्ड सत्र के लिए पूरे इंस्टेंस तक पहुँच, और बिना स्वामी वाले रिकॉर्ड प्रत्येक
गैर-सत्र कॉलर के लिए अस्वीकृत (प्राप्ति, हटाना, रद्द करना और निर्माण के दौरान input_file_id जाँच)।
GET /v1/batches किसी अनाम कॉलर को 401 से अस्वीकार करता है, भले ही REQUIRE_API_KEY=false हो।
API खोजें
Web/search प्रदाता अमूर्त (टैविली, ब्रेव, एक्सा, सर्पर, आदि)।
| तरीका | पथ | विवरण |
|---|---|---|
| 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, 403 या 404 का उत्तर देता है। एक baseUrl जो वैध http(s) URL नहीं है या जो क्लाउड-मेटाडेटा पते पर इंगित करता है गिनती नहीं. एक SearXNG कनेक्शन जो टोकन को संग्रहीत करता है वह इस प्रकार केवल https:// या लूपबैक http:// पर रैंक करता है। रिमोट प्लेन http:// पर यह कभी भी फेलओवर नहीं होता है और अंतिम उपाय रहता है, इसका उपयोग केवल तब किया जाता है जब कोई अन्य प्रदाता कॉन्फ़िगर नहीं किया जाता है या जब नाम से अनुरोध किया जाता है, इसलिए यह उन दो मामलों में क्लीयरटेक्स्ट में टोकन भेजता है।
एक्सा और टैविली 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 स्कीमा के विरुद्ध जांचा जाता है, और गलत प्रकार वाली एक कुंजी हटा दी जाती है। ऑथ, बेस URL, stream और outputSchema सहित किसी भी अन्य कुंजी को नजरअंदाज कर दिया जाता है। अन्य प्रदाताओं द्वारा उपयोग की जाने वाली फ़्लैट कुंजियाँ (cx, depth, ...) पहले की तरह काम करती हैं।
| प्रदाता | शीर्ष-स्तरीय फ़ील्ड | नेस्टेड |
|---|---|---|
| उदाहरण | 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" रखता है। टैविली 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 में एक स्पष्ट तारीख मैप की गई तारीख को ओवरराइड करती है।
परीक्षा परिणाम id, highlights (प्रत्येक हाइलाइट, न केवल snippet के रूप में उपयोग किया जाने वाला पहला), highlight_scores, summary, subpages, entities और extras provider_raw में रखते हैं। Tavily परिणाम images और favicon रखते हैं।
लिंकअप खोज लागत depth fast और standard के लिए $0.005 और deep के लिए $0.05 ( लिंकअप मूल्य निर्धारण ) दर्ज की गई है, चाहे depth provider_options से आता हो या कनेक्शन की सेटिंग्स से।
Exa type: "lite" (Exa 3.0) फ़ील्ड के एक छोटे सेट को स्वीकार करता है और कोई अन्य फ़ील्ड सेट होने पर पूरे अनुरोध को अस्वीकार कर देता है। लाइट के लिए, additionalQueries, systemPrompt और text और highlights को छोड़कर प्रत्येक contents कुंजी को कॉल से पहले हटा दिया जाता है। बहिष्कृत subpages, subpageTarget, highlights.numSentences और highlights.highlightsPerUrl अब अग्रेषित नहीं किए जाते हैं।
एक्सा को छोड़कर, लागत लेखांकन फ्लैट रजिस्ट्री costPerQuery है, जो एक्सा के स्वयं के मूल्य निर्धारण का पालन करता है: auto के लिए 0.007 प्रति कॉल (और विरासत `fast`) या `lite` (और विरासत `instant`) के लिए 0.004, 10 परिणामों को कवर करता है; प्रत्येक अगले परिणाम के लिए $0.001; और contents.summary सेट होने पर लौटाए गए परिणाम के लिए $0.001। Tavily को search_depth basic, fast और ultra-fast के लिए 1 क्रेडिट ($0.008) और advanced ( Tavily API क्रेडिट ) के लिए 2 क्रेडिट ($0.016) पर दर्ज किया गया है। auto_parameters: true के साथ एक कॉल जिसे टैविली ने उन्नत में अपग्रेड किया है, अभी भी 1 क्रेडिट पर रिकॉर्ड किया जाता है।
Web Fetch API
कॉन्फ़िगर किए गए वेब-फ़ेच प्रदाता (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 के रूप में प्रस्तुत करता है।
| Method | Path | Description |
|---|---|---|
| POST | /v1/web/fetch |
URL फ़ेच/स्क्रैप करें — body का सत्यापन v1WebFetchSchema द्वारा किया जाता है |
Auth: Bearer API key (extractApiKey + isValidApiKey)। नीति enforceApiKeyPolicy के माध्यम से लागू की जाती है।
कोटा-जागरूक फ़ॉलबैक (#8297): जब कोई स्पष्ट provider नहीं दिया जाता है, तो pool
(firecrawl → jina-reader → tavily-search → tinyfish → nimble-search →
parallel-search) को निश्चित
प्राथमिकता क्रम (fill-first) में
चलाया जाता है — rate-limited लेकिन कॉन्फ़िगर किए गए provider को अनुरोध को शॉर्ट-सर्किट करने के
बजाय छोड़ दिया जाता है, और पुनः प्रयास योग्य/कोटा upstream विफलता (HTTP 429 हमेशा; Firecrawl/Tavily/TinyFish के
कोटा-शैली वाले free tiers के लिए 402/403 —
Jina Reader के लिए नहीं, और साधारण 400 bad request के लिए कभी नहीं) अनुरोध के समय अगले
ऐसे credential वाले provider तक पहुँचती है जिसे अभी तक आज़माया नहीं गया है। जब pool में प्रत्येक provider
समाप्त हो जाता है, तो endpoint पिछले सामान्य 400 के बजाय एकल 429 (Retry-After
header के साथ) लौटाता है। जब स्पष्ट provider का अनुरोध किया जाता है, तो कोई
मौन फ़ॉलबैक नहीं होता — rate-limited या विफल स्पष्ट provider अपनी त्रुटि (429 यदि rate-limited हो, अन्यथा 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); connection को 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 पर paths /v1/responses,
/responses, और /api/v1/responses पर सुनता है। पहले response.create frame पर यह
आंतरिक codex-responses-ws bridge के माध्यम से प्रमाणीकरण और तैयारी करता है, codex OAuth connection चुनता है, और
wreq-js transport के माध्यम से wss://chatgpt.com/backend-api/codex/responses तक tunnel करता है। Non-codex models अस्वीकार कर दिए जाते हैं (codex_ws_provider_required)।
कोटा-साझाकरण 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 client-side पर model name का सत्यापन करता है जब
supports_websockets = true हो और 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 के लिए है, इसलिए upstream तक tunneling करने से पहले यह bare id को codex model के रूप में
फिर से resolve करता है
(resolveCodexWsModelInfo) — भले ही HTTP के माध्यम से bare
gpt-5.5 अन्य provider पर route होता।
OpenAI Codex CLI को कॉन्फ़िगर करना
~/.codex/config.toml में WebSocket
support वाला custom provider जोड़कर Codex CLI को OmniRoute पर point करें (मौजूदा 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" # trailing slash नहीं; WS URL इससे derived होता है (production में https/wss का उपयोग करें)
wire_api = "responses" # Feb 2026 से केवल समर्थित value
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 + token आवश्यक) |
प्रमाणीकरण: Bearer API कुंजी (isAuthenticated)।
कोटा सत्र पुनर्प्राप्ति (वैकल्पिक)
एक नॉन-स्ट्रीमिंग POST /v1/chat/completions या POST /v1/responses अनुरोध, जो
टर्मिनल कोटा त्रुटि (402/429/503, जिसके बॉडी में कोटा या क्रेडिट समाप्त होने की सूचना हो)
के साथ विफल होता है, उसे त्रुटि लौटाने के बजाय बाद में दोबारा चलाने के लिए रोका जा सकता है। कॉलर
प्रति अनुरोध तीन हेडर के साथ इसे सक्षम करता है:
| हेडर | मान |
|---|---|
x-omniroute-quota-recovery |
auto |
x-omniroute-session |
सत्र आईडी, [A-Za-z0-9._:-]{1,128} |
x-omniroute-recovery-turn |
सत्र के भीतर अद्वितीय टर्न आईडी (समान नियम) |
केवल stream: false वाले टर्न, जिनमें कोई टूल, टूल इतिहास या previous_response_id न हो और
कोई x-omniroute-connection पिन न हो, पात्र हैं। साथ ही, STORAGE_ENCRYPTION_KEY सेट होना
आवश्यक है (अनुरोध को अधिकतम 24 घंटे तक एन्क्रिप्टेड रूप में संग्रहीत किया जाता है)। इसके बाद
प्रतिक्रिया 202 और recovery.poll के साथ आती है; पोल करने के लिए
GET /v1/quota-recoveries/{id} का उपयोग करें (लंबित स्थिति में 202, पूरा होने पर
पुनर्प्राप्त बॉडी के साथ 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** सक्षम (डिफ़ॉल्ट रूप से बंद — डैशबोर्ड का एपीआई-कुंजी प्रबंधक इसे प्रति कुंजी टॉगल करता है)। इसके बिना समापन बिंदु 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 फॉर्म ही उन्हें अलग करता है।
प्रामाणिक: कॉल करने वाले की अपनी बियरर API कुंजी, isValidApiKey — के साथ मान्य है, यह प्रबंधन सतह (/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 |
| माप | कटऑफ-समायोजित प्रयोग योग्य भत्ता : शेष क्षमता कटऑफ सीमा से ऊपर | कच्चा अपस्ट्रीम कोटा : असमायोजित प्रदाता माप |
| कटऑफ़ स्केलिंग | effectiveRemainingPercent() के माध्यम से स्केल किया गया ताकि संरक्षित रिज़र्व 0% left के रूप में पढ़ा जाए |
कोई नहीं (प्रदाता द्वारा रिपोर्ट किए गए कच्चे स्नैपशॉट मान) |
| सीमा डेटा | प्रदर्शित प्रतिशत में शामिल किया गया | प्रति कनेक्शन quotaWindowThresholds में संग्रहीत (या सर्वर डिफ़ॉल्ट) |
| प्राथमिक ग्राहक | इंटरैक्टिव CLIs, टर्मिनल संकेत, मानव ऑपरेटर | प्रोग्रामेटिक इंटीग्रेशन, डैशबोर्ड, एनालिटिक्स, बिलिंग ट्रैकर्स |
कटऑफ समायोजन फॉर्मूला
OmniRoute अपस्ट्रीम थकावट को रोकने के लिए सक्रिय कोटा कटऑफ का समर्थन करता है (कनेक्शन quotaWindowThresholds, प्रदाता डिफ़ॉल्ट, या वैश्विक लचीलापन सेटिंग्स के माध्यम से कॉन्फ़िगर किया गया)। जब कोटा विंडो पर कटऑफ थ्रेशोल्ड (उदाहरण के लिए, cutoff = 25%) सक्रिय होता है, तो टेक्स्ट रेंडरर शेष भत्ते की गणना इस प्रकार करता है:
- यदि
remaining <= cutoff:0%लौटाता है। - यदि
remaining > cutoff:((remaining - cutoff) / (100 - cutoff)) * 100लौटाता है।
स्वरूपित पाठ आउटपुट इसे निकटतम पूर्णांक (Math.round(...)) तक पूर्णांकित करता है।
उदाहरणात्मक उदाहरण
एक प्रदाता विंडो पर विचार करें** 60% कच्चा उपयोग** (इस तरह** 40% कच्चा शेष कोटा** ) और एक कॉन्फ़िगर किया गया** 25% शेष-कोटा कटऑफ** सीमा:
| प्रतिनिधित्व | गणना | शेष | निहित प्रयुक्त |
|---|---|---|---|
कच्चा JSON (?format=json) |
अपस्ट्रीम स्नैपशॉट (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 पर माइग्रेट करने का अर्थ है:
- कच्चे 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 प्रतिक्रिया को अपस्ट्रीम कॉल के बिना कैश से प्रदान करता है, इसलिए रिपोर्ट की गई X-OmniRoute-Response-Latency लगभग शून्य होती है (मूल अपस्ट्रीम लेटेंसी की परवाह किए बिना)। लेटेंसी-संवेदी क्लाइंट (बेंचमार्किंग, p50/p99 मॉनिटरिंग) को X-OmniRoute-Cache-Latency प्रतिक्रिया हेडर की जाँच करनी चाहिए:
| Value | Meaning |
|---|---|
synthetic |
प्रतिक्रिया कैश से प्रदान की गई; लेटेंसी वास्तविक अपस्ट्रीम समय नहीं है |
| (absent) | वास्तविक अपस्ट्रीम कॉल से प्राप्त प्रतिक्रिया |
प्रति-कुंजी कैश बायपास
API कुंजियाँ cacheDefaultMode के माध्यम से सेमांटिक कैश रीड से बाहर निकल सकती हैं:
| Value | Behavior |
|---|---|
legacy |
सामान्य कैश व्यवहार (डिफ़ॉल्ट) |
bypass |
कैश लुकअप पूरी तरह छोड़ें; हमेशा अपस्ट्रीम को कॉल करें |
कुंजी निर्माण (POST /api/keys) या अपडेट (PATCH /api/keys/[id]) के समय सेट करें:
{ "cacheDefaultMode": "bypass" }
प्रति-अनुरोध बायपास
कुंजी सेटिंग्स की परवाह किए बिना कोई भी अनुरोध कैश को बायपास कर सकता है:
X-OmniRoute-No-Cache: true
CLIProxyAPI प्रबंधन संगतता
OmniRoute उन तीन CLIProxyAPI प्रबंधन एंडपॉइंट का उत्तर देता है, जिन्हें उपयोग डैशबोर्ड Claude और Codex सदस्यता सीमाएँ पढ़ने के लिए कॉल करते हैं (उदाहरण के लिए, T3 Code का cliproxy उपयोग-सीमा स्रोत)। क्लाइंट का बेस URL OmniRoute पर सेट करें और manage स्कोप वाली API कुंजी को उसकी प्रबंधन कुंजी के रूप में उपयोग करें। रूट /v0/management/* और /api/v0/management/* पर उपलब्ध हैं।
| Method | Path | Description |
|---|---|---|
| GET | /v0/management/auth-files |
Claude और Codex OAuth कनेक्शन { files: [{ id, auth_index, provider, email, disabled, id_token }] } के रूप में। कोई टोकन नहीं |
| POST | /v0/management/api-call |
बॉडी { auth_index, method, url, header?, data? }। खाते के टोकन के साथ एक allowlisted अनुरोध भेजता है और { status_code, body } लौटाता है |
| POST | /v0/management/reset-quota |
बॉडी { auth_index }। एक खाते के कनेक्शन कूलडाउन, मॉडल लॉकआउट और Codex प्रति-स्कोप कूलडाउन साफ़ करता है |
auth_indexOmniRoute कनेक्शन आईडी है।providerclaudeयाcodexहै (केवल OAuth कनेक्शन;anthropicAPI-कुंजी प्रदाता सूचीबद्ध नहीं है)। Codex के लिए,id_token.chatgpt_account_idसंग्रहीत वर्कस्पेस आईडी है औरplan_typeसंग्रहीत प्लान है।api-callएक सामान्य प्रॉक्सी नहीं है। यह केवल 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स्वीकार करता है, और प्रत्येक अनुरोध केवल संबंधित प्रदाता के खाते के लिए स्वीकार किया जाता है। अन्य सभी अनुरोध अपस्ट्रीम से संपर्क किए बिना403लौटाते हैं। कॉलर केAuthorizationहेडर ($TOKEN$प्लेसहोल्डर सहित) को अनदेखा किया जाता है: OmniRoute कनेक्शन का एक्सेस टोकन इंजेक्ट करता है, उसकी समय-सीमा निकट होने पर पहले उसे रीफ़्रेश करता है, और केवल allowlisted हेडर (anthropic-beta;OpenAI-Beta,Originator,Chatgpt-Account-Id;Accept,Content-Type) अग्रेषित करता है। अनुपस्थितChatgpt-Account-Idका डिफ़ॉल्ट संग्रहीत वर्कस्पेस आईडी होता है। अनुरोध 15 सेकंड के बाद टाइम आउट हो जाते हैं और कनेक्शन के प्रॉक्सी का उपयोग करते हैं।reset-quotaटर्मिनल अवस्थाओं (banned, expired, credits_exhausted) को यथावत छोड़ता है। अज्ञातauth_index404लौटाता है।
प्रमाणीकरण: डैशबोर्ड सत्र या manage-स्कोप वाली API कुंजी आवश्यक है, लॉगिन अक्षम होने पर भी
(पथ ALWAYS_PROTECTED_API_PATHS में हैं)। केवल inference वाली कुंजियों को 403 मिलता है। स्रोत:
src/lib/cliproxyCompat/managementApi.ts.
डैशबोर्ड एवं प्रबंधन
प्रबंधन मार्ग (सार्वजनिक auth/login को छोड़कर /api/* ) हैं** नहीं** साधारण अनुमान API कुंजियों द्वारा अधिकृत। क्रेडेंशियल परिवार, स्कोप और कर्ल उदाहरण: प्रबंधन प्रमाणीकरण ।
प्रमाणीकरण
| endpoint | तरीका | विवरण |
|---|---|---|
/api/auth/login |
POST | लॉग इन करें |
/api/auth/logout |
POST | लॉग आउट |
/api/settings/require-login |
GET/POST | लॉगिन स्थिति (GET, सार्वजनिक)। POST पासवर्ड सेट करता है / लॉगिन टॉगल करता है: ऑपरेटर-केवल एक बार पासवर्ड मौजूद होने पर (डैशबोर्ड सत्र, स्थानीय CLI, या लॉगिन अक्षम — API कुंजी और oma_ टोकन 403 प्राप्त करते हैं); एक डैशबोर्ड सत्र पासवर्ड बदलने के लिए currentPassword भेजता है |
प्रदाता प्रबंधन
| endpoint | तरीका | विवरण |
|---|---|---|
/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) मॉडल आईडी को नंगे अपस्ट्रीम आईडी के रूप में संग्रहीत करते हैं: एक उपसर्ग सूची से चिपकाई गई आईडी में नोड के स्वयं के उपसर्ग का कोई भी अग्रणी स्टैक ध्वस्त हो जाता है, और प्रतिक्रियाएं संग्रहीत आईडी को प्रतिध्वनित करती हैं। कैनोनिकल प्रदाताओं की कटी हुई आईडी (जैसे nvidia/nemotron-…) शब्दशः संग्रहीत की जाती हैं। /v1/models कभी भी स्टैक्ड <prefix>/<prefix>/<model> आईडी उत्सर्जित नहीं करता है।
कस्टम चैट समापन नोड्स स्पष्ट तर्क ऑप्ट-आउट को अपस्ट्रीम बैकएंड में अनुकूलित करते हैं। एक सफल कनेक्शन परीक्षण स्वचालित रूप से प्रत्येक सटीक मॉडल ID के लिए चैट-टेम्पलेट नियंत्रण का चयन करता है जिसकी /models प्रविष्टि एक मान्यता प्राप्त owned_by मान साबित करती है: vllm, sglang, या llamacpp। पारदर्शी ओपनएआई-संगत रैपर नेस्टेड openai ऑब्जेक्ट के अंदर मूल मॉडल प्रविष्टि को संरक्षित कर सकते हैं; ऐसे तीन लिफाफों का पता लगाया जाता है। गुम, अज्ञात या परस्पर विरोधी स्वामित्व वाले मॉडल सामान्य OpenAI व्यवहार रखते हैं। डिटेक्शन मौजूदा कैटलॉग अनुरोध का पुन: उपयोग करता है, कोई पूर्णता टोकन उत्पन्न नहीं करता है, और कनेक्शन समापन बिंदु बदलने पर अमान्य हो जाता है।
उस बैकएंड के व्यवहार को पिन करने के लिए जो उस मेटाडेटा को उजागर नहीं करता है, मौजूदा आंशिक प्रदाता अद्यतन API उपयोग करें:
{
"providerSpecificData": {
"reasoningControl": "chat-template"
}
}
उस शरीर को PUT /api/providers/<connection-id> के साथ भेजें। उस कनेक्शन पर, none का एक स्पष्ट तर्क प्रयास chat_template_kwargs.thinking=false और chat_template_kwargs.enable_thinking=false के रूप में भेजा जाता है। जब तक सर्वर-साइड रीज़निंग नियम प्रयास को बाध्य नहीं करता तब तक स्पष्ट मूल टेम्पलेट मान आधिकारिक बने रहते हैं। सेटिंग केवल तभी लागू होती है जब एक कस्टम ओपनएआई-संगत कनेक्शन एक चैट समापन निकाय भेजता है; प्रतिक्रिया अनुरोध और सामान्य प्रदाता अपना मूल अनुरोध आकार बनाए रखते हैं। सामान्य OpenAI reasoning_effort पासथ्रू को बाध्य करने के लिए reasoningControl को openai पर सेट करें, या स्वचालित पहचान का उपयोग करने के लिए it/set को null पर छोड़ दें।
Claude कोड ऑटो-मोड क्लासिफायर डिफ़ॉल्ट मूल सोच को अक्षम करने का अनुरोध करता है जब उनमें कोई स्पष्ट तर्क नियंत्रण नहीं होता है। डिटेक्शन क्लाउड-प्रारूप अनुरोधों में क्लासिफायरियर के सिस्टम मार्कर का उपयोग करता है, न कि मॉडल नाम या पूर्णता सीमा का। स्पष्ट बॉडी नियंत्रण, समर्थित effort/thinking हेडर, रूटिंग नियम और हल किए गए मॉडल प्रयास उनकी मौजूदा प्राथमिकता रखते हैं। दोनों क्लासिफायर चरण अपने संकेत, पूर्णता सीमा, स्टॉप अनुक्रम और वास्तविक अपस्ट्रीम अनुमति फैसले बरकरार रखते हैं; दूसरा चरण अभी भी अपने अनुरोधित दृश्यमान तर्क को सामान्य पाठ के रूप में प्रस्तुत कर सकता है।
OAuth प्रवाह
| endpoint | तरीका | विवरण |
|---|---|---|
/api/oauth/[provider]/[action] |
विभिन्न | प्रदाता-विशिष्ट OAuth |
रूटिंग और कॉन्फ़िग
| endpoint | तरीका | विवरण |
|---|---|---|
/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 में पूर्वता श्रृंखला।
उपयोग एवं विश्लेषिकी
| endpoint | तरीका | विवरण |
|---|---|---|
/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 |
restricted होने पर allowedConnections गैर-रिक्त होना चाहिए और all होने पर खाली होना चाहिए |
allowedConnections |
UUIDs की सरणी, 100 तक | |
allowAutoCombos |
बूलियन | false इस कुंजी के साथ auto/* मॉडल के अनुरोधों को अस्वीकार करता है; जो कुंजियाँ इसे कभी सेट नहीं करतीं उन्हें अनुमति दी जाती है |
catalogScope |
all | combos | models |
इस कुंजी के लिए GET /v1/models क्या सूचीबद्ध करता है (केवल कॉम्बो, केवल मॉडल, या दोनों); यह नहीं बदलता कि कुंजी क्या कह सकती है |
forcedModel |
300 वर्ण या null तक स्ट्रिंग |
चैट अनुरोधों को इस model/combo पर, X-Route-Model और body.model पर रूट करता है; कुंजी की सीमाएँ अभी भी लागू होती हैं |
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 |
5-घंटे का USD बजट रोलिंग, दैनिक और साप्ताहिक सीमाओं (usageLimitEnabled, UNPRICED_USAGE_BUDGET_POLICY) की तरह लागू किया गया। 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" }'
सेटिंग्स
| endpoint | तरीका | विवरण |
|---|---|---|
/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** अनुरोध** पुनर्लेखन मोड (पासथ्रू/ऑटो-स्ट्रिप/कस्टम/अनुकूली)। संपीड़न से स्वतंत्र. THINKING_BUDGET.md देखें। |
/api/settings/system-prompt |
GET/PUT | वैश्विक प्रणाली संकेत |
/api/settings/compression |
GET/PUT | वैश्विक संपीड़न कॉन्फ़िग |
/api/settings/purge-request-history |
POST | अनुरोध लॉग पंक्तियाँ और स्थानीय कॉल-लॉग कलाकृतियाँ साफ़ करें |
प्रसंग एवं संपीड़न
| endpoint | तरीका | विवरण |
|---|---|---|
/api/compression/preview |
POST | off/lite/standard/aggressive/ultra/RTK/stacked संपीड़न का पूर्वावलोकन करें |
/api/compression/language-packs |
GET | उपलब्ध केवमैन भाषा पैक की सूची बनाएं |
/api/compression/rules |
GET | केवमैन नियम मेटाडेटा की सूची बनाएं |
/api/context/caveman/config |
GET/PUT | केवमैन-विशिष्ट सेटिंग्स उपनाम |
/api/context/rtk/config |
GET/PUT | कस्टम फिल्टर और रॉ-आउटपुट रिटेंशन सहित आरटीके-विशिष्ट सेटिंग्स |
/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 | संपीड़न विश्लेषण उपनाम |
निगरानी
| endpoint | तरीका | विवरण |
|---|---|---|
/api/sessions |
GET | सक्रिय सत्र ट्रैकिंग |
/api/rate-limits |
GET | प्रति खाता दर सीमा |
/api/monitoring/health |
GET | स्वास्थ्य जांच + प्रदाता सारांश (catalogCount, configuredCount, activeCount, monitoredCount)। प्रबंधन दृश्य में credentialHealth शामिल है: जांच-कैश स्केलर, failedConnections जब failed>0, और staleDbNonOkCount (SQLite चिपचिपा test_status, गेज नहीं)। MONITORING_GUIDE.md देखें। |
/api/cache/stats |
GET/DELETE | कैश आँकड़े / साफ़ करें |
/api/modality-bridge/stats |
GET | इन-मेमोरी attempts, सफलताएँ/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 आवश्यकता होती है। यदि कुंजी में एक गैर-रिक्त समापन बिंदु अनुमति सूची है, तो इसमें GET और DELETE दोनों के लिए video शामिल होना चाहिए, चाहे कॉलर /v1 या /api/v1 उपयोग करता हो।
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 बेस64 सहित 32 MiB पर सीमित किया गया है। ओवरसाइज़्ड आउटपुट रिटर्न 413; कम फ़्रेम का अनुरोध करें.
DELETE /api/v1/video-bridge/drilldown?handle=... { "removed": 0|1 } लौटाता है। अज्ञात, समाप्त और क्रॉस-कुंजी GETs अप्रभेद्य हैं 404 प्रतिक्रियाएँ; क्रॉस-कुंजी DELETE स्वामी की प्रविष्टि को नहीं हटा सकता। अक्षम पहुंच रिटर्न 403, missing/invalid प्रमाणीकरण 401, अमान्य क्वेरी 400, रद्दीकरण 499 और अस्थायी त्रुटियां 503। हैंडल प्रक्रिया-स्थानीय हैं, दस मिनट के बाद समाप्त हो जाते हैं, और पुनः आरंभ नहीं होते हैं। नए हैंडल v1. प्लस 32-बाइट यादृच्छिक Base64URL टोकन का उपयोग करते हैं; केवल टोकन हैश बरकरार रखे गए हैं। लीगेसी 64-हेक्स टोकन संगतता के लिए वाक्यात्मक रूप से पठनीय बने रहते हैं। सहमति, कोटा और भिन्न व्युत्पत्ति विवरण के लिए वीडियो ब्रिज रेलिंग देखें।
बैकअप और Export/Import
| endpoint | तरीका | विवरण |
|---|---|---|
/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 (आईडी द्वारा पुनर्स्थापित करें) और POST /api/settings/import-json लाइव डेटाबेस या सेटिंग्स को प्रतिस्थापित करते हैं, इसलिए मशीन क्रेडेंशियल को वहां भी 403 मिलता है; omniroute sync import स्थानीय CLI क्रेडेंशियल भेजता है। तो DELETE /api/db-backups (संग्रहीत बैकअप की छँटाई) और PATCH /api/db-backups (प्रतिधारण सेटिंग्स: कायम मान हर बैकअप के बाद स्वचालित छंटाई को संचालित करते हैं) करें। लिस्टिंग (GET) और मैन्युअल बैकअप (PUT) बनाना सामान्य प्रबंधन प्रमाणीकरण रखता है।
क्लाउड सिंक
| endpoint | तरीका | विवरण |
|---|---|---|
/api/sync/cloud |
विभिन्न | क्लाउड सिंक ऑपरेशन |
/api/sync/initialize |
POST | समन्वयन प्रारंभ करें |
/api/cloud/* |
विभिन्न | बादल प्रबंधन |
सुरंगों
| endpoint | तरीका | विवरण |
|---|---|---|
/api/tunnels/cloudflared |
GET | डैशबोर्ड के लिए Cloudflare क्विक टनल install/runtime स्थिति पढ़ें |
/api/tunnels/cloudflared |
POST | Cloudflare क्विक टनल (action=enable/disable) को सक्षम या अक्षम करें |
/api/tunnels/ngrok |
GET | डैशबोर्ड के लिए ngrok टनल रनटाइम स्थिति पढ़ें |
/api/tunnels/ngrok |
POST | ngrok सुरंग को सक्षम या अक्षम करें (action=enable/disable) |
CLI उपकरण
| endpoint | तरीका | विवरण |
|---|---|---|
/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 एजेंट
| endpoint | तरीका | विवरण |
|---|---|---|
/api/acp/agents |
GET | सभी पता लगाए गए एजेंटों (अंतर्निहित + कस्टम) को स्थिति के साथ सूचीबद्ध करें |
/api/acp/agents |
POST | कस्टम एजेंट जोड़ें या डिटेक्शन कैश रीफ्रेश करें |
/api/acp/agents |
DELETE | id क्वेरी परम द्वारा एक कस्टम एजेंट निकालें |
GET प्रतिक्रिया में agents[] (आईडी, नाम, बाइनरी, संस्करण, स्थापित, प्रोटोकॉल, isCustom) और summary (कुल, स्थापित, notFound, builtIn, कस्टम) शामिल हैं।
लचीलापन और दर सीमाएँ
| endpoint | तरीका | विवरण |
|---|---|---|
/api/resilience |
GET/PATCH | Get/update अनुरोध कतार, कनेक्शन कूलडाउन, प्रदाता ब्रेकर, और प्रतीक्षा सेटिंग्स |
/api/resilience/reset |
POST | प्रदाता सर्किट ब्रेकर रीसेट करें |
/api/resilience/model-cooldowns |
GET | सक्रिय प्रति-(प्रदाता, कनेक्शन, मॉडल) लॉकआउट की सूची, शेष समय के अनुसार क्रमबद्ध करें |
/api/resilience/model-cooldowns |
DELETE | सब कुछ मिटाने के लिए एक मॉडल लॉकआउट — बॉडी {provider, model} या {all: true} साफ़ करें |
/api/rate-limits |
GET/POST | प्रति-खाता दर सीमा स्थिति (GET) या कनेक्शन के लिए दर-सीमा सुरक्षा टॉगल करें (POST {connectionId, enabled})। rateLimitProtection के लिए समर्थित लेखन पथ ( PUT /api/providers/[id] के माध्यम से कभी संशोधित नहीं)। ध्यान दें: enabled: false स्पष्ट सुरक्षा को अक्षम करता है लेकिन वैश्विक ऑटो-सक्षम सुरक्षा जाल (autoEnableApiKeyProviders) से सक्रिय एपीआई-कुंजी कनेक्शन का विकल्प नहीं चुनता है। |
/api/rate-limit |
GET | वैश्विक दर सीमा कॉन्फ़िगरेशन (अप्रत्याशित; उपनाम /api/rate-limits) |
सभी चार
/api/resilience/*मार्गों की आवश्यकता है** प्रबंधन प्राधिकरण** (requireManagementAuth). प्रदाता ब्रेकर बनाम कनेक्शन कूलडाउन बनाम मॉडल लॉकआउट के पूर्ण विश्लेषण के लिए लचीलापन (विस्तारित) देखें।
एवल्स
| endpoint | तरीका | विवरण |
|---|---|---|
/api/evals |
GET/POST | सूची eval सुइट्स / रन मूल्यांकन |
नीतियों
| endpoint | तरीका | विवरण |
|---|---|---|
/api/policies |
GET/POST/DELETE | रूटिंग नीतियां प्रबंधित करें |
अनुपालन
| endpoint | तरीका | विवरण |
|---|---|---|
/api/compliance/audit-log |
GET | अनुपालन ऑडिट लॉग (अंतिम एन) |
v1बीटा (मिथुन-संगत)
| endpoint | तरीका | विवरण |
|---|---|---|
/v1beta/models |
GET | Gemini प्रारूप में मॉडलों की सूची बनाएं |
/v1beta/models/{...path} |
POST | Gemini generateContent समापन बिंदु |
ये समापन बिंदु उन ग्राहकों के लिए Gemini के API प्रारूप को प्रतिबिंबित करते हैं जो मूल Gemini SDK संगतता की अपेक्षा करते हैं।
आंतरिक/सिस्टम APIs
| endpoint | तरीका | विवरण |
|---|---|---|
/api/init |
GET | पृष्ठभूमि सिंक सेवाएँ प्रारंभ करें (प्रबंधन प्राधिकरण) |
/api/tags |
GET | ओलामा-संगत मॉडल टैग ( 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
लूपबैक-केवल प्रबंधन मार्ग (व्यवस्थापक प्राधिकरण)। चालू संस्करण, नवीनतम प्रकाशित संस्करण और ऑटो-अपडेट स्थिति लौटाता है। 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— npm चैनल:-nightly.*संस्करणों के लिएnightly, अन्य प्री-रिलीज़ (-rc.*,-beta.*,-alpha.*) के लिएnext,channels.latestसे पुराने प्रमुख के स्थिर संस्करण के लिएlts, अन्यथाlatest।scripts/release/dist-tag.mjsके समान नियम, जो प्रकाशन समय पर npm डिस्ट-टैग चुनता है। channels—npm view omniroute dist-tags(रजिस्ट्री HTTP फ़ॉलबैक) से प्रत्येक डिस्ट-टैग का हेड प्रकाशित किया,latestके समान 10-मिनट TTL के साथ कैश किया गया।latestहमेशा मौजूद रहता है (वापसlatestफ़ील्ड पर आता है, फिर"unavailable");next,nightlyऔरltsतभी दिखाई देते हैं जब वह डिस्ट-टैग मौजूद होता है। एकCache-Control: no-cacheअनुरोध दोनों लुकअप को ताज़ा करता है।
चैनल मॉडल (4.0 GA तक latest = v3, next = rc, nightly = develop बनाता है, 4.0 GA के बाद lts = v3 पैच) docs/ops/RELEASE_STRATEGY.md में वर्णित है।
ऑडियो ट्रांसक्रिप्शन
POST /v1/audio/transcriptions
Authorization: Bearer your-api-key
Content-Type: multipart/form-data
किसी भी कॉन्फ़िगर किए गए STT प्रदाता का उपयोग करके ऑडियो फ़ाइलों का ट्रांसक्रिप्शन करें। पहला पाथ
सेगमेंट नेटिव प्रदाता चुनता है (openai/…, deepgram/…)। ऐसे गेटवे जो किसी अन्य विक्रेता के मॉडल को
पुनः एक्सपोर्ट करते हैं, एक योग्य आईडी का उपयोग करते हैं
(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
}
उदाहरण मॉडल आईडी: openai/whisper-1 (इसके लिए OpenAI कुंजी आवश्यक है),
openrouter/deepgram/nova-3 (इसके लिए OpenRouter कुंजी आवश्यक है),
deepgram/nova-3 (इसके लिए नेटिव 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 मोनो PCM में परिवर्तित किया जाता है
(PATH पर उपलब्ध होना चाहिए, जब तक कि फ़ाइल पहले से ही 16 kHz मोनो PCM WAV न हो), सेशन में
स्ट्रीम किया जाता है और अंतिम टेक्स्ट { "text": "..." } के रूप में लौटाया जाता है। वैकल्पिक
language और prompt फ़ॉर्म फ़ील्ड अग्रेषित किए जाते हैं। सीमाएँ: 25 MiB से अधिक के अपलोड या
10 मिनट से अधिक लंबे डीकोड किए गए ऑडियो के लिए 413 उत्तर दिया जाता है; 60 सेकंड से अधिक समय तक चलने वाले
कन्वर्ज़न को समाप्त कर दिया जाता है और 504 उत्तर दिया जाता है। API कुंजी केवल
x-goog-api-key हेडर में भेजी जाती है, WebSocket URL में कभी नहीं।
Ollama संगतता
Ollama के API फ़ॉर्मैट का उपयोग करने वाले क्लाइंट के लिए:
# चैट एंडपॉइंट (Ollama फ़ॉर्मैट)
POST /v1/api/chat
# मॉडल सूची (Ollama फ़ॉर्मैट)
GET /api/tags
अनुरोधों का Ollama और आंतरिक फ़ॉर्मैट के बीच स्वचालित रूप से अनुवाद किया जाता है।
Tokenized VS Code / Headerless Aliases
जब कोई इंटीग्रेशन Authorization हेडर जोड़ नहीं सकता और API कुंजी को बेस URL में एम्बेड करने की आवश्यकता होती है, तब इन उपनामों का उपयोग करें।
# OpenAI-शैली कैटलॉग उपनाम
GET /api/v1/vscode/{token}/
GET /api/v1/vscode/{token}/models
# OpenAI-शैली चैट उपनाम
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"}]}'
टिप्पणियाँ:
- टोकनयुक्त उपनाम
/v1/*और/api/tagsके समान हैंडलर का पुनः उपयोग करते हैं; प्रतिक्रिया के आकार एकसमान रहते हैं। - जब भी क्लाइंट कस्टम हेडर का समर्थन करे,
Authorization: Bearer ...को प्राथमिकता दें। - URL-आधारित टोकन रिवर्स-प्रॉक्सी लॉग, ब्राउज़र इतिहास और OmniRoute के बाहर की टेलीमेट्री में दिखाई दे सकते हैं। इन्हें डिफ़ॉल्ट प्रमाणीकरण मोड के बजाय संगतता विकल्प मानें।
टेलीमेट्री
# विलंबता टेलीमेट्री सारांश प्राप्त करें (प्रति प्रदाता 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"
}
स्कीमा नोट्स (
setBudgetSchema):apiKeyIdआवश्यक है;dailyLimitUsd,weeklyLimitUsd, याmonthlyLimitUsdमें से कम-से-कम एक का मान शून्य से अधिक होना चाहिए। वैकल्पिक फ़ील्ड:warningThreshold(0–1),resetInterval(daily|weekly|monthly),resetTime(HH:MM)। विरासत वाला{keyId, limit, period}आकार400 Bad Requestलौटाता है।
टोकन सीमाएँ
प्रत्येक API कुंजी के लिए टोकन बजट (ऊपर दिए गए USD-आधारित बजट से अलग)। अनुरोध पथ पर इनलाइन लागू: जब किसी कुंजी की वर्तमान विंडो का उपयोग इसकी सीमा तक पहुँच जाता है, तो 429 Too Many Requests के साथ अनुरोध अस्वीकार कर दिए जाते हैं। सीमाएँ किसी विशिष्ट model, किसी provider तक सीमित की जा सकती हैं या कुंजी पर global रूप से लागू की जा सकती हैं; जब किसी अनुरोध पर कई सीमाएँ लागू होती हैं, तो सबसे अधिक प्रतिबंधात्मक सीमा प्रभावी होती है।
# कुंजी की टोकन सीमाएँ सूचीबद्ध करें (लाइव विंडो उपयोग शामिल है)
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
}
# आईडी के आधार पर टोकन सीमा हटाएँ
DELETE /api/usage/token-limits?id=tl-abc
स्कीमा नोट्स (
setTokenLimitSchema):apiKeyIdऔरscopeType(model|provider|global) आवश्यक हैं।scopeTypeकेglobalहोने तकscopeValueआवश्यक है (उदाहरण के लिए,modelस्कोप के लिए मॉडल आईडी औरproviderस्कोप के लिए प्रोवाइडर आईडी)।tokenLimitएक धनात्मक पूर्णांक होना चाहिए (स्ट्रिंग से coerced)। वैकल्पिक:id(बनाने के लिए छोड़ दें, अपडेट करने के लिए दें),resetInterval(daily|weekly|monthly, डिफ़ॉल्टmonthly),resetTime(HH:MM),enabled(डिफ़ॉल्टtrue)।GETप्रतिक्रियाएँ प्रत्येक सीमा मेंtokensUsed,remaining,windowStart,periodStartAtऔरnextResetAtजोड़ती हैं। यह एक प्रबंधन-श्रेणी का endpoint है (auth को authz pipeline द्वारा केंद्रीय रूप से लागू किया जाता है)।
अनुरोध प्रसंस्करण
- क्लाइंट
/v1/*पर अनुरोध भेजता है - रूट हैंडलर
handleChat,handleEmbedding,handleAudioTranscriptionयाhandleImageGenerationको कॉल करता है - मॉडल का समाधान किया जाता है (प्रत्यक्ष provider/model या alias/combo)
- खाता उपलब्धता फ़िल्टरिंग के साथ स्थानीय DB से क्रेडेंशियल चुने जाते हैं
- चैट के लिए:
handleChatCoresemantic/signature cache की जाँच करता है और combo compression सेटिंग्स का समाधान करता है - सक्षम होने पर provider translation से पहले proactive compression चलाया जाता है (
lite, Caveman, RTK या stacked) - Provider executor upstream अनुरोध भेजता है
- प्रतिक्रिया को क्लाइंट फ़ॉर्मेट में वापस अनुवादित किया जाता है (चैट) या यथावत लौटाया जाता है (embeddings/images/audio)
- उपयोग, compression analytics और अनुरोध लॉग रिकॉर्ड किए जाते हैं
- Combo नियमों के अनुसार त्रुटियों पर fallback लागू होता है
पूर्ण आर्किटेक्चर संदर्भ: ARCHITECTURE.md
Combo प्रबंधन
उच्च-स्तरीय routing combos (जिनका पहले ही /api/combos* के अंतर्गत सारांश दिया जा चुका है) को मॉडल आईडी पैटर्न से 1:1 मैप भी किया जा सकता है, जिससे OpenAI-शैली के मॉडल आईडी को किसी combo पर पारदर्शी रूप से पुनर्निर्देशित किया जा सके।
| Method | Path | Description |
|---|---|---|
| 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 हटाएँ |
प्रमाणीकरण: management session/API key (requireManagementAuth)।
वेबहुक
OmniRoute इवेंट्स (अनुरोध पूर्णता, कोटा समाप्ति, कुंजी रोटेशन आदि) के लिए आउटबाउंड वेबहुक सब्सक्रिप्शन।
| Method | Path | Description |
|---|---|---|
| GET | /api/webhooks |
वेबहुक की सूची (सीक्रेट को <prefix>... के रूप में मास्क किया जाता है) |
| POST | /api/webhooks |
वेबहुक बनाएँ — बॉडी: {url, events?: ["*"], secret?, description?} |
| GET | /api/webhooks/[id] |
वेबहुक प्राप्त करें |
| PUT | /api/webhooks/[id] |
url/events/secret/description अपडेट करें |
| DELETE | /api/webhooks/[id] |
वेबहुक हटाएँ |
| POST | /api/webhooks/[id]/test |
वेबहुक URL पर टेस्ट पेलोड भेजें और डिलीवरी स्थिति लौटाएँ |
प्रमाणीकरण: प्रबंधन सत्र/API कुंजी (requireManagementAuth)।
पंजीकृत कुंजियाँ (स्वचालित प्रबंधन)
ऑटो-कुंजी प्रबंधन सबसिस्टम द्वारा बैकिंग प्रोवाइडर/अकाउंट के विरुद्ध API कुंजियाँ जारी करने और रोटेट करने के लिए उपयोग किया जाता है, जिसमें दैनिक/प्रति घंटा कोटा होते हैं।
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/registered-keys |
पंजीकृत कुंजियों की सूची (केवल मास्क किया गया प्रीफ़िक्स) |
| 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 |
स्पष्ट रद्दीकरण एंडपॉइंट (DELETE के समान प्रभाव) |
प्रमाणीकरण: प्रबंधन सत्र/API कुंजी (requireManagementAuth) — /api/keys के समान गार्ड: डैशबोर्ड सत्र, स्थानीय CLI टोकन, या manage/admin स्कोप वाली API कुंजी; केवल इंफ़रेंस वाली API कुंजियों को 403 मिलता है। /v1/quotas/check और /v1/issues/report भी देखें।
एजेंट प्रोटोकॉल
Cloud agent कार्य (Claude Code, Codex Cloud, OpenHands आदि), जो OmniRoute उपयोगकर्ताओं की ओर से दूरस्थ रूप से निष्पादित किए जाते हैं।
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/agents/tasks |
कार्यों की सूची — वैकल्पिक ?provider=, ?status=, ?limit= (1–500, डिफ़ॉल्ट 50) |
| POST | /api/v1/agents/tasks |
कार्य बनाएँ — बॉडी CreateCloudAgentTaskSchema द्वारा सत्यापित (providerId, prompt, source, options?)। कार्य एनवेलप के साथ 201 लौटाता है |
| DELETE | /api/v1/agents/tasks?id=... |
कोई कार्य हटाएँ |
| GET | /api/v1/agents/tasks/[id] |
कार्य पढ़ें — external_id सेट होने पर अपस्ट्रीम Cloud agent से स्थिति को समकालिक रूप से रीफ़्रेश करता है |
| POST | /api/v1/agents/tasks/[id] |
विभेदित कार्रवाई: {action: "approve"}, {action: "message", message}, या {action: "cancel"} |
| DELETE | /api/v1/agents/tasks/[id] |
id द्वारा कोई विशिष्ट कार्य हटाएँ |
प्रमाणीकरण: प्रत्येक method पर management auth आवश्यक है (
requireCloudAgentManagementAuth)। v3.8.0 से पहले ये प्रमाणीकरण रहित थे — breaking change के लिए commit588a0333देखें।
# Claude Code cloud कार्य बनाएँ
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":"..."}}'
प्रबंधन प्रॉक्सी
आउटबाउंड HTTP(S)/SOCKS प्रॉक्सी, जिन्हें providers, accounts या वैश्विक स्तर पर असाइन किया जा सकता है।
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/management/proxies |
प्रॉक्सी की सूची ( ?id= के साथ एक प्रॉक्सी लौटाता है; ?id=&where_used=1 के साथ assignment graph लौटाता है) |
| POST | /api/v1/management/proxies |
प्रॉक्सी बनाएँ — बॉडी createProxyRegistrySchema द्वारा सत्यापित |
| PATCH | /api/v1/management/proxies |
प्रॉक्सी अपडेट करें — बॉडी updateProxyRegistrySchema द्वारा सत्यापित (id आवश्यक) |
| DELETE | /api/v1/management/proxies?id=...&force=1 |
प्रॉक्सी हटाएँ (force=1 का उपयोग assignments अलग करने के लिए करें) |
| GET | /api/v1/management/proxies/assignments |
assignments की सूची — proxy_id, scope, scope_id द्वारा फ़िल्टर किया जा सकता है; connection के लिए सक्रिय प्रॉक्सी निर्धारित करने हेतु resolve_connection_id=<id> पास करें |
| PUT | /api/v1/management/proxies/assignments |
असाइन करें — बॉडी proxyAssignmentSchema द्वारा सत्यापित ({scope, scopeId?, proxyId?})। dispatcher cache साफ़ करता है |
| PUT | /api/v1/management/proxies/bulk-assign |
bulk-assignment — बॉडी bulkProxyAssignmentSchema द्वारा सत्यापित ({scope, scopeIds[], proxyId?}) |
| GET | /api/v1/management/proxies/health?hours=24 |
एक समयावधि में aggregate proxy health (सफलता/विफलता की संख्या, latency) |
प्रमाणीकरण: प्रत्येक 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 अस्थायी विफलताओं से निपटने के लिए तीन स्वतंत्र तंत्र प्रदान करता है; नीचे दिए गए प्रबंधन एंडपॉइंट ऑपरेटरों को इन्हें पढ़ने और ओवरराइड करने की सुविधा देते हैं:
| दायरा | स्थिति संग्रहण | पढ़ें | रीसेट / साफ़ करें |
|---|---|---|---|
| प्रदाता ब्रेकर | domain_circuit_breakers + इन-मेमोरी |
/api/monitoring/health |
POST /api/resilience/reset |
| कनेक्शन कूलडाउन | प्रदाता कनेक्शनों पर rateLimitedUntil |
/api/rate-limits, /api/providers/[id] |
(आलसी रूप से पुनः-सक्षम होता है; प्रदाता PUT के माध्यम से साफ़ करें) |
| मॉडल लॉकआउट | इन-मेमोरी मॉडल-उपलब्धता रजिस्ट्री | GET /api/resilience/model-cooldowns |
DELETE /api/resilience/model-cooldowns |
PATCH /api/resilience providerBreaker.oauth और providerBreaker.apikey के अंतर्गत प्रदाता ब्रेकर ओवरराइड स्वीकार करता है। प्रत्येक प्रोफ़ाइल degradationThreshold, failureThreshold, और resetTimeoutMs का समर्थन करती है; यही फ़ील्ड Dashboard → Settings → Resilience में भी उपलब्ध हैं।
# एकल मॉडल लॉकआउट साफ़ करें
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"}'
# सभी लॉकआउट मिटाएँ
curl -X DELETE http://localhost:20128/api/resilience/model-cooldowns \
-H "Cookie: auth_token=..." \
-d '{"all":true}'
पूर्ण वैचारिक संदर्भ और ब्रेकर डिफ़ॉल्ट के लिए CLAUDE.md → "Resilience Runtime State" और docs/architecture/RESILIENCE_GUIDE.md देखें।
रेट-लिमिट कतार और ऑटो-सक्षम सुरक्षा तंत्र
- समर्थित लेखन पथ:
POST /api/rate-limitsजिसमें बॉडी{"connectionId": "<id>", "enabled": true|false}हो, किसी कनेक्शन के लिए रेट-लिमिट सुरक्षा को टॉगल करने वाला समर्थित प्रबंधन एंडपॉइंट है।PUT /api/providers/[id]जानबूझकरrateLimitProtectionको संशोधित या फ़्लिप नहीं करता (#11278)। enabled: falseका अर्थ:enabled: falseसेट करने से कनेक्शन के लिए स्पष्ट सुरक्षा हट जाती है, लेकिन यह सक्रिय API-key कनेक्शन को वैश्विक ऑटो-सक्षम सुरक्षा तंत्र (autoEnableApiKeyProviders = true) से बाहर नहीं करता।reconcileEnabledConnections(open-sse/services/rateLimitManager.ts) मेंfalseऔरundefinedसमतुल्य हैं; स्पष्ट सुरक्षा के बिना सक्रिय API-key कनेक्शन ऑटो-सक्षम सुरक्षा तंत्र के अंतर्गत सुरक्षित रहते हैं।- वैश्विक अक्षमकरण: API-key कनेक्शनों को रेट-लिमिट कतारों के बिना चलाने के लिए,
RATE_LIMIT_AUTO_ENABLE=false(env) याresilienceSettings.requestQueue.autoEnableApiKeyProviders = false(Settings → Resilience /PATCH /api/resilience) के माध्यम से सुरक्षा तंत्र को वैश्विक रूप से अक्षम करें।
कौशल
कस्टम निष्पादन योग्य हैंडलर के साथ OmniRoute का विस्तार करने और मार्केटप्लेस इंटीग्रेशन के लिए कौशल फ़्रेमवर्क।
| विधि | पथ | विवरण |
|---|---|---|
| GET | /api/skills |
इंस्टॉल किए गए कौशलों की सूची — ?q=, ?mode=on|off|auto, ?source=skillsmp|skillssh|local के अनुसार फ़िल्टर किया जा सकता है, पृष्ठांकित |
| GET | /api/skills/[id] |
एक कौशल प्राप्त करें |
| PUT | /api/skills/[id] |
कौशल अपडेट करें (नाम, विवरण, मोड, स्कीमा, हैंडलर, टैग) |
| DELETE | /api/skills/[id] |
कौशल अनइंस्टॉल करें |
| POST | /api/skills/install |
रॉ मेनिफ़ेस्ट से कौशल इंस्टॉल करें — बॉडी: {name, version, description, schema:{input, output}, handlerCode, apiKeyId?} |
| GET | /api/skills/executions |
हाल के कौशल निष्पादनों की सूची बनाएँ (इनपुट/आउटपुट/अवधि सहित ऑडिट ट्रेल) |
| GET | /api/skills/marketplace?q=... |
SkillsMP मार्केटप्लेस से खोज/लोकप्रिय सूची (skillsmpApiKey सेटिंग आवश्यक) |
| POST | /api/skills/marketplace/install |
SkillsMP से आईडी के आधार पर कौशल इंस्टॉल करें |
| GET | /api/skills/skillssh?q=&limit= |
skills.sh रजिस्ट्री में खोजें |
| POST | /api/skills/skillssh/install |
skills.sh से आईडी के आधार पर कौशल इंस्टॉल करें |
प्रमाणीकरण: प्रबंधन सत्र/API key। मार्केटप्लेस खोज रूट प्रबंधन प्रमाणीकरण या Bearer API key (isAuthenticated) में से किसी एक को स्वीकार करते हैं।
मेमोरी
प्रति API कुंजी / सत्र के दायरे में स्थायी संवादात्मक/तथ्यात्मक मेमोरी स्टोर।
| Method | Path | Description |
|---|---|---|
| GET | /api/memory |
मेमोरी की सूची — ?apiKeyId=, ?type=, ?sessionId=, ?q=, offset/limit या page/limit पृष्ठांकन के साथ |
| POST | /api/memory |
मेमोरी बनाएँ — Zod द्वारा सत्यापित बॉडी: {content, key, type?, sessionId?, apiKeyId?, metadata?, expiresAt?} |
| GET | /api/memory/[id] |
एक मेमोरी प्राप्त करें |
| DELETE | /api/memory/[id] |
एक मेमोरी हटाएँ |
| GET | /api/memory/health |
मेमोरी सबसिस्टम की स्थिति (DB कनेक्टिविटी, एम्बेडिंग्स बैकएंड, वेक्टर इंडेक्स की स्थिति) |
प्रमाणीकरण: प्रबंधन सत्र/API कुंजी (requireManagementAuth)। type enum: FACTUAL, EPISODIC, SEMANTIC, PROCEDURAL (src/lib/memory/types.ts में MemoryType देखें)।
MCP सर्वर
OmniRoute में 3 ट्रांसपोर्ट (stdio, SSE, streamable-http) और स्कोप-आधारित टूल वाला एम्बेडेड Model Context Protocol सर्वर शामिल है। नीचे दिए गए डैशबोर्ड एंडपॉइंट स्थिति/ऑडिट डेटा पढ़ते हैं और HTTP ट्रांसपोर्ट के लिए प्रॉक्सी का कार्य करते हैं।
| Method | Path | Description | |
|---|---|---|---|
| GET | /api/mcp/status |
हार्टबीट, ट्रांसपोर्ट, ऑनलाइन स्थिति, पिछली कॉल, शीर्ष टूल, 24 घंटे की सफलता दर | |
| GET | /api/mcp/tools |
name, description, scopes, phase, auditLevel, sourceEndpoints वाले MCP टूल की सूची |
|
| GET | /api/mcp/sse |
SSE ट्रांसपोर्ट के लिए SSE स्ट्रीम खोलें (MCP अक्षम होने या ट्रांसपोर्ट मेल न खाने पर 503 लौटाता है) |
|
| POST | /api/mcp/sse |
SSE ट्रांसपोर्ट पर JSON-RPC फ़्रेम भेजें | |
| GET | /api/mcp/stream |
Streamable HTTP ट्रांसपोर्ट का SSE पक्ष खोलें (सर्वर द्वारा शुरू किए गए संदेश) | |
| POST | /api/mcp/stream |
Streamable HTTP ट्रांसपोर्ट पर JSON-RPC फ़्रेम भेजें | |
| DELETE | /api/mcp/stream |
Streamable HTTP सत्र समाप्त करें | |
| GET | /api/mcp/audit |
ऑडिट लॉग पर क्वेरी करें — ?limit=, ?offset=, ?tool=, `?success=true |
false, ?apiKeyId=` |
| GET | /api/mcp/audit/stats |
समेकित ऑडिट आँकड़े (कुल, सफलता दर, औसत अवधि, शीर्ष टूल) |
प्रमाणीकरण: sse/stream ट्रांसपोर्ट MCP-विशिष्ट प्रमाणीकरण इंटरफ़ेस ( mcp स्कोप वाली Bearer API कुंजी) का पालन करते हैं; status/tools/audit* रूट डैशबोर्ड से पढ़े जा सकते हैं (डैशबोर्ड होस्ट तक पहुँचने के अतिरिक्त किसी प्रमाणीकरण की आवश्यकता नहीं है)।
दोनों HTTP ट्रांसपोर्ट
settings.mcpEnabledऔरsettings.mcpTransportद्वारा नियंत्रित हैं — ट्रांसपोर्ट मेल न खाने पर400, और MCP अक्षम होने पर503लौटता है।
A2A सर्वर
OmniRoute एक A2A (Agent-to-Agent) JSON-RPC 2.0 एंडपॉइंट और निरीक्षण/डैशबोर्ड उपयोग के लिए एक REST रैपर उपलब्ध कराता है।
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"}]
}
}
समर्थित विधियाँ (settings.a2aEnabled पर सभी नियंत्रित):
| Method | Description |
|---|---|
message/send |
सिंक्रोनस स्किल निष्पादन; {task, artifacts, metadata} लौटाता है |
message/stream |
उसी स्किल सेट का स्ट्रीमिंग SSE निष्पादन |
tasks/get |
taskId द्वारा कोई टास्क प्राप्त करें |
tasks/cancel |
taskId द्वारा कोई टास्क रद्द करें |
अंतर्निहित स्किल: smart-routing, quota-management, provider-discovery, cost-analysis, health-report।
Agent Card
GET /.well-known/agent.json
सार्वजनिक A2A एजेंट कार्ड (नाम, विवरण, क्षमताएँ, स्किल कैटलॉग, प्रमाणीकरण स्कीम) लौटाता है — 1 घंटे के लिए सार्वजनिक रूप से कैश किया जाता है। प्रमाणीकरण आवश्यक नहीं है।
REST हेल्पर्स
| Method | Path | Description |
|---|---|---|
| GET | /api/a2a/status |
A2A सक्षम है या नहीं + टास्क आँकड़े + कैश किए गए एजेंट कार्ड का सारांश |
| GET | /api/a2a/tasks |
टास्क की सूची — ?state=submitted|working|completed|failed|cancelled, ?skill=, ?limit= (≤200), ?offset= |
| POST | /api/a2a/tasks |
(REST हेल्पर के रूप में लागू नहीं — JSON-RPC message/send के माध्यम से बनाएँ) |
| GET | /api/a2a/tasks/[id] |
एक टास्क प्राप्त करें |
| POST | /api/a2a/tasks/[id]/cancel |
कोई टास्क रद्द करें |
प्रमाणीकरण: REST हेल्पर्स प्रबंधन प्रमाणीकरण के बिना चलते हैं (डैशबोर्ड द्वारा पढ़े जा सकते हैं); JSON-RPC /a2a रूट कॉन्फ़िगर होने पर Bearer OMNIROUTE_API_KEY का उपयोग करता है।
क्लाउड, मूल्यांकन और Assess
| Method | Path | Description | ||
|---|---|---|---|---|
| POST | /api/cloud/auth |
Bearer कुंजी का सत्यापन करें और क्लाउड सिंक क्लाइंट के लिए मास्क किए गए प्रोवाइडर कनेक्शन + मॉडल उपनाम लौटाएँ | ||
| POST | /api/cloud/credentials/update |
क्लाउड-सिंक किए गए प्रोवाइडर के लिए एन्क्रिप्टेड क्रेडेंशियल अपडेट करें | ||
| POST | /api/cloud/model/resolve |
स्थानीय रूटिंग तालिका का उपयोग करके लॉजिकल मॉडल आईडी को ठोस प्रोवाइडर/मॉडल में हल करें | ||
| GET | /api/cloud/models/alias |
क्लाउड सिंक के लिए उपलब्ध मॉडल उपनामों की सूची बनाएँ | ||
| GET | /api/assess |
नवीनतम आकलन वर्गीकरण (प्रति-प्रोवाइडर/मॉडल) पढ़ें | ||
| POST | /api/assess |
आकलन चलाएँ — बॉडी: `{scope: {type:"all"} | {type:"provider", providerId} | {type:"model", modelId}, trigger?}` |
| GET | /api/evals |
अंतर्निहित मूल्यांकन सूट + हालिया रन की सूची बनाएँ | ||
| POST | /api/evals |
मूल्यांकन रन ट्रिगर करें | ||
| POST | /api/evals/suites |
कस्टम मूल्यांकन सूट बनाएँ — बॉडी का सत्यापन evalSuiteSaveSchema द्वारा किया जाता है |
||
| GET | /api/evals/suites/[id] |
कस्टम मूल्यांकन सूट प्राप्त करें |
प्रमाणीकरण: /api/cloud/auth सीधे Bearer कुंजी का सत्यापन करता है और प्रत्येक कनेक्शन की मास्क की गई कुंजी तथा projectId केवल manage / admin स्कोप वाली कुंजी के लिए लौटाता है; अन्य /api/cloud/*, /api/evals/*, और /api/assess रूट के लिए प्रबंधन सत्र/API कुंजी आवश्यक है। /api/assess POST एक विभेदित-यूनियन स्कोप स्कीमा के साथ validateBody का उपयोग करता है।
ACP (Agent Client Protocol) प्रबंधन
चाइल्ड प्रोसेस के रूप में। ये एंडपॉइंट ACP एजेंट का पता लगाने और कस्टम एजेंट पंजीकरण का प्रबंधन करते हैं।
| विधि | पथ | विवरण |
|---|---|---|
| GET | /api/acp/agents |
इंस्टॉलेशन स्थिति, संस्करण और बाइनरी सहित सभी ज्ञात CLI एजेंट (बिल्ट-इन + कस्टम) की सूची बनाएं |
| POST | /api/acp/agents |
कस्टम ACP एजेंट पंजीकृत करें या कैश रीफ़्रेश करें — बॉडी: {id, name, binary, versionCommand, providerAlias, spawnArgs, protocol} या {action: "refresh"} |
| DELETE | /api/acp/agents |
कस्टम ACP एजेंट हटाएं — क्वेरी पैरामीटर: ?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
}
प्रमाणीकरण: प्रबंधन सत्र (डैशबोर्ड की auth_token कुकी) या प्रबंधन-स्कोप वाली API कुंजी आवश्यक है।
पूरे विवरण के लिए ACP Framework देखें।
एनालिटिक्स और ऑब्ज़र्वेबिलिटी
रूटिंग, कंप्रेशन और प्रोवाइडर विविधता की निगरानी के लिए रीयल-टाइम एनालिटिक्स एंडपॉइंट। ये /dashboard/analytics/* पेजों को डेटा प्रदान करते हैं।
ऑटो-रूटिंग एनालिटिक्स
| विधि | पथ | विवरण |
|---|---|---|
| GET | /api/analytics/auto-routing |
समेकित ऑटो-रूटिंग आँकड़े: कुल कॉल, रणनीति वितरण, टियर वितरण और शीर्ष प्रोवाइडर |
| 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 }
]
}
कंप्रेशन एनालिटिक्स
| विधि | पथ | विवरण |
|---|---|---|
| GET | /api/analytics/compression |
समेकित कंप्रेशन आँकड़े: बचाए गए टोकन, बचत %, मोड वितरण और इंजन उपयोग |
प्रतिक्रिया का उदाहरण:
{
"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
}
}
प्रोवाइडर विविधता ट्रैकिंग
| विधि | पथ | विवरण |
|---|---|---|
| GET | /api/analytics/diversity |
Shannon entropy-आधारित विविधता ट्रैकिंग: प्रोवाइडर वितरण को मापकर एकल विफलता बिंदुओं को रोकती है |
प्रतिक्रिया का उदाहरण:
{
"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 कुंजी आवश्यक है।
एडमिन संचालन
केवल एडमिन के लिए उपलब्ध परिचालन प्रबंधन एंडपॉइंट।
| Method | Path | Description |
|---|---|---|
| GET | /api/admin/concurrency |
वर्तमान समवर्ती सीमाएँ पढ़ें (वैश्विक + प्रति-प्रदाता) |
| POST | /api/admin/concurrency |
समवर्ती सीमाएँ अपडेट करें — बॉडी: {global?: number, perProvider?: Record<string, number>} |
प्रमाणीकरण: एडमिन स्कोप वाले प्रबंधन सत्र की आवश्यकता है।
CLI टूल प्रबंधन
OmniRoute के साथ एकीकृत CLI टूल प्रबंधित करें (antigravity, commandCode, devin-cli, आदि)। पूरी सूची के लिए प्रदाता संदर्भ देखें।
| Method | Path | Description |
|---|---|---|
| GET | /api/cli-tools/all-statuses |
सभी CLI टूल की स्थिति (इंस्टॉल किए गए, संस्करण, अंतिम बार देखे जाने का समय) |
| GET | /api/cli-tools/status |
किसी एक CLI टूल की स्थिति का विवरण (?tool= क्वेरी) |
| POST | /api/cli-tools/apply |
किसी टूल का जनरेट किया गया कॉन्फ़िगरेशन लिखें (dryRun पूर्वावलोकन दिखाता है; कंटेनरीकृत होने पर 422 + containerEphemeralTarget; migration पुराने Codex YAML का उल्लेख करता है) |
| GET | /api/cli-tools/backups |
CLI टूल कॉन्फ़िगरेशन बैकअप की सूची बनाएँ |
| POST | /api/cli-tools/backups |
सभी CLI टूल कॉन्फ़िगरेशन का बैकअप बनाएँ |
| POST | /api/cli-tools/backups |
पुनर्स्थापित करें: बॉडी में {tool, backupId} के साथ यही एंडपॉइंट उस बैकअप को पुनर्स्थापित करता है |
| GET | /api/cli-tools/antigravity-mitm |
Antigravity MITM प्रॉक्सी की स्थिति (यह "antigravity-mitm" CLI टूल है) |
| POST | /api/cli-tools/antigravity-mitm/alias |
antigravity-mitm उपनाम कॉन्फ़िगर करें |
प्रमाणीकरण: प्रबंधन सत्र की आवश्यकता है।
एजेंट स्किल्स
AI एजेंट स्किल्स प्रबंधित करें (एजेंट्स के लिए OpenAI के कस्टम GPTs के समान)।
| Method | Path | Description |
|---|---|---|
| GET | /api/agent-skills |
सभी एजेंट स्किल्स की सूची बनाएँ (बिल्ट-इन + कस्टम) |
| GET | /api/agent-skills/[id] |
किसी विशिष्ट एजेंट स्किल को प्राप्त करें |
| POST | /api/agent-skills |
कस्टम एजेंट स्किल बनाएँ — बॉडी: {name, description, prompt, model?, temperature?} |
| PUT | /api/agent-skills/[id] |
कस्टम एजेंट स्किल अपडेट करें |
| DELETE | /api/agent-skills/[id] |
कस्टम एजेंट स्किल हटाएँ |
| GET | /api/agent-skills/[id]/raw |
रॉ प्रॉम्प्ट + मेटाडेटा प्राप्त करें (कोई निष्पादन नहीं) |
| POST | /api/agent-skills/generate |
प्राकृतिक भाषा में दिए गए विवरण से नई स्किल AI द्वारा जनरेट करें |
प्रमाणीकरण: प्रबंधन सत्र या प्रबंधन-स्कोप वाली API कुंजी की आवश्यकता है।
कैश प्रबंधन
सिमैंटिक कैश और रीजनिंग कैश प्रबंधित करें।
| 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 + वेक्टर एम्बेडिंग)।
| 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 कुंजी आवश्यक है।
वेबहुक
इवेंट के लिए वेबहुक सदस्यताएँ प्रबंधित करें।
| Method | Path | Description |
|---|---|---|
| GET | /api/webhooks |
सभी वेबहुक सदस्यताओं की सूची बनाएँ |
| POST | /api/webhooks |
वेबहुक सदस्यता बनाएँ — बॉडी: {url, events[], secret?, active?} |
| GET | /api/webhooks/[id] |
किसी विशिष्ट वेबहुक सदस्यता को प्राप्त करें |
| PUT | /api/webhooks/[id] |
वेबहुक सदस्यता अपडेट करें |
| DELETE | /api/webhooks/[id] |
वेबहुक सदस्यता हटाएँ |
| GET | /api/webhooks/[id]/deliveries |
किसी वेबहुक के लिए डिलीवरी इतिहास की सूची बनाएँ (सफलता/विफलता लॉग) |
| POST | /api/webhooks/[id]/test |
वेबहुक को परीक्षण इवेंट भेजें |
प्रमाणीकरण: प्रबंधन सत्र आवश्यक है।
पूरे इवेंट प्रकारों के लिए वेबहुक्स फ़्रेमवर्क देखें।
कौशल फ़्रेमवर्क
कौशल (एजेंटिक एक्सटेंशन फ़्रेमवर्क) प्रबंधित करें।
| Method | Path | Description |
|---|---|---|
| GET | /api/skills |
सभी इंस्टॉल किए गए कौशलों की सूची (बिल्ट-इन + कस्टम) |
| 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= द्वारा फ़िल्टर करें) |
Auth: प्रबंधन सत्र या प्रबंधन-स्कोप वाली API कुंजी आवश्यक है।
पूरे विवरण के लिए कौशल फ़्रेमवर्क देखें।
प्लगइन्स
OmniRoute प्लगइन्स (तृतीय-पक्ष एक्सटेंशन) प्रबंधित करें।
| Method | Path | Description |
|---|---|---|
| GET | /api/plugins |
इंस्टॉल किए गए प्लगइन्स की सूची |
| POST | /api/plugins/marketplace/install |
मार्केटप्लेस से प्लगइन इंस्टॉल करें |
| DELETE | /api/plugins/[name] |
किसी प्लगइन को अनइंस्टॉल करें |
| POST | /api/plugins/[name]/activate |
किसी प्लगइन को सक्रिय करें |
| POST | /api/plugins/[name]/deactivate |
किसी प्लगइन को निष्क्रिय करें |
| GET | /api/plugins/[name]/config |
प्लगइन कॉन्फ़िगरेशन प्राप्त करें |
| PUT | /api/plugins/[name]/config |
प्लगइन कॉन्फ़िगरेशन अपडेट करें |
Auth: प्रबंधन सत्र आवश्यक है।
पूरे विवरण के लिए प्लगइन्स फ़्रेमवर्क देखें।
शैडो रूटिंग
प्रदाताओं की शैडो / A-B तुलना एक स्वतंत्र REST सतह नहीं है — इसे कॉम्बो रूटिंग के माध्यम से कॉन्फ़िगर किया जाता है (ऑटो-कॉम्बो देखें)। प्रत्येक कॉम्बो के तुलना मेट्रिक्स GET /api/combos/metrics द्वारा उपलब्ध कराए जाते हैं।
सुरक्षा नियंत्रण
रनटाइम सुरक्षा नियंत्रणों (PII पहचान, प्रॉम्प्ट इंजेक्शन पहचान, विज़न ब्रिजिंग) का निरीक्षण करें। सुरक्षा नियंत्रण प्रत्येक अनुरोध पर चलते हैं; प्रति-कॉल ऑप्ट-आउट x-omniroute-disabled-guardrails अनुरोध हेडर के माध्यम से किया जाता है — इन्हें स्थायी रूप से सक्षम/अक्षम करने के लिए कोई सतह नहीं है।
| Method | Path | Description |
|---|---|---|
| GET | /api/guardrails |
पंजीकृत सुरक्षा नियंत्रणों और उनकी स्थिति (नाम / सक्षम / प्राथमिकता) की सूची |
| POST | /api/guardrails/test |
नमूना इनपुट पर प्री-कॉल पाइपलाइन का ड्राय-रन — body: {input, disabledGuardrails?} |
Auth: प्रबंधन सत्र आवश्यक है।
पूरे विवरण के लिए सुरक्षा > सुरक्षा नियंत्रण देखें।
प्रमाणीकरण
चार क्रेडेंशियल परिवारों (डैशबोर्ड सत्र, स्थानीय CLI टोकन, oma_live_… एक्सेस टोकन, प्रबंधन-स्कोप वाली API कुंजी) और inference कुंजियों से उनके अंतर के लिए प्रबंधन प्रमाणीकरण देखें।
- डैशबोर्ड रूट (
/dashboard/*)auth_tokenकुकी का उपयोग करते हैं - लॉगिन सहेजे गए पासवर्ड हैश का उपयोग करता है; फ़ॉलबैक के रूप में
INITIAL_PASSWORDका उपयोग होता है requireLoginको/api/settings/require-loginके माध्यम से टॉगल किया जा सकता है/v1/*रूट के लिएREQUIRE_API_KEY=trueहोने पर Bearer API कुंजी आवश्यक हो सकती है- इस संदर्भ में "management token" / "management-scoped API key" का अर्थ उस गाइड में दिए गए परिवारों में से एक है — यह किसी अपरिभाषित अतिरिक्त सीक्रेट प्रकार को संदर्भित नहीं करता
ब्रेकिंग परिवर्तन (v3.8.0) —
/api/v1/agents/tasks/*और कूलडाउन प्रबंधन एंडपॉइंट के लिए अब प्रबंधन प्रमाणीकरण (डैशबोर्डauth_tokenकुकी या प्रबंधन-स्कोप वाली API कुंजी) आवश्यक है। जो क्लाइंट पहले इन रूट को बिना प्रमाणीकरण के कॉल करते थे, उन्हें401 Unauthorizedप्राप्त होगा। कमिट588a0333(fix(auth): require management auth for agent and cooldown APIs) देखें।