Sanggunian ng API

Kumpletong sanggunian para sa lahat ng endpoint ng OmniRoute API.

Talaan ng mga Nilalaman

Chat Completions
Embeddings
Image Generation
List Models
Compatibility Endpoints
Semantic Cache
Dashboard & Management
Request Processing
Authentication

Mga Pagkumpleto ng Chat

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
}

Mga Custom na Header

Header	Direksyon	Paglalarawan
`X-OmniRoute-No-Cache`	Kahilingan	Itakda sa `true` upang i-bypass ang cache
`X-OmniRoute-Progress`	Kahilingan	Itakda sa `true` para sa mga kaganapan sa pag-unlad
`Idempotency-Key`	Kahilingan	Dedup key (5s window)
`X-Request-Id`	Kahilingan	Alternatibong susi sa pagtanggal
`X-OmniRoute-Cache`	Tugon	`HIT` o `MISS` (hindi nag-stream)
`X-OmniRoute-Idempotent`	Tugon	`true` kung i-deduplicate
`X-OmniRoute-Progress`	Tugon	`enabled` kung ang pagsubaybay sa pag-unlad sa

Mga pag-embed

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

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

Mga available na provider: Nebius, OpenAI, Mistral, Together AI, Fireworks, NVIDIA.

# List all embedding models
GET /v1/embeddings

Pagbuo ng Larawan

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

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

Mga available na provider: OpenAI (DALL-E), xAI (Grok Image), Together AI (FLUX), Fireworks AI.

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

Listahan ng mga Modelo

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

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

Mga Endpoint ng Compatibility

Paraan	Landas	Format
POST	`/v1/chat/completions`	OpenAI
POST	`/v1/messages`	Antropiko
POST	`/v1/responses`	Mga Tugon sa OpenAI
POST	`/v1/embeddings`	OpenAI
POST	`/v1/images/generations`	OpenAI
KUMUHA	`/v1/models`	OpenAI
POST	`/v1/messages/count_tokens`	Antropiko
KUMUHA	`/v1beta/models`	Gemini
POST	`/v1beta/models/{...path}`	Gemini generateContent
POST	`/v1/api/chat`	Ollama

Nakalaang Mga Ruta ng Provider

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

Ang prefix ng provider ay awtomatikong idinaragdag kung nawawala. Ang mga hindi tugmang modelo ay nagbabalik ng 400.

Semantic Cache

# Get cache stats
GET /api/cache

# Clear all caches
DELETE /api/cache

Halimbawa ng tugon:

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

Dashboard at Pamamahala

Pagpapatotoo

Endpoint	Paraan	Paglalarawan
`/api/auth/login`	POST	Mag-login
`/api/auth/logout`	POST	Logout
`/api/settings/require-login`	GET/PUT	Kailangang i-toggle ang pag-login

Pamamahala ng Provider

Endpoint	Paraan	Paglalarawan
`/api/providers`	GET/POST	Maglista / gumawa ng mga provider
`/api/providers/[id]`	GET/PUT/DELETE	Pamahalaan ang isang provider
`/api/providers/[id]/test`	POST	Subukan ang koneksyon ng provider
`/api/providers/[id]/models`	KUMUHA	Maglista ng mga modelo ng provider
`/api/providers/validate`	POST	I-validate ang config ng provider
`/api/provider-nodes*`	Iba't ibang	Pamamahala ng node ng provider
`/api/provider-models`	GET/POST/DELETE	Mga custom na modelo

Mga Daloy ng OAuth

Endpoint	Paraan	Paglalarawan
`/api/oauth/[provider]/[action]`	Iba't ibang	OAuth na partikular sa provider

Pagruruta at Config

Endpoint	Paraan	Paglalarawan
`/api/models/alias`	GET/POST	Mga alyas ng modelo
`/api/models/catalog`	KUMUHA	Lahat ng modelo ayon sa provider + uri
`/api/combos*`	Iba't ibang	Pamamahala ng combo
`/api/keys*`	Iba't ibang	Pamamahala ng key ng API
`/api/pricing`	KUMUHA	Pagpepresyo ng modelo

Paggamit at Analytics

Endpoint	Paraan	Paglalarawan
`/api/usage/history`	KUMUHA	Kasaysayan ng paggamit
`/api/usage/logs`	KUMUHA	Mga log ng paggamit
`/api/usage/request-logs`	KUMUHA	Mga log sa antas ng kahilingan
`/api/usage/[connectionId]`	KUMUHA	Paggamit sa bawat koneksyon

Mga Setting

Endpoint	Paraan	Paglalarawan
`/api/settings`	GET/PUT	Mga pangkalahatang setting
`/api/settings/proxy`	GET/PUT	Network proxy config
`/api/settings/proxy/test`	POST	Subukan ang proxy na koneksyon
`/api/settings/ip-filter`	GET/PUT	IP allowlist/blocklist
`/api/settings/thinking-budget`	GET/PUT	Rasoning token budget
`/api/settings/system-prompt`	GET/PUT	Global system prompt

Pagsubaybay

Endpoint	Paraan	Paglalarawan
`/api/sessions`	KUMUHA	Aktibong pagsubaybay sa session
`/api/rate-limits`	KUMUHA	Mga limitasyon sa rate ng bawat account
`/api/monitoring/health`	KUMUHA	Pagsusuri sa kalusugan
`/api/cache`	GET/DELETE	Mga istatistika ng cache / i-clear

I-backup at I-export/I-import

Endpoint	Paraan	Paglalarawan
`/api/db-backups`	KUMUHA	Ilista ang mga available na backup
`/api/db-backups`	ILAGAY	Gumawa ng manu-manong backup
`/api/db-backups`	POST	Ibalik mula sa isang partikular na backup
`/api/db-backups/export`	KUMUHA	I-download ang database bilang .sqlite file
`/api/db-backups/import`	POST	Mag-upload ng .sqlite file upang palitan ang database
`/api/db-backups/exportAll`	KUMUHA	I-download ang buong backup bilang .tar.gz archive

Cloud Sync

Endpoint	Paraan	Paglalarawan
`/api/sync/cloud`	Iba't ibang	Mga pagpapatakbo ng cloud sync
`/api/sync/initialize`	POST	Simulan ang pag-sync
`/api/cloud/*`	Iba't ibang	Pamamahala ng ulap

CLI Tools

Endpoint	Paraan	Paglalarawan
`/api/cli-tools/claude-settings`	KUMUHA	Claude CLI status
`/api/cli-tools/codex-settings`	KUMUHA	Katayuan ng Codex CLI
`/api/cli-tools/droid-settings`	KUMUHA	Katayuan ng Droid CLI
`/api/cli-tools/openclaw-settings`	KUMUHA	Katayuan ng OpenClaw CLI
`/api/cli-tools/runtime/[toolId]`	KUMUHA	Generic na CLI runtime

Kasama sa mga tugon ng CLI ang: installed, runnable, command, commandPath, runtimeMode, reason.

Mga Limitasyon sa Katatagan at Rate

Endpoint	Paraan	Paglalarawan
`/api/resilience`	GET/PUT	Kumuha/mag-update ng mga profile ng resilience
`/api/resilience/reset`	POST	I-reset ang mga circuit breaker
`/api/rate-limits`	KUMUHA	Katayuan ng limitasyon sa rate ng bawat account
`/api/rate-limit`	KUMUHA	Configuration ng limitasyon sa pandaigdigang rate

Mga Eval

Endpoint	Paraan	Paglalarawan
`/api/evals`	GET/POST	Maglista ng mga eval suite / run evaluation

Mga Patakaran

Endpoint	Paraan	Paglalarawan
`/api/policies`	GET/POST/DELETE	Pamahalaan ang mga patakaran sa pagruruta

Pagsunod

Endpoint	Paraan	Paglalarawan
`/api/compliance/audit-log`	KUMUHA	Log ng audit ng pagsunod (huling N)

v1beta (Gemini-Compatible)

Endpoint	Paraan	Paglalarawan
`/v1beta/models`	KUMUHA	Listahan ng mga modelo sa Gemini na format
`/v1beta/models/{...path}`	POST	Gemini `generateContent` endpoint

Ang mga endpoint na ito ay sumasalamin sa format ng API ng Gemini para sa mga kliyenteng umaasa sa native na Gemini SDK compatibility.

Mga Panloob / System API

Endpoint	Paraan	Paglalarawan
`/api/init`	KUMUHA	Pagsusuri sa pagsisimula ng application (ginamit sa unang pagtakbo)
`/api/tags`	KUMUHA	Mga tag ng modelong katugma sa Ollama (para sa mga kliyente ng Ollama)
`/api/restart`	POST	I-trigger ang magandang pag-restart ng server
`/api/shutdown`	POST	Mag-trigger ng magandang pag-shutdown ng server

Tandaan: Ang mga endpoint na ito ay panloob na ginagamit ng system o para sa Ollama client compatibility. Hindi sila karaniwang tinatawag ng mga end user.

Transkripsyon ng Audio

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

I-transcribe ang mga audio file gamit ang Deepgram o AssemblyAI.

Kahilingan:

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

Tugon:

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

Mga sinusuportahang provider: deepgram/nova-3, assemblyai/best.

Mga sinusuportahang format: mp3, wav, m4a, flac, ogg, webm.

Ollama Compatibility

Para sa mga kliyenteng gumagamit ng format ng API ng Ollama:

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

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

Awtomatikong isinasalin ang mga kahilingan sa pagitan ng Ollama at mga panloob na format.

Telemetry

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

Tugon:

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

Badyet

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

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

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

Availability ng Modelo

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

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

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

Pagproseso ng Kahilingan

Nagpapadala ang kliyente ng kahilingan sa /v1/*
Tumatawag ang tagapangasiwa ng ruta sa handleChat, handleEmbedding, handleAudioTranscription, o handleImageGeneration
Nalutas ang modelo (direktang provider/modelo o alias/combo)
Pinili ang mga kredensyal mula sa lokal na DB na may pagsasala ng availability ng account
Para sa chat: handleChatCore — format detection, translation, cache check, idempotency check
Nagpapadala ang tagapagpatupad ng provider ng upstream na kahilingan
Ang tugon ay isinalin pabalik sa format ng kliyente (chat) o ibinalik sa dati (mga pag-embed/mga larawan/audio)
Naitala ang paggamit/pag-log
Nalalapat ang Fallback sa mga error ayon sa combo rules

Buong sanggunian sa arkitektura: link

Pagpapatotoo

Ang mga ruta ng dashboard (/dashboard/*) ay gumagamit ng auth_token cookie
Gumagamit ang pag-login ng naka-save na hash ng password; fallback sa INITIAL_PASSWORD
requireLogin toggleable sa pamamagitan ng /api/settings/require-login
/v1/* ruta opsyonal na nangangailangan ng Bearer API key kapag REQUIRE_API_KEY=true

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sanggunian ng API

Talaan ng mga Nilalaman

Mga Pagkumpleto ng Chat

Mga Custom na Header

Mga pag-embed

Pagbuo ng Larawan

Listahan ng mga Modelo

Mga Endpoint ng Compatibility

Nakalaang Mga Ruta ng Provider

Semantic Cache

Dashboard at Pamamahala

Pagpapatotoo

Pamamahala ng Provider

Mga Daloy ng OAuth

Pagruruta at Config

Paggamit at Analytics

Mga Setting

Pagsubaybay

I-backup at I-export/I-import

Cloud Sync

CLI Tools

Mga Limitasyon sa Katatagan at Rate

Mga Eval

Mga Patakaran

Pagsunod

v1beta (Gemini-Compatible)

Mga Panloob / System API

Transkripsyon ng Audio

Ollama Compatibility

Telemetry

Badyet

Availability ng Modelo

Pagproseso ng Kahilingan

Pagpapatotoo

FilesExpand file tree

API_REFERENCE.md

Latest commit

History

API_REFERENCE.md

File metadata and controls

Sanggunian ng API

Talaan ng mga Nilalaman

Mga Pagkumpleto ng Chat

Mga Custom na Header

Mga pag-embed

Pagbuo ng Larawan

Listahan ng mga Modelo

Mga Endpoint ng Compatibility

Nakalaang Mga Ruta ng Provider

Semantic Cache

Dashboard at Pamamahala

Pagpapatotoo

Pamamahala ng Provider

Mga Daloy ng OAuth

Pagruruta at Config

Paggamit at Analytics

Mga Setting

Pagsubaybay

I-backup at I-export/I-import

Cloud Sync

CLI Tools

Mga Limitasyon sa Katatagan at Rate

Mga Eval

Mga Patakaran

Pagsunod

v1beta (Gemini-Compatible)

Mga Panloob / System API

Transkripsyon ng Audio

Ollama Compatibility

Telemetry

Badyet

Availability ng Modelo

Pagproseso ng Kahilingan

Pagpapatotoo