Skip to content

Latest commit

 

History

History
343 lines (246 loc) · 21.3 KB

API_REFERENCE.md

File metadata and controls

343 lines (246 loc) · 21.3 KB

एपीआई संदर्भ

🌐 Languages: 🇺🇸 English | 🇧🇷 Português (Brasil) | 🇪🇸 Español | 🇫🇷 Français | 🇮🇹 Italiano | 🇷🇺 Русский | 🇨🇳 中文 (简体) | 🇩🇪 Deutsch | 🇮🇳 हिन्दी | 🇹🇭 ไทย | 🇺🇦 Українська | 🇸🇦 العربية | 🇯🇵 日本語 | 🇻🇳 Tiếng Việt | 🇧🇬 Български | 🇩🇰 Dansk | 🇫🇮 Suomi | 🇮🇱 עברית | 🇭🇺 Magyar | 🇮🇩 Bahasa Indonesia | 🇰🇷 한국어 | 🇲🇾 Bahasa Melayu | 🇳🇱 Nederlands | 🇳🇴 Norsk | 🇵🇹 Português (Portugal) | 🇷🇴 Română | 🇵🇱 Polski | 🇸🇰 Slovenčina | 🇸🇪 Svenska | 🇵🇭 Filipino

सभी ओमनीरूट एपीआई एंडपॉइंट के लिए पूरा संदर्भ।

सामग्री तालिका

चैट समापन

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
}

कस्टम हेडर

| हेडर | दिशा | विवरण | | ------------------------ | ----------- | -------------------------------------------- | ----- | | X-OmniRoute-No-Cache | निवेदन | कैश को बायपास करने के लिए true पर सेट करें | | X-OmniRoute-Progress | निवेदन | प्रगति घटनाओं के लिए true पर सेट करें | | Idempotency-Key | निवेदन | डेडअप कुंजी (5एस विंडो) | | | निवेदन | वैकल्पिक डिडअप कुंजी | | X-OmniRoute-Cache | प्रतिक्रिया | HIT या MISS (गैर-स्ट्रीमिंग) | | X-OmniRoute-Idempotent | प्रतिक्रिया | true यदि डुप्लीकेट काटा गया है | | X-OmniRoute-Progress | प्रतिक्रिया | enabled यदि प्रगति ट्रैकिंग | पर है |

एम्बेडिंग

उपलब्ध प्रदाता: नेबियस, ओपनएआई, मिस्ट्रल, टुगेदर एआई, फायरवर्क्स, एनवीआईडीआईए।

# List all embedding models
GET /v1/embeddings

छवि निर्माण

POST /v1/images/generations
Authorization: Bearer your-api-key
Content-Type: application/json

{
  "model": "openai/dall-e-3",
  "prompt": "A beautiful sunset over mountains",
  "size": "1024x1024"
}

उपलब्ध प्रदाता: OpenAI (DALL-E), xAI (ग्रोक इमेज), टुगेदर AI (FLUX), फायरवर्क्स AI।

# List all image models
GET /v1/images/generations

सूची मॉडल

संगतता समापन बिंदु

विधि पथ प्रारूप
पोस्ट /v1/chat/completions ओपनएआई
पोस्ट /v1/messages मानवशास्त्रीय
पोस्ट /v1/responses ओपनएआई प्रतिक्रियाएँ
पोस्ट /v1/embeddings ओपनएआई
पोस्ट /v1/images/generations ओपनएआई
प्राप्त करें /v1/models ओपनएआई
पोस्ट /v1/messages/count_tokens मानवशास्त्रीय
प्राप्त करें /v1beta/models मिथुन
पोस्ट /v1beta/models/{...path} मिथुन जनरेटकंटेंट
पोस्ट /v1/api/chat ओलामा

समर्पित प्रदाता मार्ग

गायब होने पर प्रदाता उपसर्ग स्वतः जुड़ जाता है। बेमेल मॉडल 400 लौटाते हैं।

सिमेंटिक कैश

# Get cache stats
GET /api/cache

# Clear all caches
DELETE /api/cache

प्रतिक्रिया उदाहरण:

डैशबोर्ड एवं प्रबंधन

प्रमाणीकरण

समापन बिंदु Method विवरण
/api/auth/login POST Login
/api/auth/logout POST लॉगआउट
/api/settings/require-login GET/PUT Toggle login required

Provider Management

समापन बिंदु Method विवरण
/api/providers GET/POST प्रदाताओं की सूची बनाएं/बनाएँ
/api/providers/[id] GET/PUT/DELETE एक प्रदाता प्रबंधित करें
/api/providers/[id]/test पोस्ट परीक्षण प्रदाता कनेक्शन
/api/providers/[id]/models GET सूची प्रदाता मॉडल
/api/providers/validate POST प्रदाता कॉन्फ़िगरेशन सत्यापित करें
/api/provider-nodes* Various प्रदाता नोड प्रबंधन
/api/provider-models प्राप्त करें/पोस्ट करें/हटाएं कस्टम मॉडल

OAuth Flows

समापन बिंदु Method विवरण
/api/oauth/[provider]/[action] विविध प्रदाता-विशिष्ट OAuth

रूटिंग और कॉन्फ़िगरेशन

Endpoint Method विवरण
/api/models/alias GET/POST मॉडल उपनाम
/api/models/catalog प्राप्त करें प्रदाता द्वारा सभी मॉडल + प्रकार
/api/combos* विविध कॉम्बो प्रबंधन
/api/keys* Various एपीआई कुंजी प्रबंधन
/api/pricing प्राप्त करें मॉडल मूल्य निर्धारण

उपयोग एवं विश्लेषण

समापन बिंदु विधि Description
/api/usage/history प्राप्त करें उपयोग इतिहास
/api/usage/logs प्राप्त करें Usage logs
/api/usage/request-logs प्राप्त करें Request-level logs
/api/usage/[connectionId] प्राप्त करें Per-connection usage

Settings

समापन बिंदु Method Description
/api/settings GET/PUT General settings
/api/settings/proxy GET/PUT Network proxy config
/api/settings/proxy/test POST Test proxy connection
/api/settings/ip-filter GET/PUT IP allowlist/blocklist
/api/settings/thinking-budget GET/PUT Reasoning token budget
/api/settings/system-prompt GET/PUT Global system prompt

Monitoring

समापन बिंदु विधि विवरण
/api/sessions प्राप्त करें सक्रिय सत्र ट्रैकिंग
/api/rate-limits प्राप्त करें प्रति खाता दर सीमा
/api/monitoring/health प्राप्त करें स्वास्थ्य जांच
/api/cache प्राप्त करें/हटाएं कैश आँकड़े / साफ़

बैकअप और निर्यात/आयात

समापन बिंदु विधि विवरण
/api/db-backups प्राप्त करें उपलब्ध बैकअप की सूची
/api/db-backups डालो मैन्युअल बैकअप बनाएं
/api/db-backups पोस्ट किसी विशिष्ट बैकअप से पुनर्स्थापित करें
/api/db-backups/export प्राप्त करें डेटाबेस को .sqlite फ़ाइल के रूप में डाउनलोड करें
/api/db-backups/import पोस्ट डेटाबेस को बदलने के लिए .sqlite फ़ाइल अपलोड करें
/api/db-backups/exportAll प्राप्त करें .tar.gz संग्रह के रूप में पूर्ण बैकअप डाउनलोड करें

क्लाउड सिंक

समापन बिंदु विधि विवरण
/api/sync/cloud विविध क्लाउड सिंक ऑपरेशन
/api/sync/initialize पोस्ट सिंक प्रारंभ करें
/api/cloud/* विविध बादल प्रबंधन

सीएलआई उपकरण

समापन बिंदु विधि विवरण
/api/cli-tools/claude-settings प्राप्त करें क्लाउड सीएलआई स्थिति
/api/cli-tools/codex-settings प्राप्त करें कोडेक्स सीएलआई स्थिति
/api/cli-tools/droid-settings प्राप्त करें Droid CLI स्थिति
/api/cli-tools/openclaw-settings प्राप्त करें ओपनक्लॉ सीएलआई स्थिति
प्राप्त करें जेनेरिक सीएलआई रनटाइम

सीएलआई प्रतिक्रियाओं में शामिल हैं: installed, runnable, command, commandPath, runtimeMode, reason।

लचीलापन और दर सीमाएँ

समापन बिंदु विधि विवरण
/api/resilience प्राप्त/डालें लचीलापन प्रोफ़ाइल प्राप्त/अद्यतन करें
/api/resilience/reset पोस्ट सर्किट ब्रेकर रीसेट करें
/api/rate-limits प्राप्त करें प्रति खाता दर सीमा स्थिति
/api/rate-limit प्राप्त करें वैश्विक दर सीमा विन्यास

मूल्यांकन

समापन बिंदु विधि विवरण
/api/evals प्राप्त/पोस्ट करें सूची eval सुइट्स/रन मूल्यांकन

नीतियां

समापन बिंदु विधि विवरण
/api/policies प्राप्त करें/पोस्ट करें/हटाएं रूटिंग नीतियां प्रबंधित करें

अनुपालन

समापन बिंदु विधि विवरण
/api/compliance/audit-log प्राप्त करें अनुपालन ऑडिट लॉग (अंतिम एन)

v1बीटा (मिथुन-संगत)

समापन बिंदु विधि विवरण
/v1beta/models प्राप्त करें जेमिनी प्रारूप में मॉडलों की सूची बनाएं
/v1beta/models/{...path} पोस्ट मिथुन generateContent समापन बिंदु

ये समापन बिंदु उन ग्राहकों के लिए जेमिनी के एपीआई प्रारूप को प्रतिबिंबित करते हैं जो मूल जेमिनी एसडीके संगतता की अपेक्षा करते हैं।

आंतरिक/सिस्टम एपीआई

समापन बिंदु विधि विवरण
/api/init प्राप्त करें एप्लिकेशन इनिशियलाइज़ेशन जांच (पहले रन पर प्रयुक्त)
/api/tags प्राप्त करें ओलामा-संगत मॉडल टैग (ओलामा ग्राहकों के लिए)
/api/restart पोस्ट ट्रिगर सुशोभित सर्वर पुनरारंभ
/api/shutdown पोस्ट ट्रिगर ग्रेसफुल सर्वर शटडाउन

ध्यान दें: इन समापन बिंदुओं का उपयोग सिस्टम द्वारा आंतरिक रूप से या ओलामा क्लाइंट संगतता के लिए किया जाता है। उन्हें आम तौर पर अंतिम उपयोगकर्ताओं द्वारा नहीं बुलाया जाता है।

ऑडियो ट्रांसक्रिप्शन

POST /v1/audio/transcriptions
Authorization: Bearer your-api-key
Content-Type: multipart/form-data

डीपग्राम या असेंबलीएआई का उपयोग करके ऑडियो फ़ाइलों को ट्रांसक्राइब करें।

अनुरोध:

curl -X POST http://localhost:20128/v1/audio/transcriptions \
  -H "Authorization: Bearer your-api-key" \
  -F "file=@recording.mp3" \
  -F "model=deepgram/nova-3"

प्रतिक्रिया:

समर्थित प्रदाता: deepgram/nova-3, assemblyai/best।

समर्थित प्रारूप: mp3, wav, m4a, flac, ogg, webm।

ओलामा अनुकूलता

ओलामा के एपीआई प्रारूप का उपयोग करने वाले ग्राहकों के लिए:

अनुरोध स्वचालित रूप से ओलामा और आंतरिक प्रारूपों के बीच अनुवादित होते हैं।

टेलीमेट्री

प्रतिक्रिया:

बजट

मॉडल उपलब्धता

अनुरोध प्रसंस्करण

  1. ग्राहक /v1/* पर अनुरोध भेजता है
  2. रूट हैंडलर handleChat, handleEmbedding, handleAudioTranscription, या handleImageGeneration को कॉल करता है।
  3. मॉडल हल हो गया है (प्रत्यक्ष प्रदाता/मॉडल या उपनाम/कॉम्बो)
  4. खाता उपलब्धता फ़िल्टरिंग के साथ स्थानीय डीबी से चयनित क्रेडेंशियल
  5. चैट के लिए: handleChatCore - प्रारूप का पता लगाना, अनुवाद, कैश जांच, निष्क्रियता जांच
  6. प्रदाता निष्पादक अपस्ट्रीम अनुरोध भेजता है
  7. प्रतिक्रिया को क्लाइंट प्रारूप (चैट) में वापस अनुवादित किया गया या जैसा है वैसा ही लौटाया गया (एम्बेडिंग/छवियां/ऑडियो)
  8. उपयोग/लॉगिंग रिकॉर्ड किया गया
  9. कॉम्बो नियमों के अनुसार त्रुटियों पर फ़ॉलबैक लागू होता है

पूर्ण वास्तुकला संदर्भ: link

प्रमाणीकरण

  • डैशबोर्ड रूट (/dashboard/*) auth_token कुकी का उपयोग करते हैं
  • लॉगिन सहेजे गए पासवर्ड हैश का उपयोग करता है; INITIAL_PASSWORD पर फ़ॉलबैक
  • requireLogin /api/settings/require-login के माध्यम से टॉगल करने योग्य
  • /v1/* मार्गों को वैकल्पिक रूप से बियरर एपीआई कुंजी की आवश्यकता होती है जब REQUIRE_API_KEY=true