Files
OmniRoute/docs/i18n/cs/API_REFERENCE.md
2026-03-19 16:02:28 +01:00

14 KiB

Referenční informace k API

🌐 Jazyky: 🇺🇸 angličtina | 🇧🇷 Português (Brazílie) | 🇪🇸 Español | 🇫🇷 Français | 🇮🇹 Italiano | 🇷🇺 Русский | 🇨🇳中文 (简体) | 🇩🇪 Deutsch | 🇮🇳 हिन्दी | 🇹🇭 ไทย | 🇺🇦 Українська | 🇸🇦 العربية | 🇯🇵日本語| 🇻🇳 Tiếng Việt | 🇧🇬 Български | 🇩🇰 Dánsko | 🇫🇮 Suomi | 🇮🇱 עברית | 🇭🇺 maďarština | 🇮🇩 Bahasa Indonésie | 🇰🇷 한국어 | 🇲🇾 Bahasa Melayu | 🇳🇱 Nizozemsko | 🇳🇴 Norsk | 🇵🇹 Português (Portugalsko) | 🇷🇴 Română | 🇵🇱 Polski | 🇸🇰 Slovenčina | 🇸🇪 Svenska | 🇵🇭 Filipínec | 🇨🇿 Čeština

Kompletní referenční příručka pro všechny koncové body rozhraní OmniRoute API.


Obsah


Dokončení chatu

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
}

Vlastní záhlaví

Záhlaví Směr Popis
X-OmniRoute-No-Cache Žádost Nastavením na true se vynechá mezipaměť
X-OmniRoute-Progress Žádost Nastaveno na true pro události průběhu
Idempotency-Key Žádost Klíč pro deduplikaci (okno 5 s)
X-Request-Id Žádost Alternativní klíč pro odstranění duplicitních dat
X-OmniRoute-Cache Odpověď HIT or MISS (nestreamované)
X-OmniRoute-Idempotent Odpověď true , pokud je odstraněna duplikace
X-OmniRoute-Progress Odpověď enabled pokud je zapnuto sledování průběhu

Vložení

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

{
  "model": "nebius/Qwen/Qwen3-Embedding-8B",
  "input": "The food was delicious"
}

Dostupní poskytovatelé: Nebius, OpenAI, Mistral, Together AI, Fireworks, NVIDIA.

# List all embedding models
GET /v1/embeddings

Generování obrázků

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"
}

Dostupní poskytovatelé: OpenAI (DALL-E), xAI (Grok Image), Together AI (FLUX), Fireworks AI.

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

Seznam modelů

GET /v1/models
Authorization: Bearer your-api-key

→ Returns all chat, embedding, and image models + combos in OpenAI format

Koncové body kompatibility

Metoda Cesta Formát
ZVEŘEJNIT /v1/chat/completions OpenAI
ZVEŘEJNIT /v1/messages Antropický
ZVEŘEJNIT /v1/responses Reakce OpenAI
ZVEŘEJNIT /v1/embeddings OpenAI
ZVEŘEJNIT /v1/images/generations OpenAI
ZÍSKAT /v1/models OpenAI
ZVEŘEJNIT /v1/messages/count_tokens Antropický
ZÍSKAT /v1beta/models Blíženci
ZVEŘEJNIT /v1beta/models/{...path} Gemini generuje obsah
ZVEŘEJNIT /v1/api/chat Ollama

Vyhrazené trasy poskytovatelů

POST /v1/providers/{provider}/chat/completions
POST /v1/providers/{provider}/embeddings
POST /v1/providers/{provider}/images/generations

Pokud chybí prefix poskytovatele, automaticky se přidá. Neshodné modely vrátí chybu 400 .


Sémantická mezipaměť

# Get cache stats
GET /api/cache

# Clear all caches
DELETE /api/cache

Příklad odpovědi:

{
  "semanticCache": {
    "memorySize": 42,
    "memoryMaxSize": 500,
    "dbSize": 128,
    "hitRate": 0.65
  },
  "idempotency": {
    "activeKeys": 3,
    "windowMs": 5000
  }
}

Řídicí panel a správa

Ověřování

Koncový bod Metoda Popis
/api/auth/login ZVEŘEJNIT Přihlášení
/api/auth/logout ZVEŘEJNIT Odhlásit se
/api/settings/require-login ZÍSKAT/VLOŽIT Vyžaduje se přepnutí přihlášení

Správa poskytovatelů

Koncový bod Metoda Popis
/api/providers ZÍSKAT/ODESLAT Seznam / vytvoření poskytovatelů
/api/providers/[id] ZÍSKAT/VLOŽIT/ODSTRANIT Správa poskytovatele
/api/providers/[id]/test ZVEŘEJNIT Testovací připojení poskytovatele
/api/providers/[id]/models ZÍSKAT Seznam modelů poskytovatelů
/api/providers/validate ZVEŘEJNIT Ověření konfigurace poskytovatele
/api/provider-nodes* Různé Správa uzlů poskytovatelů
/api/provider-models ZÍSKAT/ODESLAT/SMAZAT Vlastní modely

Toky OAuth

Koncový bod Metoda Popis
/api/oauth/[provider]/[action] Různé OAuth specifický pro poskytovatele

Směrování a konfigurace

Koncový bod Metoda Popis
/api/models/alias ZÍSKAT/ODESLAT Aliasy modelů
/api/models/catalog ZÍSKAT Všechny modely podle poskytovatele + typu
/api/combos* Různé Správa kombinací
/api/keys* Různé Správa klíčů API
/api/pricing ZÍSKAT Cena modelu

Využití a analýzy

Koncový bod Metoda Popis
/api/usage/history ZÍSKAT Historie používání
/api/usage/logs ZÍSKAT Protokoly používání
/api/usage/request-logs ZÍSKAT Protokoly na úrovni požadavků
/api/usage/[connectionId] ZÍSKAT Využití na připojení

Nastavení

Koncový bod Metoda Popis
/api/settings ZÍSKAT/VLOŽIT Obecná nastavení
/api/settings/proxy ZÍSKAT/VLOŽIT Konfigurace síťového proxy serveru
/api/settings/proxy/test ZVEŘEJNIT Testovací připojení k proxy serveru
/api/settings/ip-filter ZÍSKAT/VLOŽIT Seznam povolených/blokovaných IP adres
/api/settings/thinking-budget ZÍSKAT/VLOŽIT Zdůvodnění rozpočtu tokenů
/api/settings/system-prompt ZÍSKAT/VLOŽIT Globální systémový výzva

Monitorování

Koncový bod Metoda Popis
/api/sessions ZÍSKAT Sledování aktivních relací
/api/rate-limits ZÍSKAT Limity sazeb na účet
/api/monitoring/health ZÍSKAT Kontrola stavu
/api/cache ZÍSKAT/SMAZAT Statistiky mezipaměti / vymazat

Zálohování a export/import

Koncový bod Metoda Popis
/api/db-backups ZÍSKAT Seznam dostupných záloh
/api/db-backups DÁT Vytvořte ruční zálohu
/api/db-backups ZVEŘEJNIT Obnovení z konkrétní zálohy
/api/db-backups/export ZÍSKAT Stáhnout databázi jako soubor .sqlite
/api/db-backups/import ZVEŘEJNIT Nahrajte soubor .sqlite pro nahrazení databáze
/api/db-backups/exportAll ZÍSKAT Stáhnout plnou zálohu jako archiv .tar.gz

Synchronizace s cloudem

Koncový bod Metoda Popis
/api/sync/cloud Různé Operace synchronizace s cloudem
/api/sync/initialize ZVEŘEJNIT Inicializovat synchronizaci
/api/cloud/* Různé Správa cloudu

Nástroje CLI

Koncový bod Metoda Popis
/api/cli-tools/claude-settings ZÍSKAT Stav Clauda CLI
/api/cli-tools/codex-settings ZÍSKAT Stav příkazového řádku Codexu
/api/cli-tools/droid-settings ZÍSKAT Stav příkazového řádku Droidu
/api/cli-tools/openclaw-settings ZÍSKAT Stav rozhraní příkazového řádku OpenClaw
/api/cli-tools/runtime/[toolId] ZÍSKAT Generické běhové prostředí CLI

Mezi odpovědi CLI patří: installed , runnable , command , commandPath , runtimeMode , reason .

Agenti ACP

Koncový bod Metoda Popis
/api/acp/agents ZÍSKAT Zobrazit seznam všech detekovaných agentů (vestavěných + vlastních) se stavem
/api/acp/agents ZVEŘEJNIT Přidat vlastního agenta nebo obnovit mezipaměť detekce
/api/acp/agents VYMAZAT Odebrání vlastního agenta podle parametru dotazu id

Odpověď GET obsahuje agents[] (id, name, binary, version, installed, protocol, isCustom) a summary (total, installed, notFound, builtIn, custom).

Odolnost a limity rychlosti

Koncový bod Metoda Popis
/api/resilience ZÍSKAT/VLOŽIT Získání/aktualizace profilů odolnosti
/api/resilience/reset ZVEŘEJNIT Resetujte jističe
/api/rate-limits ZÍSKAT Stav limitu sazby na účet
/api/rate-limit ZÍSKAT Konfigurace globálního limitu rychlosti

Evals

Koncový bod Metoda Popis
/api/evals ZÍSKAT/ODESLAT Vypsat eval sady / spustit vyhodnocení

Zásady

Koncový bod Metoda Popis
/api/policies ZÍSKAT/ODESLAT/SMAZAT Správa směrovacích zásad

Dodržování

Koncový bod Metoda Popis
/api/compliance/audit-log ZÍSKAT Protokol auditu shody (poslední N)

v1beta (kompatibilní s Gemini)

Koncový bod Metoda Popis
/v1beta/models ZÍSKAT Seznam modelů ve formátu Gemini
/v1beta/models/{...path} ZVEŘEJNIT Koncový bod Gemini generateContent

Tyto koncové body zrcadlí formát API Gemini pro klienty, kteří očekávají nativní kompatibilitu sady Gemini SDK.

Interní / systémová API

Koncový bod Metoda Popis
/api/init ZÍSKAT Kontrola inicializace aplikace (používá se při prvním spuštění)
/api/tags ZÍSKAT Tagy modelů kompatibilní s Ollamou (pro klienty Ollamy)
/api/restart ZVEŘEJNIT Spustit řádný restart serveru
/api/shutdown ZVEŘEJNIT Spustit řádné vypnutí serveru

Poznámka: Tyto koncové body používá interně systém nebo pro kompatibilitu s klienty Ollama. Koncoví uživatelé je obvykle nevolají.


Přepis zvuku

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

Přepisujte zvukové soubory pomocí Deepgramu nebo AssemblyAI.

Žádost:

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

Odpověď:

{
  "text": "Hello, this is the transcribed audio content.",
  "task": "transcribe",
  "language": "en",
  "duration": 12.5
}

Podporovaní poskytovatelé: deepgram/nova-3 , assemblyai/best .

Podporované formáty: mp3 , wav , m4a , flac , ogg , webm .


Kompatibilita s Ollamou

Pro klienty, kteří používají formát API od Ollamy:

# Chat endpoint (Ollama format)
POST /v1/api/chat

# Model listing (Ollama format)
GET /api/tags

Požadavky jsou automaticky překládány mezi formátem Ollama a interním formátem.


Telemetrie

# Get latency telemetry summary (p50/p95/p99 per provider)
GET /api/telemetry/summary

Odpověď:

{
  "providers": {
    "claudeCode": { "p50": 245, "p95": 890, "p99": 1200, "count": 150 },
    "github": { "p50": 180, "p95": 620, "p99": 950, "count": 320 }
  }
}

Rozpočet

# Get budget status for all API keys
GET /api/usage/budget

# Set or update a budget
POST /api/usage/budget
Content-Type: application/json

{
  "keyId": "key-123",
  "limit": 50.00,
  "period": "monthly"
}

Dostupnost modelu

# Get real-time model availability across all providers
GET /api/models/availability

# Check availability for a specific model
POST /api/models/availability
Content-Type: application/json

{
  "model": "claude-sonnet-4-5-20250929"
}

Zpracování žádosti

  1. Klient odesílá požadavek na /v1/*
  2. Obslužná rutina trasy volá handleChat , handleEmbedding , handleAudioTranscription nebo handleImageGeneration
  3. Model je vyřešen (přímý poskytovatel/model nebo alias/kombinace)
  4. Přihlašovací údaje vybrané z lokální databáze s filtrováním dostupnosti účtů
  5. Pro chat: handleChatCore — detekce formátu, překlad, kontrola mezipaměti, kontrola idempotence
  6. Prováděcí program poskytovatele odesílá požadavek nadřazenému serveru
  7. Odpověď přeložena zpět do klientského formátu (chat) nebo vrácena tak, jak je (vložené prvky/obrázky/zvuk)
  8. Zaznamenáno použití/protokolování
  9. Záložní metoda se použije na chyby podle pravidel kombinace.

Úplný referenční popis architektury: ARCHITECTURE.md


Ověřování

  • Trasy dashboardu ( /dashboard/* ) používají soubor cookie auth_token
  • Přihlášení používá uložený hash hesla; záložní nastavení je INITIAL_PASSWORD
  • requireLogin lze přepínat přes /api/settings/require-login
  • Trasy /v1/* volitelně vyžadují klíč API nosiče, pokud REQUIRE_API_KEY=true