Files
OmniRoute/docs/i18n/yo/docs/reference/API_REFERENCE.md

200 KiB
Raw Permalink Blame History

API Reference (Yorùbá)

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇧🇦 bs · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇱 he · 🇮🇳 hi · 🇭🇷 hr · 🇭🇺 hu · 🇦🇲 hy · 🇮🇩 id · 🇳🇬 ig · 🇮🇹 it · 🇯🇵 ja · 🇬🇪 ka · 🇰🇭 km · 🇮🇳 kn · 🇰🇷 ko · 🇱🇹 lt · 🇱🇻 lv · 🇮🇳 ml · 🇮🇳 mr · 🇲🇾 ms · 🇲🇹 mt · 🇲🇲 my · 🇳🇵 ne · 🇳🇱 nl · 🇳🇴 no · 🇮🇳 or · 🇮🇳 pa · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇱🇰 si · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇨🇳 zh-CN · 🇹🇼 zh-TW


🌐 Àwọn èdè: 🇺🇸 Gẹ̀ẹ́sì | 🇪🇹 አማርኛ | 🇸🇦 العربية | 🇦🇿 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á | 🇨🇳 中文 (简体) | 🇹🇼 中文 (繁體)

Ìtọ́kasí pàtàkì fún API OmniRoute. Ó bo ojú-ọ̀nà /v1 tó ṣí sí gbogbo ènìyàn àti àwọn endpoint ìṣàkóso tí a máa ń lò jù lọ; docs/openapi.yaml tí ẹrọ lè kà àti igi àwọn route tó wà lábẹ́ src/app/api/ ni àwọn orísun tó péye jù lọ.

Fún ìlànà ibaramu OpenAI pàtó àti àtòjọ agbára àwọn olùpèsè, wo OPENAI_COMPATIBILITY.md.

Ìṣàkóso kọ̀ọ̀kan máa ń pèsè ẹ̀dà tirẹ̀ ti spec ní /openapi.yaml, tí a ṣẹ̀dá láti docs/openapi.yaml nígbà ìkọ́lé. Ó ní ẹ̀dà ìkọ́lé náà àti URL server ojúlówó (./), nítorí náà àwọn ìbéèrè máa ń dúró lórí host tó pèsè ìwé náà. Ọ̀pa kan tó ń gbé fáìlì tí a gbà wọlé kò ní host bẹ́ẹ̀, ó sì nílò kí a ṣètò base URL pẹ̀lú ọwọ́.


Àkóónú


Àwọn Ìparí Ìjíròrò

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
}

Àwọn Àkọsílẹ̀ Àkànṣe

Header Direction Description
X-OmniRoute-No-Cache Ìbéèrè Ṣètò sí true láti fo kaṣe kọjá
x-omniroute-no-memory Ìbéèrè Ṣètò sí true láti fo abẹrẹ memory + skills fún ìbéèrè yìí (ó jọ no-cache; ó ń yàgò fún àfikún token/ìnáwó fún ìpè kọ̀ọ̀kan)
X-OmniRoute-Progress Ìbéèrè Ṣètò sí true fún àwọn ìṣẹ̀lẹ̀ ìlọsíwájú
X-Session-Id Ìbéèrè Kókó session tí ó dúró ṣinṣin fún ìbáṣepọ̀ session ìta
x_session_id Ìbéèrè Ẹ̀yà underscore náà tún wà fún lílo (HTTP tààrà)
X-OmniRoute-Session-Id Ìbéèrè Ààmì session/ìjíròrò tí olùpè pèsè (ó tún ń fún memory ní ìsọfúnni). Nígbà tí ó bá wà, a máa fi pamọ́ láìyípadà sínú call_logs.session_tag fún ìṣírò ìnáwó fún session kọ̀ọ̀kan (#8249) — a kì í dá a sílẹ̀ nígbà tí kò bá sí
Idempotency-Key Ìbéèrè Kókó ìdènà àtúnṣe (àkókò ìṣẹ́jú-aaya 5)
X-Request-Id Ìbéèrè Kókó ìdènà àtúnṣe mìíràn
x-omniroute-connection Ìbéèrè So ìbéèrè model kan ṣoṣo mọ́ ìsopọ̀ provider kan (account) nípa id rẹ — wo Píńnìngì account fún ìbéèrè kọ̀ọ̀kan
X-OmniRoute-Cache Ìdáhùn HIT tàbí MISS (àì-ṣíṣàn)
X-OmniRoute-Idempotent Ìdáhùn true bí a bá dín àtúnṣe kù
X-OmniRoute-Progress Ìdáhùn enabled bí ìtọ́pinpin ìlọsíwájú bá wà lórí
X-OmniRoute-Session-Id Ìdáhùn ID session tó munadoko tí OmniRoute lò
X-OmniRoute-Request-Id Ìdáhùn ID ìbáṣepọ̀ ìbéèrè (nígbà tí a bá mọ̀ ọ́n)
X-OmniRoute-Version Ìdáhùn Ẹ̀dà ìkọ́ OmniRoute (ó máa wà nígbà gbogbo)
X-OmniRoute-Cost-Saved Ìdáhùn USD tí kaṣe gbà là nígbà HIT (àwọn cache hit nìkan)
X-OmniRoute-Decision Ìdáhùn Àkọsílẹ̀ ìtọ́sọ́nà: strategy=<name>; provider=<alias>; latency_ms=<n> (<name> jẹ́ combo strategy, tàbí single fún ìbéèrè tí kì í ṣe combo) — ó máa wà nígbà gbogbo nínú àwọn ìdáhùn ìparí

Àkíyèsí Nginx: bí o bá gbẹ́kẹ̀ lé àwọn akọsori underscore (fún àpẹẹrẹ x_session_id), ṣiṣẹ́ underscores_in_headers on;.

Píńnìngì account fún ìbéèrè kọ̀ọ̀kan

Nígbà tí provider bá ní àwọn ìsopọ̀ púpọ̀ (accounts tàbí keys), OmniRoute sábà máa yan ọ̀kan nípasẹ̀ ọgbọ́n yíyan account rẹ̀. Ìbéèrè kan lè dípò bẹ́ẹ̀ so mọ́ ìsopọ̀ kan pàtó pẹ̀lú akọsori 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"}]}'
  • Ibi tí a ti rí id. Ṣí ojúewé olupèsè náà nínú dashboard (Dashboard → Providers → ) kí o sì tẹ chip id xxxxxxxx… lórí ìlà ìsopọ̀ kan — ó máa da id ìsopọ̀ kíkún kọ.
  • Àwọn ìbéèrè wo ló bọ̀wọ̀ fún un. Àwọn ìbéèrè model kan ṣoṣo (provider/model) lórí /v1/chat/completions, /v1/messages àti /v1/responses. Àwọn combo kọ̀ láti lo header náà: pin àkọọlẹ̀ kan fún ìgbésẹ̀ combo kọ̀ọ̀kan nípasẹ̀ ìsopọ̀ tirẹ̀ ti ìgbésẹ̀ náà.
  • Pin náà jẹ́ dandan, kì í ṣe ààyò. A máa lo ìsopọ̀ tí a pin sí nìkan. Bí ìkùnà bá wáyé nínú ìbéèrè náà, a máa gba àkọọlẹ̀ náà sílẹ̀ fún cooldown, ṣùgbọ́n a kò ní yí padà sí àkọọlẹ̀ arákùnrin kan ti olupèsè kan náà.
  • Cooldown àti quota máa tú pin náà sílẹ̀. Nígbà tí ìsopọ̀ tí a pin sí bá wà nínú cooldown, quota ti parí tàbí ìlànà quota kan ti dí i, àwọn ìbéèrè tó tẹ̀lé máa padà sí àwọn ìsopọ̀ mìíràn ti olupèsè náà, gẹ́gẹ́ bí ìrìnàjò tí a kò pin sí.
  • Àwọn id tí a kò mọ̀ tàbí tí a pa ṣiṣẹ́ máa fa ìkùnà. Id kan tí kò sí nínú àkójọpọ̀ olupèsè tó ń ṣiṣẹ́ (tí a ti pa rẹ́, tí a ti dáṣiṣẹ́, tàbí tí ó jẹ́ ti olupèsè mìíràn) kò fi àkọọlẹ̀ tó yẹ sílẹ̀, nítorí náà ìbéèrè náà máa kùnà dípò kí ó máa darí lọ sí ibòmíràn láìsọ̀rọ̀.

Claude Code máa ń fi àwọn header àṣà ránṣẹ́ nípasẹ̀ ANTHROPIC_CUSTOM_HEADERS. Fi í sínú abala env ti ~/.claude/settings.json, tàbí sínú .claude/settings.json ní ipele project láti pin àkọọlẹ̀ mìíràn fún project kọ̀ọ̀kan:

{
  "env": {
    "ANTHROPIC_BASE_URL": "http://<your OmniRoute>:20128",
    "ANTHROPIC_AUTH_TOKEN": "<your OmniRoute API key>",
    "ANTHROPIC_CUSTOM_HEADERS": "x-omniroute-connection: <connection id>",
  },
}

Orísun: src/sse/handlers/chat.ts (kíkà header), src/sse/services/auth.ts àti src/sse/services/sessionAffinityPin.ts (títú pin sílẹ̀ àti àyẹ̀wò pé kò sí nínú àkójọpọ̀).

Àwọn header telemetry iye owó: àwọn response àṣeyọrí tí kì í ṣe streaming tún máa ní àkójọpọ̀ telemetry iye owó X-OmniRoute-* — X-OmniRoute-Response-Cost (USD, decimal mẹ́wàá tó wa titi; 0.0000000000 fún ohun ọ̀fẹ́/tí kò ní iye owó), X-OmniRoute-Tokens-In / X-OmniRoute-Tokens-Out, X-OmniRoute-Model, X-OmniRoute-Provider, X-OmniRoute-Latency-Ms, X-OmniRoute-Cache-Hit, àti X-OmniRoute-Fallback-Attempts (nígbà tí iye náà bá ju 0 lọ nìkan), pẹ̀lú X-OmniRoute-Request-Id àti X-OmniRoute-Version. Àwọn yìí máa ń jáde láti inú chat completions, /v1/responses, /v1/messages, àti àwọn media endpoints — /v1/embeddings, /v1/images/generations, /v1/audio/speech, /v1/audio/transcriptions, /v1/rerank, /v1/videos/generations, /v1/music/generations, àti /v1/moderations (iye owó jẹ́ 0 ní gbogbo ìgbà). A máa ṣe iṣírò iye owó media gẹ́gẹ́ bí modality (fún àwòrán kọ̀ọ̀kan, fún ìṣẹ́jú-aaya kọ̀ọ̀kan, fún ohun kikọ̀ kọ̀ọ̀kan, fún search-unit kọ̀ọ̀kan) nígbà tí pricing bá wà; bí kò bá sí, iye náà jẹ́ 0 (fail-open).

Ìtumọ̀ iye owó cache-hit: lórí semantic-cache HIT (X-OmniRoute-Cache-Hit: true) kò sí ìpè upstream kankan tí a ṣe, nítorí náà X-OmniRoute-Response-Cost jẹ́ 0.0000000000 (iye owó àfikún fún fífi hit náà ṣiṣẹ́). Iye owó ìpilẹ̀ṣẹ̀/èyí tí ìbéèrè náà ì bá ti ná ni a máa ròyìn lọ́tọ̀ nínú X-OmniRoute-Cost-Saved. Àwọn oníbàárà billing yẹ kí wọ́n kó X-OmniRoute-Response-Cost jọ (hits kò ná owó); àwọn ìṣirò cache lè kó X-OmniRoute-Cost-Saved jọ.

Yíya Àkókò Àwọn Ìjókòó Tí A Ṣàkóso Pẹ̀lú Ìyasọ́tọ̀

Yíya àkókò ìjókòó tí a ṣàkóso pẹ̀lú ìyasọ́tọ̀ jẹ́ àdéhùn ìtọ́sọ́nà tí oníbàárà lè yan láti lò, tí kò sì dá lórí irú oníbàárà kan: oní ಮಾಸ? one active owner holds one eligible OmniRoute connection. Kò ya model kan sílẹ̀, kò béèrè OAuth, kò dá oníbàárà pàtó mọ̀, bẹ́ẹ̀ ni kò béèrè provider pàtó kan.

Bọtìnì API tó ń ṣe ìfàṣẹsí gbọ́dọ̀ ní scope lease:exclusive àti àtòjọ allowedConnections tí ó ṣe kedere tí kò sì ṣófo. Ààlà ìyípadà database ń fipá mú àwọn pápá méjèèjì pọ̀ nígbà dídá bọtìnì àti nígbà àwọn ìmúdójúìwọ̀n apá kan.

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

Àwọn ìdáhùn acquire, renew, àti release tí ó ṣàṣeyọrí máa ń ṣí àwọn àmì-àkókò, state, àti generation rere gangan síta, ṣùgbọ́n wọn kì í fi connection tí a yàn tàbí àwọn ẹ̀rí ìfàṣẹsí hàn. Renew àti release máa ń pèsè generation nínú ara JSON:

{ "action": "renew", "generation": 1 }
{ "action": "release", "generation": 1, "reason": "OWNER_EXIT" }

Oní lease tó ń ṣiṣẹ́ lè béèrè ní kedere fún metadata ìfihàn tí ó dá àṣírí bò fún binding rẹ̀ lọ́wọ́lọ́wọ́:

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

Iṣe status tí a yan láti lò yìí ni opaque owner, bọtìnì API tí a ṣàkóso tí ó jẹ́ authenticated, àti generation gangan tó ń ṣiṣẹ́ fi odi bò nínú transaction database kan. displayName jẹ́ orúkọ connection tí a ṣètò tí a gé ààyè àfikún rẹ̀ kúrò nìkan; ó jẹ́ null nígbà tí kò bá sí orúkọ tí a ṣètò tó bójú mu fún ìfihàn. OmniRoute kì í fi imeeli tàbí identity account tí a dá sílẹ̀ rọ́pò rẹ̀. Iye provider jẹ́ àkọlé ìfihàn tí kò ní ìmọ̀lára àṣírí, kò sì jẹ́ identifier provider tó bá a mu tí a dá sílẹ̀. Àwọn ẹ̀rí ìfàṣẹsí, tokens, cookies, àwọn id connection tàbí API key aise, owner hashes, fencing secrets, àti data ìtọ́sọ́nà inú eto ni a yọ kúrò.

Àwọn ìwádìí tí key kò tọ́, owner kò tọ́, generation ti pẹ́, ohun tí kò sí, tí ó ti parí, tí a ti tu sílẹ̀, àti tí a ti sọ di aláìṣiṣẹ́ gbogbo máa ń dá àṣìṣe 409 LEASE_FENCE_STALE kan náà padà láìsí metadata connection. Oníbàárà tó gba ìdáhùn ìdúróde capacity kò ní binding tó ń ṣiṣẹ́ láti ṣàyẹ̀wò. Nígbà tí routing bá yí lease tí ó ń ṣiṣẹ́ padà, generation kan náà máa ń wà nífàṣẹsí, status sì máa ń dá binding tuntun padà lọ́nà atomiki, kì í ṣe ti àtijọ́. Àwọn oníbàárà tó wà tẹ́lẹ̀ kò ní yípadà nítorí pé acquire, renew, release, àti àwọn ìdáhùn waiting máa ń pa àwọn ìrísí wọn àtijọ́ mọ́.

Àdéhùn server yìí kò yí stock OpenAI Codex /status padà. Stock Codex ní báyìí máa ń ròyìn provider model rẹ̀ àti ipò ìfàṣẹsí/account tí a ṣe sínú rẹ̀, ṣùgbọ́n kò ṣe àfihàn metadata account provider àṣà tí a bá fẹ́; integration oníbàárà tó máa wáyé lẹ́yìn náà gbọ́dọ̀ pe ìṣe yìí, kí ó sì pinnu bí yóò ṣe fi connection.displayName hàn.

Gbogbo ìbéèrè inference tí a ṣàkóso lẹ́yìn náà máa ń pèsè àwọn header ìṣàkóso méjèèjì:

X-OmniRoute-Lease-Owner: vlo_<43-base64url-characters>
X-OmniRoute-Lease-Generation: 1

Owner gangan, generation, connection tó ń ṣiṣẹ́, àti API key tí a fi ṣe authentication ni a fi fencing ṣe lẹ́sẹ̀kẹsẹ̀ ṣáájú ìgbìyànjú upstream kọọkan tí a ń ṣètìlẹ́yìn fún. Lílo owner àti generation tún pẹ̀lú key mìíràn máa ń kùnà, kódà nígbà tí key náà bá gba connection kan náà láyè. A kì í persist, log, tàbí pa raw owners mọ́, a kì í sì fi wọ́n sínú request snapshot tàbí rán wọn sí upstream.

Ìdíje fún àkókò díẹ̀ máa ń dá HTTP 429 padà pẹ̀lú Retry-After àti:

{
  "state": "WAITING_FOR_CAPACITY",
  "error": { "type": "lease_error", "code": "LEASE_CAPACITY_UNAVAILABLE" },
  "reason": "NO_FREE_ELIGIBLE_CONNECTION",
  "retryAfter": 30
}

Ìdáhùn yìí túmọ̀ sí nìkan pé àkójọpọ̀ àwọn ẹni tó yẹ ní ọ̀nà àìlera kò ṣófo, àti pé gbogbo candidates tó wà lọ́fẹ̀ẹ́ ni lease foreign tó ń ṣiṣẹ́ dì mú. Àwọn model/provider tí a kò ṣètìlẹ́yìn fún, policy mismatch, cooldown, quota, health, àti àwọn ìkùnà eligibility àràádọ́ta mìíràn máa ń pa àwọn ìdáhùn OmniRoute wọn tó wà tẹ́lẹ̀ mọ́.

x-omniroute-compression

Àyípadà compression plan fún ìbéèrè kọ̀ọ̀kan. Ó ní àṣẹ tó ga jùlọ — ó borí routing-combo override, active profile, auto-trigger, àti panel Default. Àwọn iye:

Value Effect
off Kò sí compression fún ìbéèrè yìí.
default Profile Default tí panel dá sílẹ̀ (ó kọ active profile sílẹ̀). A máa ń fi àwọn engines lossy sílẹ̀.
safe Dedup àti pípọ̀ whitespace nìkan.
allow-lossy Pa operator plan mọ́ fún ìbéèrè yìí, pẹ̀lú summaries àti style rewrites.
engine:<id> Engine kan ṣoṣo nígbà tí a bá ti ṣiṣẹ́, fún àpẹẹrẹ engine:rtk. Yíyan engine yìí fún ìbéèrè yìí nìkan.
<combo> Combo tí a dárúkọ, tí a bá orúkọ mu (case-insensitive) lákọ̀ọ́kọ́, lẹ́yìn náà pẹ̀lú id.

Àwọn àkíyèsí:

  • Àwọn iye tí a kò mọ̀ ni a kọ́; a kì í kọ ìbéèrè náà sílẹ̀ rárá, ìpinnu sì máa ń ṣubú padà sí àṣẹ operator tí ó ṣe déédéé.
  • Tí combos púpọ̀ bá pín orúkọ kan, lo combo id fún ìbámu tí ó dájú.
  • Combo tí orúkọ rẹ̀ bá jẹ́ off tàbí default kò lè jẹ́ yíyan pẹ̀lú orúkọ; àwọn koko ọ̀rọ̀ wọ̀nyí ni a máa ń túmọ̀ lákọ̀ọ́kọ́. Lo id combo náà fún irú combo bẹ́ẹ̀.
  • Master compression switch jẹ́ ẹnu-ọ̀nà líle: nígbà tí a bá pa compression jù lọ káàkiri, header yìí kò lè mú un ṣiṣẹ́.

A máa ń dá plan tí a lò padà nínú response header:

X-OmniRoute-Compression: <mode>; source=<source>

níbi tí <source> ti jẹ́ ọ̀kan lára request-header, routing-override, active-profile, auto-trigger, default, tàbí off.


Àwọn Embedding

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

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

Àwọn olupèsè tó wà: Nebius, OpenAI, Mistral, Together AI, Fireworks, NVIDIA, OpenRouter, Jina AI.

Àwọn ID katalogi jẹ́ provider/model (àpẹẹrẹ: jina-ai/jina-embeddings-v5-omni-small). Àwọn ID model Jina tí kò ní provider tí ó hàn nínú registry (fún àpẹẹrẹ jina-embeddings-v5-text-small, jina-reranker-v3.5) náà máa ṣiṣẹ́. Jina embed/rerank/classify/segment máa kọ́kọ́ lo àwọn credential jina-ai dashboard; JINA_AI_API_KEY jẹ́ àfidípò nìkan nígbà tí kò bá sí dashboard key. Káàdì jina-reader jẹ́ Reader / r.jina.ai nìkan (POST /v1/web/fetch), kò sì máa pèsè embeddings tàbí rerank.

Àwọn model registry tí wọ́n kéde àtìlẹ́yìn multimodal tún gba títí dé àwọn ohun èlò structured 32 tí kò gbẹ́kẹ̀lé provider. Àwọn irú media item ni text, image, audio, video, àti document. source media wọn jẹ́ bóyá {"type":"url","url":"https://..."} tàbí {"type":"base64","data":"...","media_type":"..."}.

Jina v5 Omni (jina-ai/jina-embeddings-v5-omni-small, jina-ai/jina-embeddings-v5-omni-nano, àti alias ìdílé jina-ai/jina-embeddings-v5-omni → omni-small) tún gba àwọn ìwé native EmbeddingsV5Request ti Jina, ó sì ń rán wọ́n lọ láìyípadà sí 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,..." }] }
  ]
}

Àwọn iye native { image | audio | video | pdf } lè jẹ́ URL HTTPS tó ṣí sí gbogbo ènìyàn, URI data:, tàbí base64 tí kò sí ìṣàkóso síi. OmniRoute kò máa stringify àwọn object wọ̀nyẹn tàbí gba àwọn URL image native wọlé — Jina fúnra rẹ̀ ló máa gba media tó wà ní gbangba. Àwọn field Jina míì (task, normalized, truncate, embedding_type) ni a máa rán lọ. Àwọn SKU Jina tó jẹ́ text-only ṣì máa kọ́ àwọn doc tí kì í ṣe text.

Ààlà ààbò àti ìrìnàjò:

  • Àwọn URL media tó jìnà gbọ́dọ̀ jẹ́ HTTPS tó ṣí sí gbangba. Àwọn item canonical {type,source:url} ni a máa gba ní server-side (ìmúdájú redirect lẹ́ẹ̀kan síi, timeout, ààlà ìwọ̀n, public DNS, àti dídè ìsopọ̀ mọ́ IP) kí a tó fi wọ́n sínú request provider. Àwọn item Jina-native {image:"https://..."} ni a máa rán lọ gẹ́gẹ́ bí wọ́n ṣe rí lẹ́yìn àyẹ̀wò public-HTTPS kan náà; Jina ló máa gba URL náà.
  • Àwọn media base64 inú request ní ààlà 8 MiB tí a ti decode fún item kọ̀ọ̀kan, àti 16 MiB tí a ti decode káàkiri request náà.

Ìtumọ̀ sí provider (a kì í rán àwọn item canonical lọ láìyípadà):

  • Àwọn model Jina multimodal: item ipele-gíga kọ̀ọ̀kan di object kan tí a ṣètò pẹ̀lú modality (text / image / audio / video / pdf), tí ó ń lo data URI fún media inú request; vector kan fún item ipele-gíga kọ̀ọ̀kan.
  • Ìdílé Gemini Embedding 2: array ipele-gíga kan di request native kan ṣoṣo models/{model}:embedContent pẹ̀lú content.parts (text tàbí inline_data).
  • llama.cpp (llama-cpp/<model>, model èyíkéyìí tí server àdúgbò bá ti gbé sórí): àwọn item text canonical di string lasan, àwọn image / audio / video sì di object {"content": [part]} kọ̀ọ̀kan, tí wọ́n ń lo àwọn content parts chat ti llama-server (image_url, input_audio pẹ̀lú format wav / mp3 / flac, input_video) pẹ̀lú data inú request; vector kan fún item ipele-gíga kọ̀ọ̀kan. document kò ní àtìlẹ́yìn. Server náà gbọ́dọ̀ ṣiṣẹ́ pẹ̀lú --embedding --mmproj …; láìsí projector, òun fúnra rẹ̀ máa kọ media.
  • Àwọn model tí a kò mọ̀/dynamic tí kò bá ní metadata modality tó ṣe kedere máa kọ structured input pẹ̀lú 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"
}

Àwọn àkópọ̀ model/modality tí kò ní àtìlẹ́yìn máa dá HTTP 400 padà dípò kí wọ́n yí item náà padà sí irú mìíràn. Àwọn field extension tí kì í ṣe input lórí àwọn request legacy string/token ṣì máa kọjá lọ láìyípadà.

# Ṣe àtòjọ gbogbo àwọn model embedding
GET /v1/embeddings

Aworan Iran

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

Awọn olupese ti o wa pẹlu OpenAI (Aworan GPT 2), xAI (Aworan Grok ), Together AI (FLUX), Fireworks AI, Nebius (FLUX), Hyperbolic, NanoBanana,OpenRouter ,ZenMux , SD WebUI (agbegbe), ComfyUI (agbegbe).

n awọn aworan n pada ni data[]. Awọn olupese ti API oke wọn da aworan kan pada fun ipe kan (Labs Forest Labs, Stability AI, Leonardo, Ideogram, Haiper, Hyperbolic, Magnific/Freepik, NVIDIA NIM, Cloudflare Workers AI) gba n lọtọ awọn ipe oke, ni julọ 4 ni flight. seed ti o wa titi jẹ aiṣedeede nipasẹ atọka ipe (seed, seed + 1, …), nitorinaa awọn aworan yato ṣugbọn o duro ni atunṣe. n ti wa ni capped ni 10. Awọn ìbéèrè kuna bi odidi ti eyikeyi ipe ba kuna. Atokọ awọn ọna kika àìpẹ-jade jẹ SINGLE_IMAGE_FANOUT_FORMATS ni open-sse/handlers/imageGeneration/fanOut.ts.

ZenMux tun lo asopọ bọtini API ti o wa ati gba zenmux/ tabi awọn ami-iṣaaju zm/ :

  • zenmux/openai/gpt-image-2 nlo ZenMux's OpenAI Awọn aworan API. Awọn aṣayan pẹlu size, quality, n, output_format, output_compression, background, ati response_format.
  • Awọn atẹwe miiran, gẹgẹbi zm/meta/muse-image-1.0, lo ZenMux's Vertex AI :predict endpoint. awọn maapu n si sampleCount, aspect_ratio si aspectRatio, ati image_size (1K, 2K, 4K) si sampleImageSize. Piksẹli size n pese ipin ipin nikan, kii ṣe awọn iwọn ẹbun ti o ni ẹri. Awọn ipin atilẹyin, awọn ipinnu, ati awọn iṣiro yatọ nipasẹ awoṣe.
  • zm/inclusionai/ming-image-0.1-design yan awọn iwọn tirẹ. Yọ size, aspect_ratio, ati image_size; awọn iye kedere pada HTTP 400. PNG, JPEG, ati WebP le beere pẹlu output_format.

Iṣọkan yii ṣe atilẹyin iran-ọrọ-si-aworan, kii ṣe ṣiṣatunṣe aworan itọkasi. Iṣẹjade fatesi jẹ deede si data[].b64_json; response_format: "url" da pada HTTPS URL oke tabi data base64 URL nigbati awọn baiti aworan nikan wa. awọn abajade Empty/filtered da aṣiṣe pada kuku ju aṣeyọri ofo kan. Wiwọle awoṣe da lori akọọlẹ ZenMux. Wo ZenMux's Vertex API ati OpenAI Awọn aworan API.

Asopọ iwọle Microsoft 365 Copilot n ṣe iranṣẹ copilot-m365-web/m365-copilot-image nipasẹ ohun elo aworan ti a ṣe sinu Copilot: yiyi Copilot kan fun aworan (n 1–4), idari size nikan ni iṣalaye, ati awọn aworan ti o pada si laini (b64_json, tabi data URL fun response_format: "url"). Wo Microsoft 365 Copilot.

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

OCR Ìwé

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 máa ń yan olupèsè OCR nípasẹ̀ àfikún provider/model; ID àwòkọ́ṣe tí kò ní àfikún (fún àpẹẹrẹ mistral-ocr-latest) máa ń yanju sí olupèsè tí a forúkọ sílẹ̀ fún un, àti pé bí a kò bá fi model ránṣẹ́, a máa ń lo Mistral ní àìpẹ̀ (mistral-ocr-latest). Àwọn olupèsè tí a forúkọ sílẹ̀ (open-sse/config/ocrRegistry.ts):

Provider id Model id model value Àwọn àlàyé
mistral mistral-ocr-latest mistral/mistral-ocr-latest (or bare mistral-ocr-latest) Amuṣiṣẹ́pọ̀ — a máa ń dá ìdáhùn padà taara láti inú ìpè upstream kan ṣoṣo.
azure-document-intelligence prebuilt-read azure-document-intelligence/prebuilt-read Upstream aláìṣiṣẹ́pọ̀ (analyze + poll) — wo ìsàlẹ̀.
vertex-deepseek-ocr deepseek-ocr-maas vertex-deepseek-ocr/deepseek-ocr-maas Amuṣiṣẹ́pọ̀, nípasẹ̀ endpoint alábàápín Vertex AI openapi/chat/completions — wo ìsàlẹ̀ fún ìfàṣẹsí/URL.

Gbogbo àwọn olupèsè mẹ́tẹ̀ẹ̀ta máa ń dá ara ìdáhùn tó dà bí ti Mistral padà:

{
  "pages": [{ "index": 0, "markdown": "# Extracted text..." }],
  "model": "mistral-ocr-latest",
  "usage_info": { "pages_processed": 1 }
}

Ìṣàn ìdúró Azure Document Intelligence

API analyze ti Azure Document Intelligence jẹ́ aláìṣiṣẹ́pọ̀: ìbéèrè àkọ́kọ́ máa ń dá àkọlé Operation-Location padà dípò ara ìdáhùn, a sì gbọ́dọ̀ máa ṣàyẹ̀wò àbájáde náà. Olùṣàkóso náà (open-sse/handlers/ocr.ts) máa ń ṣàyẹ̀wò URL yẹn ní gbogbo ìṣẹ́jú-aaya fún ìgbésẹ̀ tó pọ̀ jù lọ 30, ó máa ń kùnà kíákíá (kò tẹ̀síwájú láti ṣàyẹ̀wò) bí ìdáhùn ìṣàyẹ̀wò kan kò bá jẹ́ ok tàbí tí ipò náà bá jẹ́ "failed", ó sì máa ń dá 504 padà bí iṣẹ́ náà bá ṣì ń lọ lẹ́yìn tí iye ìgbésẹ̀ tí a pèsè bá tán. A máa ń ṣe àtúnṣe ìdáhùn Azure ìkẹyìn sí irú pages/markdown kan náà tí Mistral ń lò kí a tó dá a padà sí olùpè, nítorí náà kóòdù oníbàárà kò nílò láti ṣe ìyàsọ́tọ̀ pàtàkì fún olupèsè náà.

Ìfàṣẹsí àti yíyan endpoint Vertex AI DeepSeek OCR

vertex-deepseek-ocr tún máa ń lo ìfàṣẹsí Vertex AI kan náà tí OmniRoute ti ń ṣe àtìlẹ́yìn fún ìrìnàjò chat/image (open-sse/executors/vertex.ts): API key ìsopọ̀ náà jẹ́ bóyá ẹ̀rí JSON Service Account (tí a ń pààrọ̀ sí àmi ìwọlé OAuth tó ní àkókò kúkúrú nípasẹ̀ ìṣàn JWT-bearer) tàbí àmi ìwọlé OAuth tí a ti ṣẹ̀dá tẹ́lẹ̀ tí a máa ń lò bó ṣe rí. URL endpoint upstream jẹ́ endpoint alábàápín Vertex fún openapi/chat/completions, tí a kọ́ láti inú iṣẹ́ àti agbègbè ìsopọ̀ — providerSpecificData.project/providerSpecificData.region tí a bá ṣàlàyé máa ń ṣẹ́gun nígbà gbogbo; bí bẹ́ẹ̀ kọ́, a máa ń yọ iṣẹ́ náà kúrò nínú project_id ti Service Account JSON, agbègbè náà sì máa ń jẹ́ us-central1 ní àìpẹ̀. Àwọn ìpinnu méjèèjì ń ṣẹlẹ̀ ní open-sse/handlers/ocr.ts (resolveVertexOcrAccessToken, resolveVertexOcrBaseUrl), tí src/app/api/v1/ocr/route.ts sì ń lò kí ó tó pín iṣẹ́ náà sí handleOcr.


Àkójọ Àwọn Modeli

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

→ Ó máa ń dá gbogbo chat, embedding, àti image models + combos padà ní ọ̀nà OpenAI

Àwọn iye owó modeli (pricing)

Àkọsílẹ̀ kan ní ohun pricing nínú nígbà tí OmniRoute bá mọ iye owó modeli náà. Iye owó náà ń wá láti inú tábìlì pricing tí ìṣírò iye owó ń lò: àwọn àiyé àkọ́kọ́ tí a ṣe sínú ètò, àwọn iye owó tí a bá múṣiṣẹ́pọ̀, àti àwọn àyípadà tí a ṣètò nípasẹ̀ /api/pricing. Àwọn wọ̀nyí ni iye owó tí a ṣe àfihàn, nítorí náà àwọn olùpèsè ìforúkọsílẹ̀ náà máa ń ṣàfihàn iye owó fún token kọ̀ọ̀kan.

"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
}
Àwọn pápá Ẹ̀ka Àwọn àkíyèsí
prompt, completion, input_cache_read, input_cache_write USD fún token kọ̀ọ̀kan, ọ̀rọ̀ desimalì Ó bá OpenRouter mu, kò sì máa ń lo ìkọ̀wé exponent rí. Àwọn pápá cache méjèèjì máa ń hàn nìkan nígbà tí iye owó cache bá wà.
input, output, cached, cache_creation USD fún token mílíọ̀nù 1, nọ́mbà Àwọn pápá láti inú àwọn ẹ̀dà katalogi àtijọ́, tí a pa mọ́ fún àwọn client tó wà tẹ́lẹ̀. reasoning àti long_context náà máa ń hàn nígbà tí ìlà pricing bá ní wọn.
  • Combos máa ń gbé iye owó ti target àkọ́kọ́ tí ó hàn wọ̀n. Àwọn combos auto/* tí a ṣe sínú ètò máa ń yan target ní àkókò ìbéèrè, nítorí náà wọn kò ní pricing.
  • Àwọn modeli ọ̀fẹ́ máa ń ṣàfihàn "0" (àti 0) nígbà tí iye owó wọn bá jẹ́ òdo. Modeli tí kò ní ìlà pricing náà máa ń ṣàfihàn "0" nígbà tí katalogi bá samisi rẹ̀ gẹ́gẹ́ bí ọ̀fẹ́ (free: true) tàbí tí katalogi àwọn modeli ọ̀fẹ́ tó wà nínú ètò bá ṣe àtòjọ rẹ̀.
  • Iye owó tí a kò mọ̀: àkọsílẹ̀ náà kò ní kọ́kọ́rọ́ pricing.
  • Àwọn olùpèsè tí a ń fi credit díwọ̀n (gẹ́gẹ́ bí Kiro) máa ń gba owó fún ìbéèrè kọ̀ọ̀kan dípò token kọ̀ọ̀kan. Àwọn àkọsílẹ̀ wọn máa ń pa àwọn pápá nọ́mbà fún token mílíọ̀nù 1 tí wọ́n ní tẹ́lẹ̀ mọ́, wọn kò sì ní àwọn pápá ọ̀rọ̀ fún token kọ̀ọ̀kan.
  • Àwọn variants (àwọn id fún reasoning-effort, àwọn alias no-thinking, discovery àti àwọn mirror gateway) máa ń da iye owó modeli tí wọ́n ń darí sí ṣe.
  • Àwọn pápá náà ní àwọn ìwọ̀n ìpilẹ̀ nìkan. Àwọn ipele long-context (pápá nọ́mbà long_context) àti àwọn multiplier service-tier (fún àpẹẹrẹ Codex fast tàbí flex) kò yí prompt tàbí completion padà.
  • Ohun náà jẹ́ kan náà fún gbogbo irú ìfàṣẹsí, pẹ̀lú ìbéèrè ara-Anthropic tó ní x-api-key àti anthropic-version (ìdáhùn náà ṣì wà ní { "object": "list", "data": [...] }). Ìmúṣẹ́: src/app/api/v1/models/catalogPricing.ts.

Àwọn prefix id modeli (?prefix=)

Ọ̀pọ̀ àwọn modeli ni a ń polówó rẹ̀ lábẹ́ prefix olùpèsè. Àsìkò wo ni prefix tí o bá rí máa ń jẹ́ ni a ń darí nípasẹ̀ feature flag MODELS_CATALOG_PREFIX_MODE, a sì lè borí rẹ̀ fún ìbéèrè kọ̀ọ̀kan pẹ̀lú query parameter — èyí wúlò fún client tó fẹ́ àkójọ tó mọ́ láìyí ètò gbogbo server padà fún gbogbo ènìyàn:

GET /v1/models?prefix=alias        # id kan fún modeli kọ̀ọ̀kan — prefix alias kúkúrú
GET /v1/models?prefix=dual         # àwọn fọ́ọ̀mù méjèèjì (àiyé server)
GET /v1/models?prefix=canonical    # prefix provider-id kíkún nìkan
Mode Ohun tí ó ń jáde Àwọn àkíyèsí
dual cc/claude-sonnet-4-6 àti claude/claude-sonnet-4-6 Àiyé àkọ́kọ́. Àwọn id méjèèjì ń darí sí modeli kan náà; a pa wọ́n mọ́ kí àwọn àtòpọ̀ client tó ti hardcode fọ́ọ̀mù èyíkéyìí nínú wọn lè máa ṣiṣẹ́. Ó fẹ́rẹ̀ẹ́ jẹ́ pé ó máa ń mú katalogi náà ní ìlọ́po méjì.
alias cc/claude-sonnet-4-6 Àkọsílẹ̀ kan fún modeli kọ̀ọ̀kan. Àwọn olùpèsè tí kò ní alias pàtó ṣì máa ń ṣàfihàn àkọsílẹ̀ wọn, nítorí náà kò sí ohun tó sọnù.
canonical claude/claude-sonnet-4-6 Àkọsílẹ̀ kan fún modeli kọ̀ọ̀kan lábẹ́ prefix provider-id kíkún. Àwọn olùpèsè tí kò ní alias pàtó (fún àpẹẹrẹ antigravity/…, agy/…) náà máa ń ṣàfihàn id kan ṣoṣo wọn níbí, nítorí náà kò sí ohun tó sọnù.

A tún lè dá mirror tó wà ní mode dual mọ̀ láìsí query parameter: ó ní pápá parent tó ń tọ́ka sí id àkọ́kọ́.

Àwọn client tó ń ṣe àfihàn yíyan modeli yẹ kí wọ́n béèrè ?prefix=alias — èyí ni OmniCopilot VS Code extension ń ṣe.

Àwọn àlẹ̀ discovery (?capability=, ?min_context=, ?kind=, ?q=)

GET /v1/models gba àwọn àlẹ̀ discovery tí a yàn láti lò. Láìsí èyíkéyìí nínú wọn, ìdáhùn náà kò yí padà. Wọ́n máa ń dín katalogi tí olùbéèrè ti ń rí kù (àṣẹ API-key máa ń ṣiṣẹ́ ní àkọ́kọ́), wọ́n sì máa ń ṣiṣẹ́ ṣáájú paging limit / after ara OpenAI:

GET /v1/models?capability=vision&capability=tool_calling   # gbogbo capability tí a ṣe àtòjọ gbọ́dọ̀ jẹ́ òótọ́
GET /v1/models?capability=vision,reasoning&min_context=200000
GET /v1/models?kind=embedding                              # `type` katalogi; àwọn ìlà tí kò ní ọ̀kan jẹ́ `chat`
GET /v1/models?q=sonnet&limit=10                           # ìbámu tí kò ka lẹ́tà ńlá tàbí kékeré sí lórí id tàbí orúkọ
Ìpín Àwọn iye
capability attachment, reasoning, structured_output, temperature, thinking, tool_calling, vision
min_context odidi tí kò kéré ju odo lọ, tí a fi wé context_length
kind chat, audio, embedding, image, moderation, music, rerank, video
q àwọn àmì 1–200

Iye tí a kò mọ̀, tàbí min_context tí kì í ṣe odidi tí kò kéré ju odo lọ (fún àpẹẹrẹ 1.5), máa dá HTTP 400 padà, ìfiránṣẹ́ náà sì máa ṣàkọsílẹ̀ àwọn iye tó wúlò. Ìmúṣẹ̀: src/app/api/v1/models/catalogFilters.ts.

Àkójọ kékeré àwọn model (POST /v1/models/query)

POST /v1/models/query máa dá àkójọ kúkúrú, tí àbájáde rẹ̀ jẹ́ ìdánilójú, padà láti inú katalogi kan náà, pẹ̀lú ìfàṣẹsí àti ìfarahàn fún kọ́kọ́rọ́ kọ̀ọ̀kan kan náà bí 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 ] }

Gbogbo pápá jẹ́ àṣàyàn. capabilities àti exclude lè jẹ́ àkójọpọ̀ tàbí ọ̀rọ̀ tí a yà sílẹ̀ pẹ̀lú koma; max_output máa fi wé max_output_tokens. A máa ṣètò àwọn àbájáde nípa owned_by, lẹ́yìn náà nípa id. limit máa jẹ́ 20 ní àìpẹ̀, àwọn iye tó ju 100 lọ sì máa di 100. JSON tí kò bófin mu, pápá tí a kò mọ̀ tàbí iye tí kò bófin mu máa dá HTTP 400 padà.

Àwọn model chat tí a fi pamọ̀ lọ́kọ̀ọ̀kan

Model kan tí a samisi Farasin lórí ojú-ìwé olùpèsè rẹ̀ ni a yọ kúrò nínú katalogi, a sì máa kọ̀ ọ́ pẹ̀lú HTTP 404 / model_not_found nígbà tí a bá béèrè fún un ní tààràtà. Àyẹ̀wò náà máa lo olùpèsè àti model tí a yanjú, pẹ̀lú àwọn alias olùpèsè, àwọn àfikún prefix node ti olùpèsè tó bá ara wọn mu, àti àwọn àìpẹ̀ ìsopọ̀. Combo kan máa fo àwọn ibi-afẹ́ tí a fi pamọ̀ kọjá, ó sì lè lo arákùnrin tí ó hàn. Nígbà tí kò bá sí ibi-afẹ́ tó lè ṣiṣẹ́ mọ́, ó máa dá kóòdù aṣìṣe kan náà padà. Yíyọ ìpamọ̀ kúrò máa ní ipa lórí ìbéèrè tó kàn. Àwọn ìyípadà ìfarahàn tó kan àwòrán nìkan kì í fi model chat tó ní ID kan náà pamọ̀.

Ètò model kọ̀ọ̀kan yìí yàtọ̀ sí àwọn àtòjọ ìfàyègbà/ìdènà ìfihàn model, tí ń ṣe àlẹ̀mọ́ ìpolówó katalogi àti àwọn olùdíje ìdaríàìdáṣe nígbà tí wọ́n ń pa ìránṣẹ́ tààrà mọ́. Àwọn àṣẹ ìmúlò model fún kọ́kọ́rọ́ API ṣì ń ṣiṣẹ́ lọ́tọ̀. Ààyè prefix katalogi àìpẹ̀ ṣì jẹ́ dual.

Àwọn ìyípadà model tí kò ní no-thinking

Fún àwọn model Claude tí ó lè ṣe thinking, /v1/models tún máa polówó ìyípadà no-thinking kan tí ID rẹ̀ bẹ̀rẹ̀ pẹ̀lú claude-3-omniroute-no-thinking/:

claude-3-omniroute-no-thinking/<provider>/<model>

Yíyan ID yìí (fún àpẹẹrẹ nínú àtòpọ̀ Claude Code tí ó máa so bulọ́ọ̀kì thinking pọ̀ mọ́ ìbéèrè ní gbogbo ìgbà) máa yanjú padà sí <provider>/<model> gidi pẹ̀lú ìrònú tí a pa; thinking:{type:"disabled"} lórí ọ̀nà /v1/messages, tàbí àwọn pápá reasoning/reasoning_effort tí a yọ kúrò lórí ọ̀nà /v1/chat/completions. A máa ṣàkọsílẹ̀ ìyípadà náà fún àwọn model ìdílé Claude nìkan tí wọ́n ń ṣe thinking àti tí wọ́n sì ń bọ̀wọ̀ fún disabled (nítorí náà, àwọn model tí ó jẹ́ adaptive-only tí wọ́n kọ disabled ni a yọ kúrò). Àwọn oníṣiṣẹ́ lè fi ìyípadà náà múlẹ̀ tàbí pa á fún model kọ̀ọ̀kan nípasẹ̀ ModelSpec.noThinkingAlias.


Manifesti Plugin Olùpèsè

GET /api/v1/provider-plugin-manifest

Ó dá manifesti plugin olùpèsè JSON-safe tí Bifrost, CLIProxyAPI, àti àwọn router sidecar ọjọ́ iwájú ń lò padà. A ṣe ìdáhùn náà jáde láti inú registry olùpèsè TypeScript, ó sì mọ̀ọ́mọ̀ yọ àwọn aṣírí oníbàárà OAuth, ìpinnu àyíká runtime, àwọn iṣẹ́ executor, àwọn akọsori ìbéèrè, àti dátà àkọọ́lẹ̀ kúrò.

Lo endpoint yìí nígbà tí sidecar bá ń ṣiṣẹ́ níta ilana náà tí kò sì lè import open-sse/config/providerPluginManifestRegistry.ts taara.


Ṣíṣẹ́da ohun ElevenLabs

Ṣètò ìsopọ̀ olùpèsè elevenlabs kan nínú OmniRoute pẹ̀lú kọ́kọ́rọ́ API ElevenLabs rẹ. Àwọn client máa ń fi kọ́kọ́rọ́ OmniRoute wọn ṣe ìfàṣẹsí (Authorization: Bearer $OMNIROUTE_API_KEY); gateway náà máa ń pèsè kọ́kọ́rọ́ olùpèsè tí a fipamọ́ sílẹ̀ gẹ́gẹ́ bí xi-api-key. Má ṣe rán kọ́kọ́rọ́ ElevenLabs gẹ́gẹ́ bí bearer token gateway.

Ọ̀nà Ọ̀nà URL Ìdáhùn Ẹ̀ka endpoint kọ́kọ́rọ́ API
POST /v1/sound-generation Àwọn baiti ohun abinibi elevenlabs
POST /v1/music Àwọn baiti ohun abinibi music
POST /v1/music/stream Àwọn baiti ohun tí ń ṣàn music
POST /v1/music/detailed Ohun multipart abinibi àti ètò ìṣọ̀kan music
POST /v1/music/detailed/stream Metadata SSE abinibi àti àwọn chunk ohun music
POST /v1/music/plan Ètò ìṣọ̀kan JSON music

Àwọn endpoint wọ̀nyí ń ṣe àfikún sí àwọn route /v1/audio/speech, /v1/audio/transcriptions, /v1/voices, /v1/text-to-speech/{voiceId} àti /v1/speech-to-text tó wà tẹ́lẹ̀. Àwọn field JSON abinibi àti àwọn query parameter bíi output_format àti enable_logging wà láìyípadà. Àwọn ìdáhùn /v1/music/detailed máa ń pa àwọn multipart boundary wọn mọ́; tú wọn jáde gẹ́gẹ́ bí multipart. /v1/music/detailed/stream máa ń dá text/event-stream padà pẹ̀lú metadata ìṣọ̀kan àti àwọn chunk ohun base64 nínú àwọn ìṣẹ̀lẹ̀ SSE. Gbogbo route mẹ́fà náà ń ṣe àtìlẹ́yìn CORS preflight.

export OMNIROUTE_BASE_URL="http://localhost:20128"
export OMNIROUTE_API_KEY="your-omniroute-api-key"

# Ìró àkíyèsí kúkúrú kan. Àkókò: 0.5 sí 30 ìṣẹ́jú-àáyá.
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

# Àkókò orin ni a ń sọ ní milliseconds: 3000 sí 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

Lo /v1/music/stream pẹ̀lú JSON body kan náà fún fífi ohun ránṣẹ́ díẹ̀díẹ̀. Composition gba prompt tàbí composition_plan kan ṣoṣo gẹ́gẹ́ bí yíyan; /v1/music/plan nílò prompt ó sì lè gba source_composition_plan ní àfikún. Àwọn schema abinibi máa ń pa àwọn field olùpèsè àfikún mọ́ kí àwọn ẹ̀dà composition-plan àti àwọn aṣàyàn fine-tuning lè dé ọdọ ElevenLabs.

Endpoint ìṣọ̀kan /v1/music/generations tún gba elevenlabs/music_v1, elevenlabs/music_v2 àti elevenlabs/music_v2_5. Pẹ̀lú ìsopọ̀ ElevenLabs tí ń ṣiṣẹ́, àwọn model wọ̀nyí wà nínú katalogi orin. Endpoint yìí máa ń dá {"created":...,"data":[{"b64_json":"...","format":"mp3"}]} padà. Field duration rẹ̀ wà ní ìṣẹ́jú-àáyá ó sì máa ń yí padà sí music_length_ms; music_length_ms tí a bá pèsè ní kedere ló ní ààyè àkọ́kọ́. instrumental máa ń yí padà sí force_instrumental, pẹ̀lú field abinibi náà ní ààyè àkọ́kọ́. Lo àwọn endpoint streaming abinibi fún streaming àti endpoint composition abinibi fún àwọn ìbéèrè tí composition plan nìkan ń darí.

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

Àwọn ìdíwọ̀ endpoint, model, budget àti ìsopọ̀ máa ń ṣiṣẹ́ kí ìpè upstream tó ṣẹlẹ̀. Àwọn route abinibi máa ń dá àwọn kóòdù ipo upstream àti àwọn body aṣìṣe padà láìyípadà, pẹ̀lú 402 fún ìdíwọ̀ plan àti 429 fún ààlà quota. Àwọn akọsori character-cost, song-id, request-id àti retry-after wà láìyípadà nígbà tí wọ́n bá wà. Ìwọ̀n credit ọ̀fẹ́ kò ṣe ìdánilójú pé a lè wọ gbogbo model orin, output format tàbí àfidámọ́ API: ElevenLabs ló ń pinnu ẹ̀tọ́ fún ìbéèrè kọ̀ọ̀kan. Endpoint ìṣọ̀kan máa ń pa àwọn kóòdù ipo aṣìṣe mọ́ nínú envelope aṣìṣe tí OmniRoute ṣe àfọwọ́kọ.

Àwọn àdéhùn upstream: sound effects, music composition àti streaming music details.


Àwọn Endpoint Ibámu

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 (àtúnṣe/inpaint)
POST /v1/videos/generations Ìṣẹ̀dá fídíò irú OpenAI
POST /v1/music/generations Ìṣẹ̀dá orin irú OpenAI
POST /v1/audio/transcriptions OpenAI Audio (STT)
POST /v1/audio/speech OpenAI TTS (ó máa dá body ohun padà)
POST /v1/rerank Rerank irú Cohere/Voyage
POST /v1/classify Ìpín Jina (api.jina.ai)
POST /v1/segment Alàpín Jina (segment.jina.ai)
POST /v1/moderations OpenAI Moderations
GET /v1/models OpenAI
POST /v1/models/query Àkójọ kúkúrú àwọn model tí a ṣe àlẹ̀mọ́
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}/ Àpèjáwe katalogi OpenAI
GET /api/v1/vscode/{token}/models Àpèjáwe models OpenAI
POST /api/v1/vscode/{token}/chat/completions Àpèjáwe tokenized OpenAI
POST /api/v1/vscode/{token}/responses Àpèjáwe tokenized OpenAI Responses
POST /api/v1/vscode/{token}/api/chat Àpèjáwe tokenized Ollama
GET /api/v1/vscode/{token}/api/tags Àpèjáwe tokenized Ollama tags

Gbogbo àwọn route POST ń tẹ̀lé ìrísí kan náà: Bearer your-api-key + body JSON tí Zod ti fọwọ́ sí (v1RerankSchema, v1ModerationSchema, v1AudioSpeechSchema, àti bẹ́ẹ̀ bẹ́ẹ̀ lọ; wo src/shared/validation/schemas.ts). A máa dá 4xx padà tí schema bá kuna.

Fún àwọn client tí kò lè fi Authorization: Bearer ... ránṣẹ́, OmniRoute tún gba API keys nínú URL nípasẹ̀ ibámu query-string (?token=..., ?apiKey=..., ?api_key=..., ?key=...) tàbí àwọn endpoint /api/v1/vscode/{token}/... pàtó tí a ṣàkọsílẹ̀ ní ìsàlẹ̀.

# Rerank (olùpèsè cloud registry, tàbí node olùpèsè tó bá OpenAI mu gẹ́gẹ́ bí "<prefix>/<model>")
POST /v1/rerank      { "model": "jina-ai/jina-reranker-v3.5", "query": "...", "documents": ["..."] }

# Ìpín Jina (àwọn ẹ̀rí ìdánimọ̀ Foundation API)
POST /v1/classify    { "model": "jina-embeddings-v5-text-small", "input": ["..."], "labels": ["a", "b"] }

# Alàpín Jina
POST /v1/segment     { "content": "...", "return_chunks": true }

# Àwárí Jina (s.jina.ai; àwọn alias olùpèsè: jina-search, jina-ai, jina)
POST /v1/search      { "query": "...", "provider": "jina-search" }

# Moderations
POST /v1/moderations { "model": "omni-moderation-latest", "input": "..." }

# TTS — ó máa dá body audio/mpeg (tàbí ọ̀nà kika tí a béèrè) padà
POST /v1/audio/speech { "model": "openai/tts-1", "input": "Hello", "voice": "alloy" }

# Soniox TTS nílò èdè àti ohùn kan: `language` máa ń jẹ́ "en" ní àìpẹ́
# tí voice bá sọnù tàbí tí orúkọ ohùn OpenAI àdàkọ kan (alloy, nova, …) bá jẹ́, ó máa di "Adrian"
POST /v1/audio/speech { "model": "soniox/tts-rt-v1", "input": "Xin chào", "voice": "Adrian", "language": "vi" }

# Àtúnṣe àwòrán (multipart)
POST /v1/images/edits  -F image=@input.png -F prompt="..." -F mask=@mask.png

# Ìṣẹ̀dá fídíò / orin (ID model tí a fi prefix olùpèsè sí)
POST /v1/videos/generations { "model": "runway/gen-3", "prompt": "..." }
POST /v1/music/generations  { "model": "kie/suno-v4.0",   "prompt": "..." }

Àwọn node provider rerank: POST /v1/rerank tún ń darí sí àwọn node provider tó bá OpenAI mu (oMLX, vLLM, Infinity, TEI lẹ́yìn gateway, …) tí a ń tọ́ka sí gẹ́gẹ́ bí <node-prefix>/<model>. Àwọn node loopback (localhost, 127.0.0.1, 172.16.0.0/12) máa ń yẹ ní gbogbo ìgbà, bákan náà sì ni àwọn hostname tí oníṣiṣẹ́ ṣe àtòjọ nínú OMNIROUTE_LOCAL_PROVIDER_NODE_HOSTS (fún àpẹẹrẹ, orúkọ iṣẹ́ Docker/Compose bí http://reranker:8080/v1; a máa ń pe wọ́n ní tààrà, kò sì ṣe é lò wọ́n nípasẹ̀ HTTP(S)_PROXY tàbí proxy tí a pin mọ́ asopọ̀ kan). Àwọn node tó wà lórí host míì — àpótí LAN tàbí ẹlẹgbẹ́ Tailscale — máa ń yẹ nìkan nígbà tí oníṣiṣẹ́ bá mú feature flag RERANK_REMOTE_PROVIDER_NODES ṣiṣẹ́ àti tí URL ìpìlẹ̀ node náà bá kọjá ìlànà URL outbound provider (OMNIROUTE_ALLOW_LOCAL_PROVIDER_URLS / OMNIROUTE_ALLOW_PRIVATE_PROVIDER_URLS). Ìgbésẹ̀ rerank ti ẹ́ńjìnnì memory máa ń pe route yìí lórí loopback, nítorí náà ìlànà kan náà ni ó ń ṣàkóso rerankProviderModel nínú àwọn ìṣètò Memory.

Àwọn ìrísí server agbegbe: a máa ń pe node náà ní <base>/v1/rerank àti, nígbà 404, ní <base>/rerank (Infinity, TEI). Ara ìbéèrè upstream máa ń gbé irú ìkọ̀wé Cohere/OpenAI (documents, return_documents) àti irú ìkọ̀wé TEI (texts, return_text) pọ̀, a sì máa ń ṣe ìdíwọ̀n padà ìdáhùn upstream sí envelope Cohere: TEI tí ó jẹ́ [{index, score, text}] lásán, {results: [{index, score}]} láti ọ̀dọ̀ gateway tín-ínrín, àti {data: [...]} irú Voyage gbogbo wọn máa ń padà sí oníbàárà gẹ́gẹ́ bí {results: [{index, relevance_score, document?}]}, tí a ṣètò gẹ́gẹ́ bí score tí a sì gé sí top_n.

Ìwádìí node provider: àwọn model lórí node provider tó bá OpenAI mu máa ń hàn nínú GET /v1/models lábẹ́ prefix node náà. Àwọn ìlà tí kò ní metadata endpoint kankan (èyí tó wọ́pọ̀ fún àtòjọ /v1/models agbegbe) máa ń jogún apiType node náà, nítorí náà àwọn model node embeddings máa ń jẹ́ type: "embedding" àti àwọn model node rerank máa ń jẹ́ type: "rerank" dípò kí wọ́n di chat ní àìpẹ̀yà; supportedEndpoints tí a sọ ní kedere lórí ìlà tí a muṣiṣẹ́pọ̀ tàbí tí a fi ọwọ́ kún sí ṣì ní ààyè àkọ́kọ́.

Àwọn Route Provider Pàtàkì

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

A máa ń fi prefix provider náà kún un láìfọwọ́wọ́ tí ó bá sọnù. Àwọn model tí kò bá mu máa ń dá 400 padà.


API Àwọn Fáìlì

Endpoint àwọn fáìlì tó bá OpenAI mu fún àbáwọlé/jáde batch àti àwọn ìgbéjáde fáìlì fún ète pàtó.

Method Path Description
POST /v1/files Gbérù fáìlì kan (multipart: file, purpose, expires_after[anchor], expires_after[seconds]) — 512 MiB ni ó pọ̀ jù lọ
GET /v1/files Ṣàkójọ àwọn fáìlì fún API key tí a fìdí rẹ̀ múlẹ̀
GET /v1/files/[id] Gba metadata fáìlì kan
DELETE /v1/files/[id] Pa fáìlì kan rẹ̀
GET /v1/files/[id]/content Ṣàn àkóónú ara fáìlì aise padà

Ìfàṣẹsí: API key Bearer — a máa pín àwọn fáìlì sílẹ̀ fún API key kọ̀ọ̀kan nípasẹ̀ getApiKeyRequestScope. API key kan máa rí, gba jáde, ó sì lè pa àwọn fáìlì tirẹ̀ nìkan rẹ̀; igba dashboard láìsí key máa ka gbogbo instance; fáìlì tí kò ní oní (ìgbéjáde aláìlórúkọ tàbí ìgbéjáde láti inú igba dashboard) ni a kọ̀ fún gbogbo olùpè tí kì í ṣe session. GET /v1/files máa kọ̀ olùpè aláìlórúkọ — àti key tí a gbé kalẹ̀ tí kò bá yanju — pẹ̀lú 401 kódà nígbà tí REQUIRE_API_KEY=false, dípò kí ó ṣàkójọ àwọn fáìlì gbogbo tenant (GHSA-m3hp-hq9g-fpmv, GHSA-2jm2-mpx8-6523).


API Batches

Ṣíṣe batch tó bá OpenAI mu.

Method Path Description
POST /v1/batches Ṣẹ̀dá batch — v1BatchCreateSchema ló máa fìdí body múlẹ̀ (input_file_id, endpoint, completion_window)
GET /v1/batches Ṣàkójọ àwọn batch
GET /v1/batches/[id] Gba ipò batch padà pẹ̀lú request_counts
DELETE /v1/batches/[id] Pa batch tí ó ti parí tàbí tí ó kuna rẹ̀
POST /v1/batches/[id]/cancel Fagilé batch tó wà ní ìlọsíwájú

Ìfàṣẹsí: API key Bearer. A máa pín batches sílẹ̀ fún API key kọ̀ọ̀kan labẹ òfin apá mẹ́ta kan náà bíi àwọn fáìlì: key tirẹ̀ nìkan, igba dashboard fún gbogbo instance, àwọn àkọsílẹ̀ tí owner wọn jẹ́ null ni a kọ̀ fún gbogbo olùpè tí kì í ṣe session (retrieve, delete, cancel, àti àyẹ̀wò input_file_id nígbà ìṣẹ̀dá). GET /v1/batches máa kọ̀ olùpè aláìlórúkọ pẹ̀lú 401 kódà nígbà tí REQUIRE_API_KEY=false.


API

abstraction olupese Web/search (Tavily, Brave, Exa, Serper, bbl).

Ọna Ona Apejuwe
GET /v1/search Akojọ atunto awọn olupese wiwa + awọn agbara
POST /v1/search Ṣiṣe ibeere wiwa — ara ti a fọwọsi nipasẹ v1SearchSchema, ṣe atilẹyin caching/coalescing
GET /v1/search/analytics Awọn iṣiro hit/latency/cache fun olupese

Ifọwọsi: Bọtini API ti nrù (extractApiKey + isValidApiKey). Ilana wiwa ti fi agbara mu nipasẹ enforceApiKeyPolicy.

Yan laifọwọyi: lai provider, awọn lawin olupese pẹlu a tunto asopọ nṣiṣẹ akọkọ ati awọn ti o tẹle lawin ni awọn failover. Awọn olupese ibi asegbeyin ti ọfẹ (duckduckgo-free) ni a lo nigbati ko si ohun miiran ti a tunto. SearXNG ti o gbalejo ti ara ẹni ṣe iṣiro bi atunto ni kete ti asopọ rẹ tọju baseUrl gidi kan (kii ṣe aiyipada http://localhost:8888/search katalogi): lẹhinna o wa ni ipo bi olupese $ 0 ṣaaju awọn ti a ti kọkọ, pẹlu olupese bọtini ti o rọrun julọ bi ikuna, pẹlu nigbati SearXNG dahun 400, 401, 403 tabi 404. A baseUrl ti ko ṣe URL http(s) awọsanma ti ko wulo ka. Asopọ SearXNG ti o tọju ami ami kan ni ọna yii nikan lori https:// tabi loopback http://. Lori http:// pẹtẹlẹ jijin kii ṣe ikuna ati duro ni ibi-afẹde ti o kẹhin, ti a lo nikan nigbati ko ba tunto olupese miiran tabi nigba ti o ba beere fun orukọ, nitorinaa o firanṣẹ aami ni cleartext ni awọn ọran meji yẹn.

Exa ati Tavily provider_options

Exa ati Tavily ka awọn aaye olupese kan pato lati apo ti a fi orukọ silẹ: provider_options.exa (tabi provider_options["exa-search"]) ati provider_options.tavily (tabi provider_options["tavily-search"]). Awọn bọtini ni isalẹ nikan ni a firanṣẹ siwaju. Olukuluku jẹ ayẹwo lodi si eto Zod tirẹ ni open-sse/handlers/search/providerOptionsPassthrough.ts, ati pe bọtini kan pẹlu iru aṣiṣe ti lọ silẹ. Eyikeyi bọtini miiran jẹ aibikita, pẹlu auth, ipilẹ URL, stream ati outputSchema. Awọn bọtini alapin ti a lo nipasẹ awọn olupese miiran (cx, depth, ...) ṣiṣẹ bi iṣaaju.

Olupese Awọn aaye oke-ipele iteeye
Exa type, category, userLocation, moderation, additionalQueries, objective, systemPrompt, compliance (flat primitives), startPublishedDate, endPublishedDate contents.{text, highlights, summary, extras, livecrawlTimeout, maxAgeHours} dapọ lori aiyipada { text: true, highlights: true }
Tavily 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 —

Awọn aaye jeneriki nigbagbogbo bori: query, max_results, filters (awọn ibugbe), country ati koko-ọrọ ti o jade lati search_type. Lori Exa, search_type: "news" ntọju category: "news". Tavily tun gba search_type: "finance" (topic: "finance").

Iye owo wiwa Firecrawl jẹ igbasilẹ fun bulọọki ti o bẹrẹ ti awọn abajade 10 ti o pada, ni $0.002 (awọn kirẹditi 2) bulọki kan ati pe o kere ju bulọọki kan fun ipe ( Isanwo Firecrawl ): awọn abajade 11 jẹ $0.004.

time_range jeneriki bayi de ọdọ awọn olupese mejeeji: Exa n gba startPublishedDate (ISO timestamp) ati Tavily n gba start_date (YYYY-MM-DD). Ọjọ ti o fojuhan ni provider_options dojukọ eyi ti a ya aworan.

Awọn abajade idanwo pa id, highlights (gbogbo afihan, kii ṣe ọkan akọkọ ti a lo bi snippet nikan), highlight_scores, summary, subpages, entities ati extras ni provider_raw. Awọn abajade Tavily tọju images ati favicon.

Iye owo wiwa ọna asopọ jẹ igbasilẹ ni $0.005 fun depth fast ati standard ati $0.05 fun deep ( Ifowoleri Ọna asopọ ), boya depth wa lati provider_options tabi awọn eto asopọ.

Exa type: "lite" (Exa 3.0) gba awọn aaye ti o kere ju ati kọ gbogbo ibeere nigbati eyikeyi aaye miiran ti ṣeto. Fun Lite, additionalQueries, systemPrompt ati gbogbo bọtini contents ayafi text ati highlights ti wa silẹ ṣaaju ipe naa. subpages, subpageTarget, highlights.numSentences ati highlights.highlightsPerUrl ti a ti sọ silẹ ko ni siwaju mọ.

Iṣiro iye owo jẹ iforukọsilẹ alapin costPerQuery, ayafi fun Exa, eyiti o tẹle idiyele ti ara Exa: 0.007 fun ipe fun `auto` (ati julọ `fast`) tabi 0.004 fun lite (ati aṣẹ instant), ti o bo awọn abajade 10; $ 0.001 fun abajade siwaju kọọkan; ati $0.001 fun esi pada nigbati contents.summary ti ṣeto. Tavily ti wa ni igbasilẹ ni 1 kirẹditi ($0.008) fun search_depth basic, fast ati ultra-fast, ati 2 kirediti ($0.016) fun advanced ( Tavily API kirediti ). Ipe pẹlu auto_parameters: true ti awọn iṣagbega Tavily si ilọsiwaju jẹ ṣi gbasilẹ ni kirẹditi 1.


API Ìgbàgbọ́ Wẹẹbù

Yọ́ akoonu jáde láti inú URL kan nípasẹ̀ olùpèsè ìgbàgbọ́ wẹẹbù tí a ti ṣètò (Firecrawl, Jina Reader, Tavily Extract, TinyFish Fetch, Nimble Extract, Parallel Extract).

Parallel Extract (parallel-search, API key kan náà pẹ̀lú Parallel Search) máa ń dá Markdown péré padà — format èyíkéyìí mìíràn jẹ́ 400 — ó sì máa ń dí akoonu mọ́ àwọn àkópọ̀ 100,000. Nígbà tí a kò bá lè yọ́ ojú-ìwé ibi-afẹ́de náà jáde fúnra rẹ̀, upstream máa ń fi ránṣẹ́ nínú HTTP 200; OmniRoute máa ń fi èyí hàn gẹ́gẹ́ bí 422 pẹ̀lú ìfọ̀rọ̀wérọ̀ tí a ti ṣàkópọ̀.

Ọ̀nà Ọ̀nà URL Àpèjúwe
POST /v1/web/fetch Gba/scrape URL kan — ara ìbéèrè ni v1WebFetchSchema máa ń fọwọ́sí

Ìfàṣẹsí: Bọtìnì API Bearer (extractApiKey + isValidApiKey). A máa ń mú ìlànà ṣiṣẹ́ nípasẹ̀ enforceApiKeyPolicy.

Ìpadàbọ̀nà tó mọ́ quota (#8297): nígbà tí a kò bá pèsè provider kedere, a máa ń rìn nípasẹ̀ adágún náà (firecrawl → jina-reader → tavily-search → tinyfish → nimble-search → parallel-search) ní àṣẹ ààyè pàtó (fill-first) — a máa ń fo olùpèsè tí quota rẹ̀ ti dé ààlà ṣùgbọ́n tí a ti ṣètò dípò dídá ìbéèrè náà dúró, àti àṣìṣe upstream tí ó yẹ kí a tún gbìyànjú/quota (HTTP 429 ní gbogbo ìgbà; 402/403 fún Firecrawl/Tavily/TinyFish free tier tí ó ní irú quota bẹ́ẹ̀ — kì í ṣe fún Jina Reader, bẹ́ẹ̀ sì ni kì í ṣe 400 lasán fún ìbéèrè tí kò tọ́) máa ń kọjá lọ sí ẹ̀rí ìwọlé tó ní ìwé-ẹ̀rí tí a kò tíì gbìyànjú t’ókàn ní àkókò ìbéèrè. Nígbà tí gbogbo olùpèsè inú adágún bá ti rẹ̀, endpoint náà máa ń dá 429 kan ṣoṣo padà (pẹ̀lú akọsori Retry-After) dípò 400 gbogbogbòò àtijọ́. Nígbà tí a bá béèrè fún provider kedere, kò sí ìpadàbọ̀nà ìdákẹ́jẹ — aṣìṣe olùpèsè tí a béèrè fún tàbí tí quota rẹ̀ ti dé ààlà máa ń hàn gẹ́gẹ́ bí aṣìṣe tirẹ̀ (429 tí quota bá ti dé ààlà, bí kò ṣe bẹ́ẹ̀, ipò upstream).


Ṣíṣàn WebSocket

GET /v1/ws?handshake=1

Ó máa ń fọwọ́sí ìfọwọ́wọ́ ìgbésoke WebSocket, ó sì máa ń dá àwọn àpẹẹrẹ ìfiránṣẹ́ ìlànà ìbánisọ̀rọ̀ padà (request, cancel). A máa ń bójú tó àwọn fireemu WS gidi nípasẹ̀ olùpèsè WS tí a kó sínú ètò náà, lẹ́yìn tábìlì ọ̀nà Next.js.

Ìfàṣẹsí: Bọtìnì API Bearer nígbà ìfọwọ́wọ́.

API Responses lórí WebSocket (codex nìkan)

# Orí agbàlejùmọ̀:port kan náà pẹ̀lú API HTTP (àìpẹ̀ 20128); gbé ìsopọ̀ náà ga:
wscat -c "ws://localhost:20128/v1/responses?api_key=<OMNIROUTE_API_KEY>"
# (tàbí: -H "Authorization: Bearer <OMNIROUTE_API_KEY>")

# Fireemu àkọ́kọ́ GBỌ́DỌ̀ jẹ́ response.create:
{ "type": "response.create", "model": "gpt-5.5", "input": [ { "role": "user", "content": "hi" } ] }

A ti so aṣojú Responses-API-lórí-WebSocket pọ̀ fún codex nìkan (ẹ̀yìn ChatGPT). Ó ń gbọ́ lórí port kan náà pẹ̀lú API/dashboard ní àwọn ọ̀nà /v1/responses, /responses, àti /api/v1/responses. Lórí fireemu response.create àkọ́kọ́, ó máa ń fọwọ́sí + pèsè nípasẹ̀ afárá inú codex-responses-ws, ó yan ìsopọ̀ OAuth codex kan, ó sì máa ń rán ìbánisọ̀rọ̀ lọ sí wss://chatgpt.com/backend-api/codex/responses nípasẹ̀ ìrìnàjò wreq-js. A máa ń kọ́ àwọn model tí kì í ṣe codex sílẹ̀ (codex_ws_provider_required). Fún ìtọ́sọ́nà pínpín quota, lo model: "qtSd/<group>/codex/<model>". A ti ṣe èyí nínú app/server-ws.mjs + scripts/dev/responses-ws-proxy.mjs + src/app/api/internal/codex-responses-ws/route.ts.

Ìfàṣẹsí: Bọtìnì API Bearer nígbà ìfọwọ́wọ́. Olùpèsè HTTP tí a kó sínú ètò náà (server-ws.mjs) gbọ́dọ̀ jẹ́ ibi ìbẹ̀rẹ̀ tí ń ṣiṣẹ́ (ó rí bẹ́ẹ̀ ní àìpẹ̀, nígbà tí app/server-ws.mjs bá wà).

ID model: lo ID ChatGPT tí kò ní àfikún (kò sí ìṣáájú codex/)

OpenAI Codex CLI máa ń fọwọ́sí orúkọ model ní ẹ̀gbẹ́ oníbàárà nígbà tí supports_websockets = true bá jẹ́ òtítọ́, ó sì máa ń kọ́ àwọn ID tí a fi provider sí iwájú bíi codex/gpt-5.5 (The 'codex/gpt-5.5' model is not supported when using Codex with a ChatGPT account). Rán ID tí kò ní ìṣáájú sí i (fún àpẹẹrẹ gpt-5.5). Afárá OmniRoute jẹ́ codex-nìkan, nítorí náà ó tún máa ń pinnu ID tí kò ní ìṣáájú gẹ́gẹ́ bí model codex (resolveCodexWsModelInfo) kí ó tó rán an lọ sí upstream — bó tilẹ̀ jẹ́ pé gpt-5.5 tí kò ní ìṣáájú lè máa lọ sí provider mìíràn lórí HTTP.

Ṣíṣètò OpenAI Codex CLI

Darí Codex CLI sí OmniRoute nípa fífi provider àṣà kan pẹ̀lú àtìlẹ́yìn WebSocket sí ~/.codex/config.toml (lo CODEX_HOME ọ̀tọ̀ kí o má bà a kan ìṣètò tó wà tẹ́lẹ̀):

model = "gpt-5.5"                 # ID tí kò ní ìṣáájú — KÌ Í ṢE "codex/gpt-5.5"
model_provider = "omniroute"

[model_providers.omniroute]
name = "OmniRoute (WS)"
base_url = "http://localhost:20128/v1"   # kò sí slash ní òpin; URL WS ni a máa ń yọ láti inú rẹ̀ (lo https/wss ní production)
wire_api = "responses"                    # iye tí a ń ṣe àtìlẹ́yìn fún nìkan láti Feb 2026
supports_websockets = true                # ń mú ìrìnàjò Responses-over-WS ṣiṣẹ́
env_key = "OMNIROUTE_API_KEY"             # ó ń di API key OmniRoute mú (Bearer)
export OMNIROUTE_API_KEY=sk-...           # API key OmniRoute kan (key èyíkéyìí bí REQUIRE_API_KEY=false)
codex exec "Responda apenas: PONG"

CLI máa ń gbé base_url + /responses sókè sí WebSocket, OmniRoute sì máa ń rán an lọ sí ìsopọ̀ OAuth codex tí a yàn. A ti fọwọ́sí rẹ̀ láti ìbẹ̀rẹ̀ dé òpin lórí server àdúgbò: ChatGPT máa ń dá codex.rate_limits + response.created padà, ó sì máa ń ṣàn completion náà.


Rírọ̀rùn àti Ìròyìn Àwọn Ìṣòro

Ọ̀nà Ọ̀nà URL Àlàyé
GET /v1/quotas/check Ṣàyẹ̀wò quota ṣáájú fún provider + accountId kí o tó fúnni ní kọ́kọ́rọ́ tí a forúkọsílẹ̀
POST /v1/issues/report Ròyìn ìkùnà fífúnni ní quota/kọ́kọ́rọ́ sí GitHub (ó nílò GITHUB_ISSUES_REPO + token)

Ìfọwọ́sí: Kọ́kọ́rọ́ API Bearer (isAuthenticated).

Ìmúpadà ìgbà quota (aṣàyàn)

Àìṣàn POST /v1/chat/completions tàbí POST /v1/responses tí ó bá kùnà pẹ̀lú àṣìṣe quota tó parí (402/429/503 tí ara rẹ̀ bá sọ pé quota tàbí credits ti tán) le dúró kí a sì tún ṣe é lẹ́yìn díẹ̀ dípò kí a dá àṣìṣe náà padà. Olùpè yan èyí fún ìbéèrè kọ̀ọ̀kan pẹ̀lú àwọn akọsori mẹ́ta:

Akọsori Iye
x-omniroute-quota-recovery auto
x-omniroute-session ID ìgbà, [A-Za-z0-9._:-]{1,128}
x-omniroute-recovery-turn ID ìyípo tó yàtọ̀ láàárín ìgbà náà (òfin kan náà)

Àwọn ìyípo stream: false nìkan tí kò ní àwọn irinṣẹ́, ìtàn irinṣẹ́ tàbí previous_response_id, tí kò sì ní pin x-omniroute-connection, ni ó yẹ fún èyí, àti pé a gbọ́dọ̀ ti ṣètò STORAGE_ENCRYPTION_KEY (a máa fi ìbéèrè náà pamọ́ ní ìpamọ́ fún títí dé wákàtí 24). Ìdáhùn náà yóò jẹ́ 202 pẹ̀lú recovery.poll; ṣe ìwádìí pẹ̀lú GET /v1/quota-recoveries/{id} (202 nígbà tí ó ń dúró, 200 pẹ̀lú ara ìdáhùn tí a gba padà nígbà tí ó bá parí) tàbí fagilé pẹ̀lú DELETE. Kìkì kọ́kọ́rọ́ API tí ó dá àwọn tikẹ́ẹ̀tì sílẹ̀ ni ó lè rí wọn. Títún-ṣiṣẹ́ tí àbájáde rẹ̀ kò dájú máa parí ní needs_confirmation dípò kí a fi ránṣẹ́ lẹ́ẹ̀mejì. Orísun: src/lib/quota/quotaSessionRecovery.ts.


Lilo iṣẹ-ara ẹni (/api/usage/om-usage)

Eyikeyi bọtini API le ka** tirẹ** lilo ati awọn ipin — ko si isakoso auth. Eyi ni aaye ipari ti alabara kan (CLI, nronu OmniCopilot ) nlo lati ṣafihan dimu bọtini kan inawo wọn.

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

Awọn bọtini gbọdọ ni**allowUsageCommand** ṣiṣẹ (pa nipasẹ aiyipada — oluṣakoso bọtini API ti dasibodu yi pada fun bọtini kan). Laisi rẹ ojuami ipari awọn idahun 403.

?format=json da apẹrẹ iyasoto pada ki olupe ko ka aaye data kan kuro ni aigba. Lori aṣeyọri:

{
  "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" /* … */ },
  ],
}

Lori aigba (bọtini 401 buburu / 403 ko gba laaye) ipa ọna kanna pada { "allowed": false, "error": { "message": "…" } } — a bayi-ṣugbọn-ṣofo personal/provider (bọtini ti a gba laaye, ko si ohun ti a kọ sibẹsibẹ) jẹ ipo ti o yatọ si aigba, ati pe fọọmu JSON nikan ni o ṣe iyatọ wọn.

Ifọwọsi: Bọtini API ti olupe ti ara rẹ, ti a fọwọsi pẹlu isValidApiKey — eyi ni not dada isakoso (/api/keys/…), eyiti o duro lẹhin requireManagementAuth.

Aise vs. Cutoff-Titunse Quota ogorun

Nigbati o ba n gba /api/usage/om-usage, awọn olupe yẹ ki o ṣe akiyesi iyatọ laarin awọn ipin ogorun ti a gbekalẹ nipasẹ awọn** itele ti ọrọ jade** ati awọn ti eletoJSON igbejade :

Abala Ọna kika ọrọ pẹtẹlẹ (/api/usage/om-usage / @@om-usage) ọna kika JSON (?format=json)
Aaye ijade NN% left (fun apẹẹrẹ, 20% left) provider.quotas / providers[].quotas
Wiwọn Iyọnda ohun elo ti a ṣatunṣe gige : ti o ku agbara loke awọn cutoff ala Aise ni oke ipin : wiwọn olupese ti ko ni atunṣe
Irẹjẹ gige Ti iwọn nipasẹ effectiveRemainingPercent() nitorina ibi ipamọ ti o ni aabo ka bi 0% left Ko si (awọn iye aworan aworan aise bi olupese ṣe royin)
Data ala Ti dapọ si ipin ogorun ti o han Ti fipamọ sinu quotaWindowThresholds fun asopọ (tabi awọn aṣiṣe olupin)
Olumulo akọkọ Ibanisọrọ CLIs, awọn ebute ebute, awọn oniṣẹ eniyan Awọn iṣọpọ eto, dashboards, atupale, awọn olutọpa ìdíyelé

Agbekalẹ Atunṣe gige gige

OmniRoute ṣe atilẹyin awọn gige ipin ti o n ṣiṣẹ lọwọ lati ṣe idiwọ irẹwẹsi oke (ti a tunto nipasẹ asopọ quotaWindowThresholds, awọn aṣiṣe olupese, tabi awọn eto imupadabọ agbaye). Nigbati ẹnu-ọna gige kan (fun apẹẹrẹ, cutoff = 25%) nṣiṣẹ lori ferese ipin kan, oluṣe ọrọ naa ṣe iṣiro awọn iyọọda ti o ku bi:

  • Ti remaining <= cutoff: pada 0%.
  • Ti remaining > cutoff: pada ((remaining - cutoff) / (100 - cutoff)) * 100.

Iṣagbejade ọrọ ti a ṣe pa akoonu yika eyi si nomba to sunmọ (Math.round(...)).

Apeere Apejuwe

Wo window olupese kan pẹlu** 60% aise lilo** (nitorinaa** 40% aise ti o ku ipin** ) ati ki o kan tunto** 25% ti o ku-ipin gige** ala:

Aṣoju Iṣiro Ti o ku Itumọ Lo
Aise JSON (?format=json) Aworan ti oke (quotas[window]) 40% 60%
Ọna kika ọrọ (NN% left) ((40 - 25) / (100 - 25)) * 100 = (15 / 75) * 100 20% 80% (ti o ba ṣe iṣiro 100 - remaining)
  • Kini idi ti ọrọ fi han 20% osi: Ninu ipin 40% ti ara ti o ku lori akọọlẹ, 25% wa ni ipamọ nipasẹ eto imulo gige. Olupe naa ni 15% nikan ninu 75% ori yara lilo ti o ku ṣaaju ki olulana naa dẹkun lilọ kiri si asopọ yii. Iwọn wiwọn ṣe idaniloju irẹwẹsi awọn ifihan agbara asopọ (0% left) ni deede nigbati ipa-ọna yoo dẹkun.
  • Kini idi ti JSON ṣe itọju awọn iye aise: Ẹru isanwo JSON pada aworan aworan olupese gangan (UsageSnapshot) nitorinaa awọn irinṣẹ ita ni iwọle si ilẹ-otitọ iṣamulo oke ati ipele asopọ quotaWindowThresholds laisi igbelowọn ipadanu ẹgbẹ olupin.

Olumulo Migration Itọsọna

Ti iṣọpọ ita (gẹgẹbi ohun itanna olootu tabi itẹsiwaju aṣoju) ṣaju ọrọ ipari ọrọ tẹlẹ (NN% left) ati ṣe iṣiro ipin ti a lo bi 100 - NN, gbigbe si ?format=json tumọ si:

  • Kika awọn iye JSON aise yoo ṣe afihan** agbara oke gangan** (60% lo ninu apẹẹrẹ loke).
  • Ti irẹpọ ba fẹ lati tọju awọn itumọ-iyọọda-iyọọda ohun elo ti ipari ọrọ, o le ṣe iṣiro imunadoko agbekalẹ ti o ku ni ẹgbẹ-ẹgbẹ nipa lilo quotaWindowThresholds fun awọn ipalọlọ ipele-isopọ.

Kaṣi Semántíkì

# Gba àwọn ìṣirò kaṣi
GET /api/cache/stats

# Pa gbogbo àwọn kaṣi rẹ́
DELETE /api/cache/stats

Àpẹẹrẹ ìdáhùn:

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

Ipa lórí àkókò ìdáhùn

Semantic cache HIT ń pèsè ìdáhùn láti inú kaṣi láìsí ìpè upstream, nítorí náà X-OmniRoute-Response-Latency tí a ròyìn máa ń sún mọ́ òdo (kódà láìka àkókò ìdáhùn upstream ìpilẹ̀ṣẹ̀ sí). Àwọn oníbàárà tí àkókò ìdáhùn ṣe pàtàkì sí (benchmarking, àbójútó p50/p99) yẹ kí wọ́n ṣàyẹ̀wò àkọsílẹ̀ ìdáhùn X-OmniRoute-Cache-Latency:

Value Meaning
synthetic Ìdáhùn tí a pèsè láti inú kaṣi; àkókò ìdáhùn kì í ṣe àkókò upstream gidi
(absent) Ìdáhùn láti inú ìpè upstream gidi

Yíyí kaṣi kọjá fún kọ́kọ́rọ́ kọ̀ọ̀kan

Àwọn kọ́kọ́rọ́ API lè yàn láti má ka semantic cache nípasẹ̀ cacheDefaultMode:

Value Behavior
legacy Ìhùwàsí kaṣi déédéé (àiyípadà àkọ́kọ́)
bypass Foju kọ́ wíwo kaṣi pátápátá; máa kan upstream ní gbogbo ìgbà

Ṣètò èyí nígbà tí a bá ń ṣẹ̀dá kọ́kọ́rọ́ (POST /api/keys) tàbí tí a bá ń ṣe àtúnṣe rẹ̀ (PATCH /api/keys/[id]):

{ "cacheDefaultMode": "bypass" }

Yíyí kaṣi kọjá fún ìbéèrè kọ̀ọ̀kan

Ìbéèrè èyíkéyìí lè foju kọ́ kaṣi láìka àwọn ìṣètò kọ́kọ́rọ́ sí:

X-OmniRoute-No-Cache: true

Ìbámu Ìṣàkóso CLIProxyAPI

OmniRoute ń dáhùn sí àwọn endpoint ìṣàkóso mẹ́ta ti CLIProxyAPI tí àwọn dashboard ìlò ń pè láti ka àwọn ààlà ìforúkọsílẹ̀ Claude àti Codex (fún àpẹẹrẹ, orísun ààlà ìlò cliproxy ti T3 Code). Tọ́kasí URL ìpilẹ̀ṣẹ̀ oníbàárà sí OmniRoute, kí o sì lo kọ́kọ́rọ́ API kan tí ó ní scope manage gẹ́gẹ́ bí kọ́kọ́rọ́ ìṣàkóso rẹ. Àwọn ọ̀nà náà wà ní /v0/management/* àti ní /api/v0/management/*.

Method Path Description
GET /v0/management/auth-files Àwọn ìsopọ̀ OAuth Claude àti Codex gẹ́gẹ́ bí { files: [{ id, auth_index, provider, email, disabled, id_token }] }. Kò ní àwọn token
POST /v0/management/api-call Ara { auth_index, method, url, header?, data? }. Ó ń rán ìbéèrè kan tí a fọwọ́ sí pẹ̀lú token àkọọ́lẹ̀ náà, ó sì dá { status_code, body } padà
POST /v0/management/reset-quota Ara { auth_index }. Ó ń pa àkókò ìtútù ìsopọ̀, ìdènà model àti àwọn àkókò ìtútù Codex fún scope kọ̀ọ̀kan ti àkọọ́lẹ̀ kan rẹ́
  • auth_index ni ID ìsopọ̀ OmniRoute. provider jẹ́ claude tàbí codex (àwọn ìsopọ̀ OAuth nìkan; a kò ṣe àfihàn provider kọ́kọ́rọ́ API anthropic). Fún Codex, id_token.chatgpt_account_id ni ID workspace tí a pamọ́, plan_type sì ni ètò tí a pamọ́.
  • api-call kì í ṣe proxy gbogbogbòò. Ó gba Claude GET https://api.anthropic.com/api/oauth/usage àti Codex GET https://chatgpt.com/backend-api/wham/usage, GET .../wham/rate-limit-reset-credits àti POST .../wham/rate-limit-reset-credits/consume nìkan, ọ̀kọ̀ọ̀kan sì jẹ́ fún àkọọ́lẹ̀ provider tó bá mu. Ohun mìíràn yóò dá 403 padà láì kàn sí upstream. A kọ́bi sí àkọsílẹ̀ Authorization olùpè (pẹ̀lú placeholder $TOKEN$); OmniRoute máa ń fi access token ìsopọ̀ náà sínú rẹ̀, ó sì máa ń tún un ṣe ní àkọ́kọ́ nígbà tí ó bá fẹ́rẹ̀ẹ́ parí, ó sì ń fi àwọn àkọsílẹ̀ tí a fọwọ́ sí nìkan ránṣẹ́ (anthropic-beta; OpenAI-Beta, Originator, Chatgpt-Account-Id; Accept, Content-Type). Bí Chatgpt-Account-Id bá sọnù, workspace ID tí a pamọ́ ni a máa lò. Àwọn ìbéèrè máa ń parí lẹ́yìn ìṣẹ́jú àá mẹ́ẹ̀ẹ́dógún, wọ́n sì máa ń lo proxy ìsopọ̀ náà.
  • reset-quota máa ń fi àwọn ipò ìkẹyìn (banned, expired, credits_exhausted) sílẹ̀. auth_index tí a kò mọ̀ yóò dá 404 padà.

Ìfàṣẹsí: session dashboard tàbí kọ́kọ́rọ́ API tí ó ní scope manage, èyí tó ṣe pàtàkì kódà nígbà tí a bá pa ìwọlé mọ́ (àwọn ọ̀nà náà wà nínú ALWAYS_PROTECTED_API_PATHS). Àwọn kọ́kọ́rọ́ tí inference nìkan jẹ́ fún yóò gba 403. Orísun: src/lib/cliproxyCompat/managementApi.ts.


Dasibodu & Isakoso

Awọn ipa ọna iṣakoso (/api/* ayafi auth/login ti gbogbo eniyan) jẹ** kii ṣe** ti a fun ni aṣẹ nipasẹ awọn bọtini API itọkasi lasan. Awọn idile ijẹrisi, awọn aaye, ati awọn apẹẹrẹ curl: Ijeri iṣakoso.

Ijeri

Opin ojuami Ọna Apejuwe
/api/auth/login POST Wo ile
/api/auth/logout POST Jade jade
/api/settings/require-login GET/POST Ipo wiwọle (GET, gbogbo eniyan). POST ṣeto ọrọ igbaniwọle / yiyi iwọle: oniṣẹ ẹrọ-nikan ni kete ti ọrọ igbaniwọle kan wa (akoko dasibodu, CLI agbegbe, tabi iwọle alaabo awọn bọtini — API ati awọn ami oma_ gba 403); igba dasibodu kan ran currentPassword lati rọpo ọrọ igbaniwọle

Isakoso Olupese

Opin ojuami Ọna Apejuwe
/api/providers GET/POST Akojọ / ṣẹda awọn olupese
/api/providers/[id] GET/PUT/DELETE Ṣakoso awọn olupese
/api/providers/[id]/test POST Igbeyewo asopọ olupese
/api/providers/[id]/models GET Akojọ olupese si dede
/api/providers/validate POST Soto olupese olupese
/api/providers/bulk POST Ṣafikun awọn bọtini API fun olupese ONE
/api/providers/import POST Ṣe agbewọle LIST olupese oniruuru lati inu faili CSV/JSON ti a ti ṣe itupalẹ (#6836); fun kana-apakan-ikuna esi
/api/provider-nodes* Orisirisi Olupese ipade isakoso
/api/provider-models GET/POST/PUT/PATCH/DELETE Awọn awoṣe aṣa ati awọn ifasilẹ fun awoṣe kọọkan (fikun, imudojuiwọn, hide/show, paarẹ)
/api/provider-models/validate-and-add POST Isakoso-ifọwọsi, ijade-afọwọsi-asopọ ti o muna ati iforukọsilẹ aṣa-awoṣe atomiki; wo Awoṣe afọwọsi

Fun awọn awoṣe synced/imported, PUT /api/provider-models gba provider, modelId, ati maxOutputTokenOverride: odidi rere kan ṣeto fila-ifihan afọwọṣe, ati null ko o lati mu pada aiyipada. GET /api/provider-models?provider=<provider> da awọn iye wọnyi pada ni modelOutputOverrides, pẹlu awọn awoṣe laisi ila-aṣa awoṣe. Ifiweranṣẹ naa nlo agbara asiko-ṣiṣe max_output_tokens ati pe o yege awoṣe tun-ṣiṣẹpọ. Oju-iwe olupese ibaramu OpenAI nfunni ni awọn idari edit/clear kanna ati awọn ami si awọn awoṣe pẹlu atilẹyin iran ti o fojuhan.

Lori ipade olupese ibaramu, awọn ọna kikọ (POST, PUT, PATCH, DELETE ati /api/provider-models/validate-and-add) tọju id awoṣe bi id ti oke oke: id ti o lẹẹmọ lati atokọ iṣaaju ni akopọ eyikeyi asiwaju ti ami-ipele ti ara ti oju ipade, ati awọn idahun ṣe iwoyi id ti o fipamọ. Awọn ids idinku ti awọn olupese Canonical (fun apẹẹrẹ nvidia/nemotron-…) ti wa ni ipamọ lọrọ ẹnu. /v1/models ko jade ni tolera <prefix>/<prefix>/<model> id.

Awọn apa Iwiregbe Aṣa Aṣa ṣe deede awọn ijade ero-ọrọ ti o fojuhan si ẹhin oke. Idanwo asopọ ti o ṣaṣeyọri yoo yan awọn iṣakoso iwiregbe-awoṣe laifọwọyi fun awoṣe deede ID kọọkan ti titẹsi /models ṣe afihan iye owned_by ti a mọ: vllm, sglang, tabi llamacpp. Sihin OpenAI-ibaramu wrappers le se itoju awọn atilẹba titẹsi awoṣe inu kan itẹ-ẹiyẹ openai ohun; erin wọnyi soke si meta iru envelopes. Awọn awoṣe pẹlu sonu, aimọ, tabi nini rogbodiyan tọju ihuwasi OpenAI lasan. Wiwa tun lo ibeere katalogi ti o wa tẹlẹ, ṣe ipilẹṣẹ ko si awọn ami ipari, ati pe o jẹ asan nigbati aaye ipari asopọ ba yipada.

Lati pin ihuwasi naa fun ẹhin ti ko ṣe afihan metadata yẹn, lo imudojuiwọn apa kan olupese API:

{
  "providerSpecificData": {
    "reasoningControl": "chat-template"
  }
}

Firanṣẹ ara yẹn pẹlu PUT /api/providers/<connection-id>. Lori asopọ yẹn, igbiyanju ironu ti o fojuhan ti none ni a firanṣẹ bi chat_template_kwargs.thinking=false ati chat_template_kwargs.enable_thinking=false. Awọn iye awoṣe abinibi ti o fojuhan wa ni aṣẹ ayafi ti ofin ero ẹgbẹ olupin fi ipa mu akitiyan kan. Eto naa kan nikan nigbati asopọ ibaramu OpenAI aṣa kan firanṣẹ ara Awọn ipari iwiregbe; Awọn ibeere idahun ati awọn olupese lasan tọju apẹrẹ ibeere abinibi wọn. Ṣeto reasoningControl si openai lati fi ipa mu ọna gbigbe OpenAI reasoning_effort lasan, tabi fi it/set silẹ si null lati lo wiwa aifọwọyi.

Claude Code classifier-mode auto awọn ibeere ironu abinibi aiyipada si alaabo nigba ti wọn ko ni awọn idari ero ero gbangba ninu. Iwari nlo aami eto classifier ni awọn ibeere ọna kika Claude, kii ṣe awọn orukọ awoṣe tabi awọn opin ipari. Awọn iṣakoso ara ti o han gbangba, awọn akọsori effort/thinking ti o ṣe atilẹyin, awọn ofin ipa-ọna, ati igbiyanju awoṣe ti o yanju jẹ ki o jẹ pataki wọn tẹlẹ. Awọn ipele ikawe mejeeji ni idaduro awọn itọsi wọn, awọn opin ipari, awọn ilana iduro, ati awọn idajo igbanilaaye oke gidi; ipele keji tun le gbe awọn ero ti o han ti o beere bi ọrọ lasan.

OAuth Awọn ṣiṣan

Opin ojuami Ọna Apejuwe
/api/oauth/[provider]/[action] Orisirisi Olupese-pato OAuth

Ipa ọna & Iṣeto

Opin ojuami Ọna Apejuwe
/api/models GET/PUT Awoṣe akojọ / inagijẹ imudojuiwọn
/api/models/alias GET/POST Awọn inagijẹ awoṣe
/api/models/catalog GET Gbogbo awọn awoṣe nipasẹ olupese + iru
/api/combos* Orisirisi Konbo isakoso
/api/keys* Orisirisi API isakoso bọtini
/api/pricing GET Ifowoleri awoṣe

Awoṣe iye to provenance

GET /api/models?withLimits=1 (bakannaa true; 0/false tabi yiyọ kuro o tọju fifuye isanwo aiyipada ko yipada) ṣafikun contextWindow, maxInputTokens, maxOutputTokens ati ohun capsSource si gbogbo ila awoṣe. capsSource lorukọ ofin ti o pese opin kọọkan, nitorinaa opin iyalẹnu kan (fun apẹẹrẹ 128k lori awoṣe 1M) ni a le tọpa si ipilẹṣẹ rẹ. Awọn iye ipinnu jẹ kanna awọn ipawo ipa-ọna; Flag nikan ṣe afikun awọn aaye ati pe ko yipada iye kan. Eyikeyi iye withLimits miiran jẹ kọ pẹlu 400.

capsSource iye Ipilẹṣẹ
override:context Iyipada ọrọ-ọrọ ti o duro duro-fẹẹfẹlẹ (model_context_overrides)
override:max_input / override:max_output Iduroṣinṣin max_input_tokens / max_output_tokens agbara idojuk
static-authoritative:<provider>/<model> Aimi alaṣẹ ayika-window tabili
synced:<provider>/<model> modeld.dev synced agbara kana
registry:<provider>/<model> Titẹ sii iforukọsilẹ olupese
spec:<model> Aimi awoṣe spec
effort-base: ìpele Kana yiya lati ipilẹ awoṣe ti ẹya akitiyan-suffixed iyatọ
none Ko si orisun ti o sọ opin (iye jẹ null)

Imuse: getResolvedModelCapabilitiesWithLimitSources() ni src/lib/modelCapabilities.ts ati awọn ẹwọn iṣaaju ni src/lib/modelCapabilityLimits.ts.

Lilo & Atupale

Opin ojuami Ọna Apejuwe
/api/usage/history GET Itan lilo
/api/usage/logs GET Awọn akọọlẹ lilo
/api/usage/request-logs GET Awọn akọọlẹ ipele-ibeere
/api/usage/[connectionId] GET Lilo-asopọmọra
/api/usage/token-limits GET/POST/DELETE Per-API-bọtini àmi-isuna-iye
/api/usage/model-latency-stats GET Yiyi per-provider/model lairi apapọ (avg/p50/p95/p99, oṣuwọn aṣeyọri); Ajọ: windowHours/minSamples/maxRows/provider/model (#6873)
/api/usage/cache-health GET Lakotan kaṣe-kiakia ilera lori ipin call_logs — write/read, pinpin iwọn-kikọ p50/p90/p99, ifọkansi-kikọ wuwo, pipin-awoṣe, ati idajọ healthy/degraded/thrash/no-data ; ibeere params range (1h| 24h| 7d| 30d, aiyipada 24h) ati model iyan (#8827)

awọn igbanilaaye bọtini API

PATCH /api/keys/{id} ṣe imudojuiwọn awọn igbanilaaye bọtini ti o wa tẹlẹ. Bii gbogbo ọna /api/keys* o nilo aṣẹ iṣakoso (wo Ijeri Isakoso ), kii ṣe bọtini itọka. Firanṣẹ nikan awọn aaye ti o fẹ yipada; ibeere pẹlu ko si ọkan ninu wọn ti a kọ pẹlu No valid fields to update. Awọn aaye ti o gba jẹ asọye nipasẹ updateKeyPermissionsSchema ni src/shared/validation/schemas/keys.ts.

Aaye Iru Awọn akọsilẹ
name okun, 1-200 chars
isActive boolianu
isBanned boolianu
expiresAt ISO 8601 datetime tabi null null nso ipari
modelAccessMode all | restricted allowedModels gbọdọ jẹ ofo nigbati ipo ba jẹ all
allowedModels, blockedModels opo ti awọn okun, to 1000
allowedCombos orisirisi awọn okun, to 500 Gates eyi ti combos bọtini le pe; Awọn awoṣe taara jẹ iṣakoso nipasẹ modelAccessMode / allowedModels
connectionAccessMode all | restricted allowedConnections gbọdọ jẹ ti ko ṣofo nigbati restricted ati ofo nigbati all
allowedConnections titobi UUIDs, to 100
allowAutoCombos boolianu false kọ awọn ibeere fun awọn awoṣe auto/* pẹlu bọtini yii; awọn bọtini ti o ko ṣeto ti wa ni laaye
catalogScope all | combos | models Kini awọn atokọ GET /v1/models fun bọtini yii (combos nikan, awọn awoṣe nikan, tabi mejeeji); ko yi ohun ti bọtini le pe
forcedModel okun to 300 chars, tabi null Awọn ibeere iwiregbe awọn ọna si model/combo yii, lori X-Route-Model ati body.model; awọn ifilelẹ ti awọn bọtini si tun waye
noLog, autoResolve boolianu
throttleDelayMs odidi, 0-300000
maxSessions odidi, 0-10000
rateLimits titobi { limit, window } (odidi rere, to 50) tabi null null nso awọn ifilelẹ
accessSchedule iṣeto ohun tabi null null nso iṣeto
scopes ọpọlọpọ awọn okun, to 32
allowedEndpoints orisirisi awọn okun, to 20
streamDefaultMode legacy | json
cacheDefaultMode legacy | bypass Wo Per-bọtini kaṣe fori
compressionEnabled boolianu
codexServiceMode ọkan ninu awọn ipo iṣẹ Codex
disableNonPublicModels boolianu
allowUsageCommand boolianu
usageLimitEnabled boolianu
dailyUsageLimitUsd, weeklyUsageLimitUsd nọmba >= 0 tabi null
fiveHourUsageLimitUsd nọmba >= 0 tabi null Isuna USD wakati 5 yiyi, ti fi agbara mu bi awọn opin ojoojumọ ati osẹ (usageLimitEnabled, UNPRICED_USAGE_BUDGET_POLICY). retry-after jẹ nigbati inawo ti o dagba julọ ni window ti pari, eyiti o le fi bọtini kan silẹ ti o jinna lori opin rẹ tun dina.
chaosModeEnabled boolianu
curl -X PATCH "$OMNIROUTE_URL/api/keys/$KEY_ID" \
  -H "Authorization: Bearer <management-credential>" \
  -H "Content-Type: application/json" \
  -d '{ "allowAutoCombos": false, "catalogScope": "combos" }'

Eto

Opin ojuami Ọna Apejuwe
/api/settings GET/PUT/PATCH Awọn eto gbogbogbo. Awọn bọtini aabo-eto imulo (requireLogin, newPassword, oidc*, corsOrigins, bruteForceProtection) nilo currentPassword ati awọn bọtini ijẹrisi — API oniṣẹ ati awọn ami oma_ gba 403; gbogbo iyipada nilo aaye-iwọle admin
/api/settings/proxy GET/PUT Aṣoju nẹtiwọki nẹtiwọki
/api/settings/proxy/test POST Idanwo asopo aṣoju
/api/settings/ip-filter GET/PUT IP allowlist/blocklist
/api/settings/thinking-budget GET/PUT Thinking/reasoning** ìbéèrè** atunkọ mode (passthrough / auto-rinho / aṣa / aṣamubadọgba). Ominira ti funmorawon. Wo THINKING_BUDGET.md.
/api/settings/system-prompt GET/PUT Lagbaye eto tọ
/api/settings/compression GET/PUT Agbaye funmorawon konfigi
/api/settings/purge-request-history POST Ko awọn ori ila iwe ibeere ati awọn ohun-ọṣọ ipe-ipe agbegbe kuro

Atokọ & Funmorawon

Opin ojuami Ọna Apejuwe
/api/compression/preview POST Awotẹlẹ off/lite/standard/aggressive/ultra/RTK/stacked funmorawon
/api/compression/language-packs GET Ṣe atokọ awọn akopọ ede Caveman ti o wa
/api/compression/rules GET Akojọ Caveman ofin metadata
/api/context/caveman/config GET/PUT Caveman-pato eto inagijẹ
/api/context/rtk/config GET/PUT Awọn eto pato-RTK, pẹlu awọn asẹ aṣa ati idaduro aise-jade
/api/context/rtk/filters GET Katalogi àlẹmọ RTK ati awọn iwadii àlẹmọ aṣa
/api/context/rtk/test POST Ṣiṣe RTK preview/test lodi si fifuye ọrọ kan
/api/context/rtk/raw-output/[id] GET Ka ni idaduro redacted aise isejade nipa ijuboluwole id
/api/context/combos GET/POST Funmorawon konbo list/create
/api/context/combos/[id] GET/PUT/DELETE Funmorawon konbo detail/update/delete
/api/context/combos/[id]/assignments GET/PUT Fi awọn combos funmorawon si ipa ọna combos
/api/context/analytics GET funmorawon atupale inagijẹ

Abojuto

Opin ojuami Ọna Apejuwe
/api/sessions GET Titele igba ti nṣiṣe lọwọ
/api/rate-limits GET Fun-iroyin oṣuwọn ifilelẹ
/api/monitoring/health GET Ayẹwo ilera + akopọ olupese (catalogCount, configuredCount, activeCount, monitoredCount). Wiwo iṣakoso pẹlu credentialHealth: scalars-cache, failedConnections nigbati failed>0, ati staleDbNonOkCount (SQLite alalepo test_status, kii ṣe iwọn). Wo MONITORING_GUIDE.md.
/api/cache/stats GET/DELETE Kaṣe iṣiro / ko o
/api/modality-bridge/stats GET attempts ninu iranti, awọn aṣeyọri/bridged, awọn ikuna, awọn deba kaṣe, totalLatencyMs, latencySamples, averageLatencyMs ti a sọ fun apẹẹrẹ, ati akoko lilo to kẹhin (tun bẹrẹ bẹrẹ; auth iṣakoso)
/api/modality-bridge/video/runtime GET Ayẹwo igbẹkẹle-loopback ti o muna ṣaaju iṣakoso auth/probe; wiwa FFmpeg/ffprobe ti a sọ di mimọ ati awọn ẹya (ko si ile itaja)
/api/modality-bridge/video/extract POST Ti abẹnu tito gbẹkẹle-loopback alagbata baiti; 50 MiB igbewọle, didi queue/32 MiB àbájade, agbara 503, 499 asopọ, akoko ipari 504 ; ko kan àkọsílẹ po API

Fidio fireemu lu-mọlẹ

GET /api/v1/video-bridge/drilldown ka ọwọ akomo ti agbatọju ti o da pada ni x-omniroute-video-drilldown lẹhin ti o ti gba ibeere Afara Fidio ni gbangba. Mejeeji kika ati DELETE nigbagbogbo nilo bọtini API to wulo ati igbanilaaye modalityBridgeVideoDrilldownRemoteEnabled ominira oniṣẹ. Idaduro iṣelọpọ ni afikun nilo modalityBridgeVideoDrilldownEnabled ati ti o muna fun apakan drilldown: true. Ti bọtini ba ni atokọ aaye ipari asan, o gbọdọ pẹlu video fun mejeeji GET ati DELETE, boya olupe naa nlo /v1 tabi /api/v1.

ibeere GET : beere handle; variant iyan (preview, standard, detail), limit (1–8; ogún frames jẹ itẹwọgba ṣugbọn a ko le ṣe idapo pelu limit), page orisun-odo, ati start/end iṣẹju-aaya. Nigbati a ba pese awọn opin idojukọ mejeeji, end gbọdọ tobi ju start lọ. Awọn bọtini ibeere Duplicate/unknown jẹ kọ. Awọn idahun to ṣaṣeyọri ni derivation, durationSeconds, frames, hasMore, page, variant, ati focusWindow iyan; ko si-itaja JSON ti wa ni capped ni 32 MiB pẹlu Base64. Ijade ti o tobi ju pada 413; beere diẹ awọn fireemu.

DELETE /api/v1/video-bridge/drilldown?handle=... pada { "removed": 0|1 }. Aimọ, ipari ati bọtini agbelebu GETs jẹ awọn idahun 404 ko ṣe iyatọ; bọtini agbelebu DELETE ko le yọ iwọle ti eni kuro. Alaabo wiwọle pada 403, missing/invalid ìfàṣẹsí 401, invalid ibeere 400, ifagile 499 ati ibùgbé aṣiṣe 503. Kapa ni o wa ilana-agbegbe, pari lẹhin iṣẹju mẹwa, ati ki o ko ye a tun bẹrẹ. New kapa lo v1. plus a 32-baiti ID Base64URL àmi; nikan hashes àmi ti wa ni idaduro. Legacy 64-hex àmi wa syntactically ṣeékà fun ibamu. Wo Awọn ọna opopona fidio Afara fun igbanilaaye, awọn ipin ati awọn alaye itọsẹ iyatọ.

Afẹyinti & Export/Import

Opin ojuami Ọna Apejuwe
/api/db-backups GET Akojọ awọn afẹyinti to wa
/api/db-backups PUT Ṣẹda afẹyinti afọwọṣe
/api/db-backups POST Mu pada lati kan pato afẹyinti
/api/db-backups PATCH Ṣafipamọ awọn eto idaduro afẹyinti (oṣiṣẹ-nikan)
/api/db-backups DELETE Pire awọn ifipamọ ti o fipamọ si awọn eto idaduro (oṣiṣẹ-nikan)
/api/db-backups/export GET Ṣe igbasilẹ ibi ipamọ data bi faili .sqlite
/api/db-backups/import POST Ṣe ìrùsókè .sqlite fáìlì láti rọ́pò ibùdó dátà (?dryRun=true jẹ́rìí sí nìkan)
/api/db-backups/exportAll GET Ṣe igbasilẹ afẹyinti ni kikun bi ibi ipamọ .tar.gz

/api/db-backups/export, /api/db-backups/exportAll ati /api/settings/export-json fi gbogbo iwe-ẹri ti o fipamọ silẹ, nitorinaa wọn nilo igba dasibodu tabi CLI agbegbe (tabi alaabo wiwọle). awọn bọtini API ti iwọn eyikeyi ati awọn ami iraye si oma_ gba 403. Awọn imupadabọ mu aala kanna mu: POST /api/db-backups/import (pẹlu dryRun=true ), POST /api/db-backups (pada sipo nipasẹ id) ati POST /api/settings/import-json rọpo aaye data laaye tabi awọn eto, nitorinaa ẹri ẹrọ kan gba 403 nibẹ paapaa; omniroute sync import fi iwe-ẹri CLI agbegbe ranṣẹ. Nitorina ṣe DELETE /api/db-backups (awọn ipamọ ti o fipamọpamọ piruni) ati PATCH /api/db-backups (awọn eto idaduro: awọn iye ti o duro ni o wakọ pruning laifọwọyi lẹhin gbogbo afẹyinti). Kikojọ (GET) ati ṣiṣẹda afẹyinti afọwọṣe (PUT) tọju auth iṣakoso lasan.

Awọsanma Sync

Opin ojuami Ọna Apejuwe
/api/sync/cloud Orisirisi Awọn iṣẹ amuṣiṣẹpọ awọsanma
/api/sync/initialize POST Bibẹrẹ imuṣiṣẹpọ
/api/cloud/* Orisirisi Awọsanma isakoso

Tunnels

Opin ojuami Ọna Apejuwe
/api/tunnels/cloudflared GET Ka ipo Cloudflare Tunnel Quick install/runtime fun dasibodu naa
/api/tunnels/cloudflared POST Mu ṣiṣẹ tabi mu Eefin Yiyara Cloudflare ṣiṣẹ (action=enable/disable)
/api/tunnels/ngrok GET Ka ipo asiko asiko ngrok Tunnel fun dasibodu naa
/api/tunnels/ngrok POST Mu ṣiṣẹ tabi mu Eefin ngrok ṣiṣẹ (action=enable/disable)

CLI Awọn irinṣẹ

Opin ojuami Ọna Apejuwe
/api/cli-tools/claude-settings GET Claude CLI ipo
/api/cli-tools/codex-settings GET Codex CLI ipo
/api/cli-tools/droid-settings GET Duroidi CLI ipo
/api/cli-tools/openclaw-settings GET OpenClaw CLI ipo
/api/cli-tools/runtime/[toolId] GET Generic CLI asiko isise

awọn idahun CLI pẹlu: installed, runnable, command, commandPath, runtimeMode, reason.

ACP Awọn aṣoju

Opin ojuami Ọna Apejuwe
/api/acp/agents GET Ṣe atokọ gbogbo awọn aṣoju ti a rii (aṣa + ti a ṣe sinu) pẹlu ipo
/api/acp/agents POST Ṣafikun aṣoju aṣa tabi sọtun kaṣe wiwa
/api/acp/agents DELETE Yọ aṣoju aṣa kuro nipasẹ param ibeere id

idahun GET pẹlu agents[] (id, orukọ, alakomeji, ẹya, ti fi sori ẹrọ, Ilana, isCustom) ati summary (lapapọ, ti fi sori ẹrọ, notFound, builtIn, aṣa).

Resilience & Oṣuwọn Awọn idiwọn

Opin ojuami Ọna Apejuwe
/api/resilience GET/PATCH ti isinyi ibeere Get/update, itutu asopọ, fifọ olupese, ati awọn eto iduro
/api/resilience/reset POST Tun olupese Circuit breakers
/api/resilience/model-cooldowns GET Ṣe atokọ lọwọ fun (olupese, asopọ, awoṣe) awọn titiipa, lẹsẹsẹ nipasẹ akoko to ku
/api/resilience/model-cooldowns DELETE Pa awoṣe titiipa — ara {provider, model} tabi {all: true} lati nu ohun gbogbo rẹ
/api/rate-limits GET/POST Ipo idiwọn oṣuwọn-iroyin kan (GET) tabi yiyi oṣuwọn-iwọn aabo fun asopọ kan (POST {connectionId, enabled}). Atilẹyin ọna kikọ fun rateLimitProtection (ko ṣe atunṣe nipasẹ PUT /api/providers/[id]). Akiyesi: enabled: false ṣe aabo aabo to fojuhan ṣugbọn ko yọkuro asopọ bọtini API ti nṣiṣe lọwọ jade kuro ni apapọ aabo aifọwọyi-ṣiṣẹ agbaye (autoEnableApiKeyProviders).
/api/rate-limit GET Iṣeto ni opin oṣuwọn agbaye (ti a fi silẹ; inagijẹ si /api/rate-limits)

Gbogbo awọn ọna /api/resilience/* mẹrin nilo** auth isakoso** (requireManagementAuth). Wo Resilience (ti o gbooro sii) fun didenukole ni kikun ti olupilẹṣẹ olupese vs cooldown asopọ vs titiipa awoṣe.

Evals

Opin ojuami Ọna Apejuwe
/api/evals GET/POST Akojọ eval suites / ṣiṣe igbelewọn

Awọn ilana

Opin ojuami Ọna Apejuwe
/api/policies GET/POST/DELETE Ṣakoso awọn ilana ipa ọna

Ibamu

Opin ojuami Ọna Apejuwe
/api/compliance/audit-log GET Iwe iṣayẹwo ibamu (N kẹhin)

v1beta (Gemini-ibaramu)

Opin ojuami Ọna Apejuwe
/v1beta/models GET Ṣe atokọ awọn awoṣe ni ọna kika Gemini
/v1beta/models/{...path} POST Gemini generateContent ipari

Awọn aaye ipari wọnyi digi Gemini's API kika fun awọn alabara ti o nireti ibamu Gemini SDK abinibi.

Ti abẹnu / System APIs

Opin ojuami Ọna Apejuwe
/api/init GET Bẹrẹ awọn iṣẹ amuṣiṣẹpọ lẹhin (ifọwọsi iṣakoso)
/api/tags GET Awọn ami awoṣe ibaramu Ollama (fun awọn alabara Ollama )
/api/restart POST Ṣe okunfa oore-ọfẹ olupin tun bẹrẹ
/api/shutdown POST Ṣe okunfa titiipa olupin oore-ọfẹ
/api/system/env/repair POST Ṣe atunṣe awọn oniyipada ayika olupese OAuth
/api/system/version GET Current/latest version, imudojuiwọn ipo, Tu ikanni
/api/system/version POST Bẹrẹ imudojuiwọn imuṣiṣẹ-mọ si ẹya tuntun

Akiyesi: Awọn aaye ipari wọnyi ni a lo ninu inu nipasẹ eto tabi fun ibaramu alabara Ollama. Wọn kii ṣe deede pe nipasẹ awọn olumulo ipari.

Atunṣe Ayika OAuth (v3.6.1 +)

POST /api/system/env/repair
Content-Type: application/json

{
  "provider": "claude-code"
}

Awọn atunṣe ayika ti nsọnu tabi ibajẹ awọn oniyipada ayika OAuth fun olupese kan pato. Pada:

{
  "success": true,
  "repaired": ["CLAUDE_CODE_OAUTH_CLIENT_ID", "CLAUDE_CODE_OAUTH_CLIENT_SECRET"],
  "backupPath": "/home/user/.omniroute/backups/env-repair-2026-04-11.bak"
}

Ẹya ati Tu ikanni

GET /api/system/version

Ipa ọna iṣakoso Loopback-nikan (auth abojuto). Pada ẹya ti nṣiṣẹ pada, ẹya tuntun ti a tẹjade ati ipo imudojuiwọn aifọwọyi. releaseChannel ati channels jẹ awọn aaye afikun (iṣinipopada 3.8.54); channel tọju itumọ rẹ — ipo imuṣiṣẹ ti imudojuiwọn dasibodu nlo (npm, source tabi 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 ikanni ti ṣiṣiṣẹ kọ: nightly fun awọn ẹya -nightly.*, next fun awọn idasilẹ iṣaaju (-rc.*, -beta.*, -alpha.*), lts fun ẹya iduroṣinṣin ti agbalagba agbalagba ju channels.latest, bibẹẹkọ latest. Awọn ofin kanna bi scripts/release/dist-tag.mjs, eyiti o mu tag dist npm ni akoko titẹjade.
  • channels — ṣe atẹjade ori ti tag dist-tag kọọkan, lati npm view omniroute dist-tags (iforukọsilẹ HTTP fallback), cache pẹlu TTL iṣẹju 10 kanna bi latest. latest nigbagbogbo wa (ṣubu pada si aaye latest, lẹhinna "unavailable"); next, nightly ati lts han nikan nigbati dist-tag naa wa. Ibeere Cache-Control: no-cache kan tu awọn wiwa mejeeji pada.

Awoṣe ikanni (latest = v3 titi di 4.0 GA, next = rc, nightly = develop kọ, lts = v3 abulẹ lẹhin 4.0 GA) ti wa ni apejuwe ninu docs/ops/RELEASE_STRATEGY.md.


Ìkọ̀wé Ohùn

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

Yí àwọn fáìlì ohun padà sí ọ̀rọ̀ ní lílo olùpèsè STT èyíkéyìí tí a ti ṣètò. Abala ọ̀nà àkọ́kọ́ máa ń yan olùpèsè abínibí (openai/…, deepgram/…). Àwọn gateway tí wọ́n tún ń pèsè àpẹẹrẹ olùtajà mìíràn máa ń lo id tó ní ìdánimọ̀ kún un (openrouter/deepgram/nova-3).

Ìbéèrè:

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

Ìdáhùn:

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

Àpẹẹrẹ àwọn id àwòṣe: openai/whisper-1 (ó nílò kọ́kọ́rọ́ OpenAI), openrouter/deepgram/nova-3 (ó nílò kọ́kọ́rọ́ OpenRouter), deepgram/nova-3 (ó nílò kọ́kọ́rọ́ Deepgram abínibí). Ìbéèrè deepgram/nova-3 tí kò ní àfikún kankan kò lo OpenRouter.

Àwọn ọ̀nà fáìlì tí a ṣe àtìlẹ́yìn: mp3, wav, m4a, flac, ogg, webm.

Gemini Live (gemini/gemini-3.5-transcribe-live): ìkọ̀wé fáìlì sí ọ̀rọ̀ lórí WebSocket Gemini Live (ó nílò kọ́kọ́rọ́ API Gemini). A máa yí fáìlì tí a gbé sókè padà sí 16 kHz mono PCM pẹ̀lú ffmpeg (ó gbọ́dọ̀ wà lórí PATH, àyàfi tí fáìlì náà bá ti jẹ́ 16 kHz mono PCM WAV tẹ́lẹ̀), a sì máa rán án sí session náà ní ìṣàn; lẹ́yìn náà a máa dá ọ̀rọ̀ tí a parí padà gẹ́gẹ́ bí { "text": "..." }. Àwọn fọ́ọ̀mù language àti prompt tó wà yàn fún ni a máa fi ránṣẹ́ síwájú. Ààlà: àwọn fáìlì tí ó ju 25 MiB lọ tàbí ohun tí a tú sílẹ̀ tí ó gùn ju ìṣẹ́jú mẹ́wàá lọ máa dáhùn 413; bí ìyípadà bá gba ju s 60 lọ, a máa pa á, ó sì máa dáhùn 504. A máa rán kọ́kọ́rọ́ API sínú àkọlé x-goog-api-key nìkan, kì í ṣe sínú URL WebSocket.

Ìbámu pẹ̀lú Ollama

Fún àwọn oníbàárà tí wọ́n ń lo ọ̀nà API Ollama:

# Ibùdó ìbánisọ̀rọ̀ (ọ̀nà Ollama)
POST /v1/api/chat

# Àkójọ àwòṣe (ọ̀nà Ollama)
GET /api/tags

A máa ń túmọ̀ àwọn ìbéèrè láàárín Ollama àti àwọn ọ̀nà inú ètò láìfọwọ́kan.

VS Code Tí A Fi Token Sínú URL / Àwọn Alias Tí Kò Ní Header

Lo àwọn alias wọ̀nyí nígbà tí ìṣọ̀kan kò bá lè fi header Authorization sínú ìbéèrè, tí ó sì nílò kí API key wà nínú URL ìpìlẹ̀.

# Alias kátálógì ọ̀nà OpenAI
GET /api/v1/vscode/{token}/
GET /api/v1/vscode/{token}/models

# Àwọn alias ìbánisọ̀rọ̀ ọ̀nà OpenAI
POST /api/v1/vscode/{token}/chat/completions
POST /api/v1/vscode/{token}/responses

# Àwọn alias ọ̀nà Ollama
POST /api/v1/vscode/{token}/api/chat
GET /api/v1/vscode/{token}/api/tags

Àpẹẹrẹ:

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

Àwọn àkíyèsí:

  • Àwọn alias tí a fi token sí inú URL tún ń lo àwọn handler kan náà pẹ̀lú /v1/* àti /api/tags; àwọn àgbékalẹ̀ ìdáhùn kì í yí padà.
  • Ààyò fún Authorization: Bearer ... nígbàkúgbà tí oníbàárà bá ṣeé ṣe láti lo àwọn header àṣà.
  • Àwọn token inú URL lè hàn nínú àwọn àkọsílẹ̀ reverse-proxy, ìtàn aṣàwákiri, àti telemetry tí ó wà níta OmniRoute. Kà wọ́n sí àṣàyàn ìbámu, kì í ṣe ọ̀nà ìfàṣẹsí àìyípadà.

Telemetry

# Gba àkótán telemetry ìdádúró (p50/p95/p99 fún olùpèsè kọ̀ọ̀kan)
GET /api/telemetry/summary

Ìdáhùn:

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

Ìdíyelé

# Gba ipò ìdíyelé fún gbogbo API key
GET /api/usage/budget

# Ṣètò tàbí ṣe àtúnṣe ìdíyelé
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"
}

Àwọn àkíyèsí Schema (setBudgetSchema): apiKeyId jẹ́ dandan; ó kéré tán ọ̀kan lára dailyLimitUsd, weeklyLimitUsd, tàbí monthlyLimitUsd gbọ́dọ̀ ju òdo lọ. Àwọn pápá àṣàyàn: warningThreshold (0–1), resetInterval (daily | weekly | monthly), resetTime (HH:MM). Àgbékalẹ̀ àtijọ́ {keyId, limit, period} máa ń dá 400 Bad Request padà.

Àwọn Ààlà Token

Àwọn isuna token fún API key kọ̀ọ̀kan (tí ó yàtọ̀ sí Budget tí a dá lórí USD lókè). A máa ń fi wọ́n múlẹ̀ ní tààràtà lórí ọ̀nà ìbéèrè: nígbà tí ìlò window key kan bá dé ààlà rẹ̀, a máa kọ àwọn ìbéèrè pẹ̀lú 429 Too Many Requests. A lè fi ààlà sí model kan pàtó, provider kan, tàbí kí a lò ó ní global kọjá gbogbo key náà; nígbà tí ọ̀pọ̀ ààlà bá bá ìbéèrè mu, èyí tó muna jù ni yóò borí.

# Ṣe àkọsílẹ̀ àwọn ààlà token ti key kan (ó ní ìlò window tó wà lọ́wọ́ nínú)
GET /api/usage/token-limits?apiKeyId=key-123

# Ṣẹ̀dá tàbí ṣe àtúnṣe ààlà token kan
POST /api/usage/token-limits
Content-Type: application/json

{
  "apiKeyId": "key-123",
  "scopeType": "model",
  "scopeValue": "openai/gpt-4o",
  "tokenLimit": 1000000,
  "resetInterval": "monthly",
  "enabled": true
}

# Pa ààlà token kan rẹ̀ nípa id
DELETE /api/usage/token-limits?id=tl-abc

Àwọn àkíyèsí Schema (setTokenLimitSchema): apiKeyId àti scopeType (model | provider | global) jẹ́ dandan. scopeValue jẹ́ dandan àyàfi tí scopeType bá jẹ́ global (fún àpẹẹrẹ, id model kan fún scope model, tàbí id provider kan fún scope provider). tokenLimit gbọ́dọ̀ jẹ́ odidi rere (a máa yí i padà láti inú string). Àwọn aṣàyàn: id (má ṣe fi sílẹ̀ láti ṣẹ̀dá, pèsè rẹ̀ láti ṣe àtúnṣe), resetInterval (daily | weekly | monthly, àiyipada jẹ́ monthly), resetTime (HH:MM), enabled (àiyipada jẹ́ true). Àwọn ìdáhùn GET máa ń fi tokensUsed, remaining, windowStart, periodStartAt, àti nextResetAt kún ààlà kọ̀ọ̀kan. Endpoint yìí jẹ́ ti kíláàsì ìṣàkóso (a máa ń fi auth múlẹ̀ ní àárín gbùngbùn nípasẹ̀ authz pipeline).

Ṣíṣe Ìbéèrè

  1. Client máa ń rán ìbéèrè sí /v1/*
  2. Route handler máa ń pe handleChat, handleEmbedding, handleAudioTranscription, tàbí handleImageGeneration
  3. A máa ń pinnu Model (provider/model tààràtà tàbí alias/combo)
  4. A máa ń yan credentials láti local DB pẹ̀lú àlẹ̀mọ́ wíwà account
  5. Fún chat: handleChatCore máa ń ṣàyẹ̀wò semantic/signature cache, ó sì máa ń pinnu àwọn ètò ìkópọ̀ combo
  6. Ìkópọ̀ àkókò-tẹ́lẹ̀ máa ń ṣiṣẹ́ ṣáájú ìtúmọ̀ provider nígbà tí ó bá ṣiṣẹ́ (lite, Caveman, RTK, tàbí stacked)
  7. Provider executor máa ń rán ìbéèrè lọ sí upstream
  8. A máa ń tú ìdáhùn padà sí format client (chat), tàbí a máa ń dá a padà gẹ́gẹ́ bí ó ṣe rí (embeddings/images/audio)
  9. A máa ń gbasilẹ ìlò, analytics ìkópọ̀, àti àwọn àkọọ́lẹ̀ ìbéèrè
  10. Fallback máa ń ṣiṣẹ́ nígbà àwọn aṣìṣe gẹ́gẹ́ bí àwọn òfin combo

Àtọ́kasí architecture kíkún: ARCHITECTURE.md


Ìṣàkóso Combo

Àwọn combo routing ipele-gíga (tí a ti ṣe àkótán wọn lábẹ́ /api/combos*) tún lè jẹ́ mapped 1:1 láti inú pattern id model, èyí sì ń jẹ́ kí a lè yí id model irú OpenAI padà sí combo láìsí ìfarahàn.

Ọ̀nà Ọ̀nà URL Àlàyé
GET /api/model-combo-mappings Ṣe àkọsílẹ̀ gbogbo mappings model→combo
POST /api/model-combo-mappings Ṣẹ̀dá mapping — body: {pattern, comboId, priority?, enabled?, description?}
GET /api/model-combo-mappings/[id] Gba mapping kan ṣoṣo padà
PUT /api/model-combo-mappings/[id] Ṣe àtúnṣe àwọn pápá ti mapping tó wà
DELETE /api/model-combo-mappings/[id] Yọ mapping kan kúrò

Auth: session/API key ìṣàkóso (requireManagementAuth).


Webhooks

Àwọn ìforúkọsílẹ̀ webhook tí ń jáde fún àwọn ìṣẹ̀lẹ̀ OmniRoute (ìparí ìbéèrè, ìkúnà quota, yíyí bọtìnì padà, àti bẹ́ẹ̀ bẹ́ẹ̀ lọ).

Method Path Description
GET /api/webhooks Ṣàkójọ àwọn webhook (a bo àwọn aṣírí mọ́lẹ̀ sí <prefix>...)
POST /api/webhooks Ṣẹ̀dá webhook — ara ìbéèrè: {url, events?: ["*"], secret?, description?}
GET /api/webhooks/[id] Gba webhook kan padà
PUT /api/webhooks/[id] Ṣe àtúnṣe url/events/secret/description
DELETE /api/webhooks/[id] Yọ webhook kan kúrò
POST /api/webhooks/[id]/test Fìdí payload ìdánwò ránṣẹ́ sí URL webhook kí o sì da ipò ìfijiṣẹ́ padà

Ìfọwọ́sí: ìpàdé ìṣàkóso/bọtìnì API (requireManagementAuth).


Àwọn Bọtìnì Tí A Forúkọ Sílẹ̀ (Ìṣàkóso Aládàáṣiṣẹ́)

A máa ń lò ó fún ètò ìṣàkóso bọtìnì aládàáṣiṣẹ́ láti pèsè àti yí àwọn bọtìnì API padà lòdì sí olùpèsè/àkọọlẹ̀ ẹ̀yìn, pẹ̀lú àwọn quota ojoojúmọ́/àkókò wákàtí.

Method Path Description
GET /api/v1/registered-keys Ṣàkójọ àwọn bọtìnì tí a forúkọ sílẹ̀ (prefix tí a bo mọ́lẹ̀ nìkan)
POST /api/v1/registered-keys Pèsè bọtìnì tí a forúkọ sílẹ̀ tuntun — ara ìbéèrè: {name, provider?, accountId?, idempotencyKey?, expiresAt?, dailyBudget?, hourlyBudget?}. Ó da bọtìnì aise padà lẹ́ẹ̀kan ṣoṣo. Ó da 429 padà tí quota bá kọ ìbéèrè náà.
GET /api/v1/registered-keys/[id] Gba metadata bọtìnì tí a forúkọ sílẹ̀ padà (kò sí ohun aise)
DELETE /api/v1/registered-keys/[id] Fagi bọtìnì tí a forúkọ sílẹ̀
POST /api/v1/registered-keys/[id]/revoke Endpoint fagi tí ó ṣe kedere (ipa kan náà pẹ̀lú DELETE)

Ìfọwọ́sí: ìpàdé ìṣàkóso/bọtìnì API (requireManagementAuth) — ẹ̀ṣọ́ kan náà pẹ̀lú /api/keys: ìpàdé dashboard, token CLI agbègbè, tàbí bọtìnì API kan pẹ̀lú scope manage/admin; àwọn bọtìnì API tí ó jẹ́ fún inference nìkan máa ń gba 403. Wo /v1/quotas/check àti /v1/issues/report pẹ̀lú.


Ilana Àwọn Aṣojú

Àwọn iṣẹ́ aṣojú awọsanma (Claude Code, Codex Cloud, OpenHands, àti bẹ́ẹ̀ bẹ́ẹ̀ lọ) tí a ń ṣiṣẹ́ lọ́nà jíjìn fún àwọn olumulo OmniRoute.

Ọ̀nà Ọ̀nà URL Àlàyé
GET /api/v1/agents/tasks Ṣàkójọ àwọn iṣẹ́ — ?provider=, ?status=, ?limit= jẹ́ àṣàyàn (1–500, àiyé 50)
POST /api/v1/agents/tasks Ṣẹ̀dá iṣẹ́ — CreateCloudAgentTaskSchema ló ń fọwọ́sí ara ìbéèrè (providerId, prompt, source, options?). Ó máa dá 201 padà pẹ̀lú àpò iṣẹ́
DELETE /api/v1/agents/tasks?id=... Pa iṣẹ́ kan rẹ
GET /api/v1/agents/tasks/[id] Kà iṣẹ́ — ó máa tún ipò ṣe ní ìbámu pẹ̀lú aṣojú awọsanma òkè nígbà tí a bá ṣètò external_id
POST /api/v1/agents/tasks/[id] Ìṣe tí a yà sọ́tọ̀: {action: "approve"}, {action: "message", message}, tàbí {action: "cancel"}
DELETE /api/v1/agents/tasks/[id] Pa iṣẹ́ pàtó kan rẹ nípa id

Ìfàṣẹsí: a nílò ìfàṣẹsí ìṣàkóso lórí gbogbo ọ̀nà (requireCloudAgentManagementAuth). Ṣáájú v3.8.0, àwọn yìí kò ní ìfàṣẹsí — wo commit 588a0333 fún ìyípadà tó ń fa àìbáṣepọ̀.

# Ṣẹ̀dá iṣẹ́ awọsanma Claude Code
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":"..."}}'

Àwọn Proxy Ìṣàkóso

Àwọn proxy HTTP(S)/SOCKS tó ń jáde síta, tí a lè yàn fún àwọn olupèsè, àwọn àkáǹtì, tàbí ní gbogbogbòò.

Ọ̀nà Ọ̀nà URL Àlàyé
GET /api/v1/management/proxies Ṣàkójọ àwọn proxy (pẹ̀lú ?id= ó máa dá ọ̀kan padà; pẹ̀lú ?id=&where_used=1 ó máa dá àwòrán ìpínpín padà)
POST /api/v1/management/proxies Ṣẹ̀dá proxy — createProxyRegistrySchema ló ń fọwọ́sí ara ìbéèrè
PATCH /api/v1/management/proxies Ṣàtúnṣe proxy — updateProxyRegistrySchema ló ń fọwọ́sí ara ìbéèrè (ó nílò id)
DELETE /api/v1/management/proxies?id=...&force=1 Pa proxy rẹ (lo force=1 láti yọ àwọn ìpínpín kúrò)
GET /api/v1/management/proxies/assignments Ṣàkójọ àwọn ìpínpín — a lè ṣe àlẹ̀mọ́ pẹ̀lú proxy_id, scope, scope_id; fi resolve_connection_id=<id> ránṣẹ́ láti wá proxy tó ń ṣiṣẹ́ fún ìsopọ̀ kan
PUT /api/v1/management/proxies/assignments Yàn — proxyAssignmentSchema ló ń fọwọ́sí ara ìbéèrè ({scope, scopeId?, proxyId?}). Ó ń nu àkójọpọ̀ dispatcher kúrò
PUT /api/v1/management/proxies/bulk-assign Yàn lọ́pọ̀ — bulkProxyAssignmentSchema ló ń fọwọ́sí ara ìbéèrè ({scope, scopeIds[], proxyId?})
GET /api/v1/management/proxies/health?hours=24 Àkójọpọ̀ ìlera proxy (àpapọ̀ aṣeyọrí/àìṣeyọrí, ìdádúró) láàrín àkókò kan

Ìfàṣẹsí: ìpàdé ìṣàkóso/bọtìnì API ní gbogbo ọ̀nà (requireManagementAuth).

Àwọn ọ̀nà POST /api/v1/management/proxies/[id]/assignments àti POST /api/v1/management/proxies/[id]/health ni àwọn ọ̀nà pẹlẹbẹ /assignments àti /health tó wà lókè ń pèsè — kò sí àwọn ọ̀nà abẹ́-ọ̀nà fún id kọ̀ọ̀kan nínú àkójọpọ̀ kóòdù.


Ìfaradà (àfikún)

OmniRoute ṣíṣàfihàn àwọn ọ̀nà ìkùnà fún ìgbà díẹ̀ mẹ́ta tí ó dá yàtọ̀; àwọn endpoint ìṣàkóso tó wà nísàlẹ̀ jẹ́ kí àwọn alákóso ka wọn kí wọ́n sì tún lè yí wọn padà:

Àyè Ibi ìpamọ́ ipò Kíkà Túnṣe / nu kúrò
Provider breaker domain_circuit_breakers + in-memory /api/monitoring/health POST /api/resilience/reset
Ìtútù asopọ̀ rateLimitedUntil lórí àwọn asopọ̀ provider /api/rate-limits, /api/providers/[id] (ó tún máa ṣiṣẹ́ lọ́wọ́ ara rẹ̀; nu kúrò nípasẹ̀ provider PUT)
Ìdènà model In-memory model-availability registry GET /api/resilience/model-cooldowns DELETE /api/resilience/model-cooldowns

PATCH /api/resilience gba àwọn àtúnṣe provider breaker lábẹ́ providerBreaker.oauth àti providerBreaker.apikey. Profaili kọ̀ọ̀kan ń ṣe àtìlẹ́yìn fún degradationThreshold, failureThreshold, àti resetTimeoutMs; àwọn pápá kan náà wà ní Dashboard → Settings → Resilience.

# Pa ìdènà model kan ṣoṣo rẹ
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"}'

# Pa gbogbo àwọn ìdènà rẹ
curl -X DELETE http://localhost:20128/api/resilience/model-cooldowns \
  -H "Cookie: auth_token=..." \
  -d '{"all":true}'

Fún ìtọ́kasí èrò-ìmọ̀ kíkún àti àwọn àiyé breaker: wo CLAUDE.md → “Ìpò Iṣiṣẹ́ Resilience” àti docs/architecture/RESILIENCE_GUIDE.md.

Ìlà Rate-Limit àti Àwọ̀n Ààbò Ṣíṣe-ṣiṣẹ́ Aifọwọyi

  • Ọ̀nà ìkọ̀wé tí a ti gbà: POST /api/rate-limits pẹ̀lú body {"connectionId": "<id>", "enabled": true|false} ni endpoint ìṣàkóso tí a gbà láti tan tàbí pa ààbò rate-limit fún asopọ̀ kan. PUT /api/providers/[id] kò ṣe àtúnṣe tàbí yí rateLimitProtection padà mọ́ọ̀mọ̀ (#11278).
  • Ìtumọ̀ enabled: false: Ṣíṣe enabled: false máa ń yọ ààbò tí a ṣàlàyé kúrò fún asopọ̀ náà, ṣùgbọ́n kò túmọ̀ sí pé asopọ̀ API-key tó ń ṣiṣẹ́ ti jáde kúrò nínú àwọ̀n ààbò auto-enable àgbáyé (autoEnableApiKeyProviders = true). Nínú reconcileEnabledConnections (open-sse/services/rateLimitManager.ts), false àti undefined jẹ́ ohun kan náà; àwọn asopọ̀ API-key tó ń ṣiṣẹ́ tí kò ní ààbò tí a ṣàlàyé ṣì máa wà lábẹ́ àwọ̀n ààbò auto-enable.
  • Pípa àgbáyé: Láti ṣiṣẹ́ àwọn asopọ̀ API-key láìsí àwọn ìlà rate-limit, pa àwọ̀n ààbò náà ní àgbáyé nípasẹ̀ RATE_LIMIT_AUTO_ENABLE=false (env) tàbí resilienceSettings.requestQueue.autoEnableApiKeyProviders = false (Settings → Resilience / PATCH /api/resilience).

Àwọn Skill

Àlàkalẹ̀ Skill fún fífi àwọn handler tí a lè ṣiṣẹ́ àṣà kun OmniRoute, pẹ̀lú àwọn ìṣọ̀kan ọjà.

Ọ̀nà Ọ̀nà URL Àlàyé
GET /api/skills Ṣàkójọ àwọn skill tí a fi sílẹ̀ — a lè ṣe àlẹ̀mọ́ pẹ̀lú ?q=, ?mode=on|off|auto, ?source=skillsmp|skillssh|local, pẹ̀lú pagination
GET /api/skills/[id] Gba skill kan ṣoṣo padà
PUT /api/skills/[id] Ṣàtúnṣe skill (orúkọ, àpèjúwe, mode, schema, handler, tags)
DELETE /api/skills/[id] Yọ skill kúrò
POST /api/skills/install Fi skill kan sílẹ̀ láti inú manifest aise — body: {name, version, description, schema:{input, output}, handlerCode, apiKeyId?}
GET /api/skills/executions Ṣàkójọ àwọn ìṣiṣẹ́ skill tuntun (àkọsílẹ̀ àyẹ̀wò pẹ̀lú inputs/outputs/duration)
GET /api/skills/marketplace?q=... Ṣàwárí/àkójọ àwọn olókìkí láti ọjà SkillsMP (ó nílò ètò skillsmpApiKey)
POST /api/skills/marketplace/install Fi skill kan sílẹ̀ nípa id rẹ̀ láti SkillsMP
GET /api/skills/skillssh?q=&limit= Ṣàwárí registry skills.sh
POST /api/skills/skillssh/install Fi skill kan sílẹ̀ nípa id rẹ̀ láti skills.sh

Ìfàṣẹsí: Àkókò ìṣàkóso/API key. Àwọn ọ̀nà ìṣàwárí ọjà gba ìfàṣẹsí ìṣàkóso tàbí Bearer API key (isAuthenticated).

Ìrántí

Ibi ìpamọ́ ìrántí ìbánisọ̀rọ̀/òtítọ́ tó wà pẹ́ títí, tí a pín sí API key / session kọ̀ọ̀kan.

Method Path Description
GET /api/memory Ṣe àtòjọ àwọn ìrántí — ?apiKeyId=, ?type=, ?sessionId=, ?q=, pẹ̀lú pagination offset/limit tàbí page/limit
POST /api/memory Ṣẹ̀dá ìrántí — body tí Zod fọwọ́sí: {content, key, type?, sessionId?, apiKeyId?, metadata?, expiresAt?}
GET /api/memory/[id] Gba ìrántí kan padà
DELETE /api/memory/[id] Pa ìrántí kan rẹ
GET /api/memory/health Ìlera ẹ̀ka ìrántí (ìbánisọ̀rọ̀ pẹ̀lú DB, ẹ̀rọ ìfọwọ́sí embeddings, ipò atọ́ka vector)

Ìfọwọ́sí: management session/API key (requireManagementAuth). type enum: FACTUAL, EPISODIC, SEMANTIC, PROCEDURAL (wo MemoryType nínú src/lib/memory/types.ts).


Olùpèsè MCP

OmniRoute wá pẹ̀lú embedded Model Context Protocol server tí ó ní transports mẹ́ta (stdio, SSE, streamable-http) àti àwọn irinṣẹ́ tí a fi scope sí. Àwọn dashboard endpoints tó wà nísàlẹ̀ ń ka status/audit data, wọ́n sì ń ṣe proxy fún àwọn HTTP transports.

Method Path Description
GET /api/mcp/status Heartbeat, transport, ipò online, ìpè tó kẹ́yìn, àwọn irinṣẹ́ tó wà lókè, àti ìwọ̀n àṣeyọrí fún wákàtí 24
GET /api/mcp/tools Àtòjọ àwọn irinṣẹ́ MCP pẹ̀lú name, description, scopes, phase, auditLevel, sourceEndpoints
GET /api/mcp/sse Ṣí SSE stream fún SSE transport (ó máa dá 503 padà bí MCP bá wà ní pipa tàbí tí transport kò bá mu)
POST /api/mcp/sse Rán JSON-RPC frame lórí SSE transport
GET /api/mcp/stream Ṣí apá SSE ti Streamable HTTP transport (àwọn messages tí server bẹ̀rẹ̀)
POST /api/mcp/stream Rán JSON-RPC frame lórí Streamable HTTP transport
DELETE /api/mcp/stream Parí Streamable HTTP session
GET /api/mcp/audit Béèrè lọ́wọ́ audit log — ?limit=, ?offset=, ?tool=, `?success=true false, ?apiKeyId=`
GET /api/mcp/audit/stats Àkópọ̀ audit stats (àpapọ̀, ìwọ̀n àṣeyọrí, ìpẹ̀yà àkókò, àwọn irinṣẹ́ tó wà lókè)

Ìfọwọ́sí: àwọn transports sse/stream ń bọ̀wọ̀ fún MCP-specific auth surface (Bearer API key pẹ̀lú mcp scope); àwọn routes status/tools/audit* lè ka láti dashboard (kò sí ìfọwọ́sí àfikún tó nílò ju dídé dashboard host lọ).

Àwọn HTTP transports méjèèjì wà lábẹ́ àbójútó settings.mcpEnabled àti settings.mcpTransport — transport mismatch máa ń dá 400 padà, ipò MCP tí a pa máa ń dá 503 padà.


Olùpèsè A2A

OmniRoute ń ṣàfihàn endpoint JSON-RPC 2.0 A2A (Agent-to-Agent) àti wrapper REST kan fún ìṣàyẹ̀wò àti lílo dashboard.

JSON-RPC

POST /a2a
Authorization: Bearer your-api-key   # optional unless OMNIROUTE_API_KEY is set
Content-Type: application/json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "message/send",
  "params": {
    "skill": "smart-routing",
    "messages": [{"role": "user", "content": "Route this coding task"}]
  }
}

Àwọn ọ̀nà tí a gbà lẹ́yìn (gbogbo wọn wà lábẹ́ settings.a2aEnabled):

Ọ̀nà Àpèjúwe
message/send Ìmúṣẹ́ ọgbọ́n ní àkókò kan náà; ó máa dá {task, artifacts, metadata} padà
message/stream Ìmúṣẹ́ SSE tí ń ṣàn fún àkójọpọ̀ ọgbọ́n kan náà
tasks/get Gba iṣẹ́ kan nípasẹ̀ taskId
tasks/cancel Fagilé iṣẹ́ kan nípasẹ̀ taskId

Àwọn ọgbọ́n tí a ṣe sínú rẹ̀: smart-routing, quota-management, provider-discovery, cost-analysis, health-report.

Kaadi Aṣojú

GET /.well-known/agent.json

Ó máa dá kaadi aṣojú A2A gbogbogbòò padà (orúkọ, àpèjúwe, àwọn agbára, kátálógì ọgbọ́n, àti ètò ìfàṣẹsí) — a ó máa fi pamọ́ fún gbogbo ènìyàn fún wákàtí 1. A kò nílò ìfàṣẹsí.

Àwọn olùrànlọ́wọ́ REST

Ọ̀nà Ọ̀nà URL Àpèjúwe
GET /api/a2a/status Ìdí tí A2A fi ṣiṣẹ́ + àkópọ̀ ìṣirò iṣẹ́ + àkópọ̀ kaadi aṣojú tí a fi pamọ́
GET /api/a2a/tasks Ṣe àtòjọ àwọn iṣẹ́ — ?state=submitted|working|completed|failed|cancelled, ?skill=, ?limit= (≤200), ?offset=
POST /api/a2a/tasks (A kò tíì ṣe é gẹ́gẹ́ bí olùrànlọ́wọ́ REST — ṣẹ̀dá nípasẹ̀ JSON-RPC message/send)
GET /api/a2a/tasks/[id] Gba iṣẹ́ kan ṣoṣo
POST /api/a2a/tasks/[id]/cancel Fagilé iṣẹ́ kan

Ìfàṣẹsí: àwọn olùrànlọ́wọ́ REST ń ṣiṣẹ́ láìsí ìfàṣẹsí ìṣàkóso (dashboard lè kà á); ọ̀nà JSON-RPC /a2a ń lo Bearer OMNIROUTE_API_KEY tí a bá ṣètò rẹ̀.


Àwọsánmà, Àyẹ̀wò àti Assess

Ọ̀nà Ọ̀nà URL Àpèjúwe
POST /api/cloud/auth Ṣàyẹ̀wò kọ́kọ́rọ́ Bearer kan kí o sì dá àwọn ìsopọ̀ olùpèsè tí a bo àti àwọn alias awoṣe padà fún àwọn oníbàárà amuṣiṣẹpọ̀ àwọsánmà
POST /api/cloud/credentials/update Ṣe àtúnṣe àwọn ẹ̀rí ìwọlé tí a ṣàkọsílẹ̀ fún olùpèsè tí a ń múṣiṣẹ́pọ̀ pẹ̀lú àwọsánmà
POST /api/cloud/model/resolve Yanjú ID awoṣe ọgbọ́n kan sí olùpèsè/awoṣe gidi ní lílo tábìlì ìtọ́sọ́nà àdúgbò
GET /api/cloud/models/alias Ṣe àtòjọ àwọn alias awoṣe bí a ṣe ń fi wọ́n hàn sí amuṣiṣẹpọ̀ àwọsánmà
GET /api/assess Kà àwọn ìpín ẹ̀ka àyẹ̀wò tuntun jù lọ (lórí olùpèsè/awoṣe kọ̀ọ̀kan)
POST /api/assess Ṣe àyẹ̀wò kan — ara ìbéèrè: `{scope: {type:"all"} {type:"provider", providerId} {type:"model", modelId}, trigger?}`
GET /api/evals Ṣe àtòjọ àwọn àkójọpọ̀ eval tí a ṣe sínú rẹ̀ + àwọn ìṣiṣẹ́ tuntun jù lọ
POST /api/evals Dá ìṣiṣẹ́ eval kan sílẹ̀
POST /api/evals/suites Ṣẹ̀dá àkójọpọ̀ eval àṣà kan — evalSuiteSaveSchema ló ń fọwọ́sí ara ìbéèrè náà
GET /api/evals/suites/[id] Gba àkójọpọ̀ eval àṣà kan

Ìfàṣẹsí: /api/cloud/auth ń fọwọ́sí kọ́kọ́rọ́ Bearer kan tààrà, ó sì máa dá kọ́kọ́rọ́ tí a bo àti projectId ti ìsopọ̀ kọ̀ọ̀kan padà fún kọ́kọ́rọ́ kan ṣoṣo tí ó ní ààlà manage / admin; àwọn ọ̀nà /api/cloud/*, /api/evals/*, àti /api/assess yòókù nílò ìpàdé ìṣàkóso/kọ́kọ́rọ́ API. POST /api/assess ń lo validateBody pẹ̀lú ètò scope discriminated-union.


Isakoso ACP (Agent Client Protocol)

gẹ́gẹ́ bí àwọn ìlànà ọmọ. Àwọn endpoint wọ̀nyí ń ṣàkóso ìwádìí aṣojú ACP àti ìforúkọsílẹ̀ aṣojú àṣà.

Method Path Description
GET /api/acp/agents Ṣàtòjọ gbogbo àwọn aṣojú CLI tí a mọ̀ (àwọn tí a ṣe sínú àti àṣà) pẹ̀lú ipò fifi sori ẹrọ, ẹ̀dà, àti binary
POST /api/acp/agents Forúkọsílẹ̀ aṣojú ACP àṣà tàbí tún cache ṣe — body: {id, name, binary, versionCommand, providerAlias, spawnArgs, protocol} tàbí {action: "refresh"}
DELETE /api/acp/agents Yọ aṣojú ACP àṣà kúrò — query param: ?id=<agentId>

Àpẹẹrẹ ìdáhùn (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
}

Ìfọ̀wọ́sí: Ó nílò ìgbà ìṣàkóso (dashboard auth_token cookie) tàbí bọ́tìnì API tí a pín sí ìṣàkóso.

Wo Àgbékalẹ̀ ACP fún àwọn àlàyé kíkún.


Ìtúpalẹ̀ àti Ìmòjútó

Àwọn endpoint ìtúpalẹ̀ àkókò-gidi fún ṣíṣe àbójútó ìdarí, ìdínkù, àti onírúurú àwọn olupèsè. Àwọn wọ̀nyí ló ń ṣiṣẹ́ fún àwọn ojú-ìwé /dashboard/analytics/*.

Ìtúpalẹ̀ ìdarí aládàáṣiṣẹ́

Method Path Description
GET /api/analytics/auto-routing Àkópọ̀ àwọn ìṣirò ìdarí aládàáṣiṣẹ́: iye àwọn ìpè lápapọ̀, pínpín ọgbọ́n, pínpín ipele, àti àwọn olupèsè tó ga jù lọ
GET /api/analytics/auto-routing?days=7 Àwọn ìṣirò tó dá lórí àkókò kan (àìpẹ́ 24h)

Àpẹẹrẹ ìdáhùn:

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

Ìtúpalẹ̀ ìdínkù

Method Path Description
GET /api/analytics/compression Àkópọ̀ àwọn ìṣirò ìdínkù: àwọn token tí a fipamọ́, ìpín ìfipamọ́ %, pínpín mode, àti lílo engine

Àpẹẹrẹ ìdáhùn:

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

Títọ́pa onírúurú àwọn olupèsè

Method Path Description
GET /api/analytics/diversity Títọ́pa onírúurú tó dá lórí Shannon entropy: ó ń dènà ibi ìkùnà kan ṣoṣo nípa dídi ìtànkálẹ̀ àwọn olupèsèwọ̀n

Àpẹẹrẹ ìdáhùn:

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

Ìfọ̀wọ́sí: Ó nílò ìgbà ìṣàkóso tàbí bọ́tìnì API tí a pín sí ìṣàkóso.


Àwọn Iṣiṣẹ́ Alákóso

Àwọn endpoint tí alákóso nìkan lè lo fún ìṣàkóso iṣẹ́.

Ọ̀nà Ọ̀nà URL Àlàyé
GET /api/admin/concurrency Ka àwọn ààlà concurrency tó wà lọ́wọ́lọ́wọ́ (àgbáyé + fún olupèsè kọ̀ọ̀kan)
POST /api/admin/concurrency Ṣe àtúnṣe àwọn ààlà concurrency — ara ìbéèrè: {global?: number, perProvider?: Record<string, number>}

Ìfàṣẹsí: Ó nílò ìpàdé ìṣàkóso pẹ̀lú àyè admin.


Ìṣàkóso Àwọn Ọ̀ṣẹ́ CLI

Ṣàkóso àwọn irinṣẹ́ CLI tí wọ́n ń ṣepọ̀ pẹ̀lú OmniRoute (antigravity, commandCode, devin-cli, àti bẹ́ẹ̀ bẹ́ẹ̀ lọ). Wo Ìtọ́kasí Olùpèsè fún àtòjọ kíkún.

Ọ̀nà Ọ̀nà URL Àlàyé
GET /api/cli-tools/all-statuses Ipò gbogbo àwọn irinṣẹ́ CLI (tí a fi sílė̀, ẹ̀dà, ìgbà tí a rí kẹ́yìn)
GET /api/cli-tools/status Àlàyé ipò fún irinṣẹ́ CLI kan (?tool= ìbéèrè)
POST /api/cli-tools/apply Kọ́ àgbékalẹ̀ tí a ṣe jáde fún irinṣẹ́ kan (dryRun ń ṣàfihàn àbájáde ṣáájú; 422 + containerEphemeralTarget nígbà tí ó bá wà nínú container; migration ń ṣàkíyèsí YAML Codex àtijọ́)
GET /api/cli-tools/backups Ṣàtòjọ àwọn ẹ̀dà àfipamọ́ àgbékalẹ̀ àwọn irinṣẹ́ CLI
POST /api/cli-tools/backups Ṣẹ̀dá àfipamọ́ kan fún gbogbo àgbékalẹ̀ àwọn irinṣẹ́ CLI
POST /api/cli-tools/backups Mu padà: endpoint kan náà pẹ̀lú {tool, backupId} nínú ara ìbéèrè yóò mú àfipamọ́ náà padà
GET /api/cli-tools/antigravity-mitm Ipò aṣojú MITM Antigravity (irinṣẹ́ CLI "antigravity-mitm")
POST /api/cli-tools/antigravity-mitm/alias Ṣàgbékalẹ̀ àwọn alias antigravity-mitm

Ìfàṣẹsí: Ó nílò ìpàdé ìṣàkóso.


Àwọn Agbára Aṣojú

Ṣàkóso àwọn agbára aṣojú AI (ó jọ àwọn GPT àṣà OpenAI, ṣùgbọ́n fún àwọn aṣojú).

Ọ̀nà Ọ̀nà URL Àlàyé
GET /api/agent-skills Ṣàtòjọ gbogbo àwọn agbára aṣojú (tí a kọ́ sínú rẹ̀ + àṣà)
GET /api/agent-skills/[id] Gba agbára aṣojú kan pàtó
POST /api/agent-skills Ṣẹ̀dá agbára aṣojú àṣà — ara ìbéèrè: {name, description, prompt, model?, temperature?}
PUT /api/agent-skills/[id] Ṣe àtúnṣe agbára aṣojú àṣà
DELETE /api/agent-skills/[id] Pa agbára aṣojú àṣà rẹ
GET /api/agent-skills/[id]/raw Gba prompt + metadata aise (láìṣe ìmúlò)
POST /api/agent-skills/generate Jẹ́ kí AI ṣe agbára tuntun jáde láti inú àpèjúwe èdè àdáyébá

Ìfàṣẹsí: Ó nílò ìpàdé ìṣàkóso tàbí kọ́kọ́rọ́ API tí ó ní àyè ìṣàkóso.


Ìṣàkóso Kaṣe

Ṣàkóso kaṣe ìtumọ̀ àti kaṣe ìrònú.

Ọ̀nà Ọ̀nà URL Àlàyé
GET /api/cache Àkótán kaṣe: àpapọ̀ àwọn àkọsílẹ̀, ìpín ìkọlù, àti ìwọ̀n lórí disiki
GET /api/cache/entries Ṣàkójọ àwọn àkọsílẹ̀ tí a fi pamọ́ (pẹ̀lú pípín ojúewé)
DELETE /api/cache/entries Pa àwọn àkọsílẹ̀ kaṣe rẹ́ (àlẹ̀mọ́ nípasẹ̀ àwọn paramita ìbéèrè)
GET /api/cache/stats Àlàyé ìṣirò kaṣe (nípa olùpèsè, nípa àwòṣe)
GET /api/cache/reasoning Ìpo kaṣe ìrònú (fún ṣíṣeré ìrònú padà)
DELETE /api/cache/reasoning Ko kaṣe ìrònú kúrò — àwọn paramita ìbéèrè: ?toolCallId=<id> (ẹyọ̀ kan) tàbí ?provider=<p> tàbí láìsí paramita (gbogbo rẹ̀)

Ìfàṣẹsí: Ó nílò ìgbà ìṣàkóso.


Ètò Ìrántí

Ṣàkóso ìrántí tí ó máa ń wà títí (FTS5 + àwọn ìfihàn fekito).

Ọ̀nà Ọ̀nà URL Àlàyé
GET /api/memory Ṣàkójọ àwọn àkọsílẹ̀ ìrántí (àlẹ̀mọ́ nípa àyè, irú, àti ìbéèrè àwárí)
POST /api/memory Ṣẹ̀dá àkọsílẹ̀ ìrántí tuntun — ara ìbéèrè: {scope, type, content, metadata?}
GET /api/memory/[id] Gba àkọsílẹ̀ ìrántí kan pàtó
PUT /api/memory/[id] Ṣe àtúnṣe àkọsílẹ̀ ìrántí
DELETE /api/memory/[id] Pa àkọsílẹ̀ ìrántí rẹ́
GET /api/memory?q= Ṣe àwárí ìrántí (FTS5 + fekito) — àwọn ìṣirò wà nínú ìdáhùn kan náà

Ìfàṣẹsí: Ó nílò ìgbà ìṣàkóso tàbí kọ́kọ́rọ́ API tí àyè rẹ̀ jẹ́ ti ìṣàkóso.


Àwọn Webhook

Ṣàkóso àwọn ìforúkọsílẹ̀ webhook fún àwọn ìṣẹ̀lẹ̀.

Ọ̀nà Ọ̀nà URL Àlàyé
GET /api/webhooks Ṣàkójọ gbogbo àwọn ìforúkọsílẹ̀ webhook
POST /api/webhooks Ṣẹ̀dá ìforúkọsílẹ̀ webhook — ara ìbéèrè: {url, events[], secret?, active?}
GET /api/webhooks/[id] Gba ìforúkọsílẹ̀ webhook kan pàtó
PUT /api/webhooks/[id] Ṣe àtúnṣe ìforúkọsílẹ̀ webhook
DELETE /api/webhooks/[id] Pa ìforúkọsílẹ̀ webhook rẹ́
GET /api/webhooks/[id]/deliveries Ṣàkójọ ìtàn fífi ránṣẹ́ fún webhook (àkọsílẹ̀ àṣeyọrí/àìṣeyọrí)
POST /api/webhooks/[id]/test Rán ìṣẹ̀lẹ̀ ìdánwò sí webhook

Ìfàṣẹsí: Ó nílò ìgbà ìṣàkóso.

Wo Àkópọ̀ Webhook fún àwọn irú ìṣẹ̀lẹ̀ ní kíkún.


Àwọn Ìmọ̀ Ẹ̀rọ

Ṣàkóso Àwọn Ìmọ̀ Ẹ̀rọ (àwọn àfikún agentic).

Method Path Description
GET /api/skills Ṣàkójọ gbogbo àwọn ìmọ̀ ẹ̀rọ tí a ti fi sílò (àwọn tí a kọ́ sínú àti àwọn àṣà)
POST /api/skills/install Fi ìmọ̀ ẹ̀rọ kan sílò láti ọ̀nà àdúgbò tàbí URL
DELETE /api/skills/[id] Yọ ìmọ̀ ẹ̀rọ kan kúrò
PUT /api/skills/[id] Mú kí ìmọ̀ ẹ̀rọ ṣiṣẹ́ tàbí dá a dúró — body: {enabled?: boolean, mode?: "on" | "off" | "auto"}
POST /api/skills/executions Ṣe ìmúṣẹ ìmọ̀ ẹ̀rọ kan — body: {skillName, apiKeyId, input?, sessionId?}
GET /api/skills/executions Ṣàkójọ ìtàn ìmúṣẹ fún gbogbo àwọn ìmọ̀ ẹ̀rọ (ṣàlẹ̀ nípa ?apiKeyId=)

Auth: Ó nílò ìgbà ìṣàkóso tàbí kọ́kọ́rọ́ API tí ó ní ààlà ìṣàkóso.

Wo Ìlànà Àwọn Ìmọ̀ Ẹ̀rọ fún àwọn kúlẹ̀kúlẹ̀ kíkún.


Àwọn Plugin

Ṣàkóso àwọn plugin OmniRoute (àwọn àfikún ẹni-kẹta).

Method Path Description
GET /api/plugins Ṣàkójọ àwọn plugin tí a ti fi sílò
POST /api/plugins/marketplace/install Fi plugin kan sílò láti ọjà àwọn plugin
DELETE /api/plugins/[name] Yọ plugin kan kúrò
POST /api/plugins/[name]/activate Mú plugin kan ṣiṣẹ́
POST /api/plugins/[name]/deactivate Dá plugin kan dúró
GET /api/plugins/[name]/config Gba ìṣètò plugin
PUT /api/plugins/[name]/config Ṣàtúnṣe ìṣètò plugin

Auth: Ó nílò ìgbà ìṣàkóso.

Wo Ìlànà Àwọn Plugin fún àwọn kúlẹ̀kúlẹ̀ kíkún.


Ìtọ́sọ́nà Ojiji

Ìfiwéra ojiji / A-B ti àwọn olùpèsè kì í ṣe ojú REST tí ó dá dúró — a máa ń ṣètò rẹ̀ nípasẹ̀ ìtọ́sọ́nà combo (wo Auto-Combo). GET /api/combos/metrics ni ń pèsè àwọn metiriki ìfiwéra fún combo kọ̀ọ̀kan.


Àwọn Ààbò

Ṣàyẹ̀wò àwọn ààbò runtime (ìṣàwárí PII, ìṣàwárí prompt injection, àti ìsopọ̀ iran). Àwọn ààbò ń ṣiṣẹ́ lórí gbogbo ìbéèrè; láti yọ wọn kúrò fún ìpè kọ̀ọ̀kan, lo àkọlé ìbéèrè x-omniroute-disabled-guardrails — kò sí ojú fún pípa/mú kí ó ṣiṣẹ́ tí a máa ń pamọ́.

Method Path Description
GET /api/guardrails Ṣàkójọ àwọn ààbò tí a forúkọ sílẹ̀ àti ipò wọn (orúkọ / enabled / priority)
POST /api/guardrails/test Ṣe ìgbéjà kan láìsí ìmúṣẹ lórí pipeline ṣáájú ìpè, ní lílo àbáwọlé àpẹẹrẹ — body: {input, disabledGuardrails?}

Auth: Ó nílò ìgbà ìṣàkóso.

Wo Ààbò > Àwọn Ààbò fún àwọn kúlẹ̀kúlẹ̀ kíkún.



Ìfọwọ́sí

Wo Ìfọwọ́sí Ìṣàkóso fún àwọn ìdílé ẹ̀rí mẹ́rin (ìgbà ìpàdé dashboard, token CLI àgbègbè, Access Token oma_live_…, àti kọ́kọ́rọ́ API tí a pín sí ìṣàkóso) àti bí wọ́n ṣe yàtọ̀ sí àwọn kọ́kọ́rọ́ inference.

  • Àwọn ọ̀nà dashboard (/dashboard/*) máa ń lo cookie auth_token
  • Ìwọlé máa ń lo hash ọ̀rọ̀ aṣínà tí a ti fipamọ́; bí kò bá sí, ó máa ń padà sí INITIAL_PASSWORD
  • A lè yí requireLogin sí iṣẹ́ tàbí pa á nípasẹ̀ /api/settings/require-login
  • Àwọn ọ̀nà /v1/* lè béèrè fún kọ́kọ́rọ́ API Bearer nígbà tí REQUIRE_API_KEY=true
  • “management token” / “management-scoped API key” nínú ìtọ́kasí yìí túmọ̀ sí ọ̀kan nínú àwọn ìdílé tí a ṣàlàyé nínú ìtọ́sọ́nà yẹn — kì í ṣe irú àṣírí àfikún tí a kò ṣàlàyé

Àyípadà tí ń fa ìṣòro (v3.8.0) — /api/v1/agents/tasks/* àti àwọn ọ̀nà ìṣàkóso cooldown béèrè fún ìfọwọ́sí ìṣàkóso báyìí (cookie auth_token ti dashboard tàbí kọ́kọ́rọ́ API tí a pín sí ìṣàkóso). Àwọn oníbàárà tí wọ́n máa ń pe àwọn ọ̀nà wọ̀nyí láìsí ìfọwọ́sí yóò gba 401 Unauthorized. Wo commit 588a0333 (fix(auth): require management auth for agent and cooldown APIs).