API reference

गेटवे जो कुछ भी एक्सपोज़ करता है, सब यहाँ है — auth मॉडल के हिसाब से समूहीकृत। Inference endpoints एक API key लेते हैं (Authorization: Bearer br-…); dashboard endpoints साइन-इन पर सेट किए गए ब्राउज़र सेशन कुकी का उपयोग करते हैं और पूर्णता के लिए यहाँ सूचीबद्ध हैं — अधिकांश लोग उन्हें dashboard UI के माध्यम से उपयोग करते हैं। एक मशीन-पठनीय स्कीमा openapi.json पर रहती है।

Inference (API key)

POST /v1/chat/completions

OpenAI-compatible chat completions, स्ट्रीमिंग और नॉन-स्ट्रीमिंग।BharatRouter एक्सटेंशन (optimize,optimize_weights, provider, data_policy, upstream_key, fallbacks, …) स्वीकार करता है — इन्हें राउटर उपयोग कर लेता है और रिक्वेस्ट के गेटवे छोड़ने से पहले हटा देता है। जिस provider ने असल में रिक्वेस्ट को सर्व किया, उसे x-br-provider response header में लौटाया जाता है।

curl https://api.bharatrouter.com/v1/chat/completions \
  -H "Authorization: Bearer br-..." -H "Content-Type: application/json" \
  -d '{
    "model": "qwen2.5-7b-instruct",
    "messages": [
      {"role": "system", "content": "You answer in Hindi."},
      {"role": "user", "content": "What is the capital of Maharashtra?"}
    ],
    "max_tokens": 200,
    "optimize": "uptime"
  }'

Response (नॉन-स्ट्रीमिंग) टोकन usage के साथ एक मानक chat-completion ऑब्जेक्ट है:

{
  "id": "chatcmpl-...",
  "object": "chat.completion",
  "model": "qwen2.5-7b-instruct",
  "choices": [{ "index": 0, "message": { "role": "assistant", "content": "मुंबई ..." }, "finish_reason": "stop" }],
  "usage": { "prompt_tokens": 28, "completion_tokens": 41, "total_tokens": 69 }
}

"stream": true होने पर response text/event-stream होती है। गेटवे उन providers पर stream_options.include_usage इंजेक्ट करता है जो इसे सपोर्ट करते हैं, इसलिए[DONE] से पहले का अंतिम चंक usage ब्लॉक ले जाता है।

POST /v1/embeddings

OpenAI-compatible embeddings — chat जैसे ही एक्सटेंशन, रूटिंग और फेलओवर के साथ।

curl https://api.bharatrouter.com/v1/embeddings \
  -H "Authorization: Bearer br-..." -H "Content-Type: application/json" \
  -d '{ "model": "bge-m3", "input": ["namaste", "vanakkam"], "data_policy": "india_only" }'

Catalog & health (सार्वजनिक, कोई auth नहीं)

curl -s https://api.bharatrouter.com/v1/models | jq '.data[] | select(.id=="qwen2.5-7b-instruct")'

Discovery (सार्वजनिक)

Dashboard API (सेशन कुकी)

GitHub/Google OAuth द्वारा साइन-इन पर सेट किया जाता है (GET /auth/:provider → callback → br_session कुकी;POST /auth/logout इसे क्लियर कर देता है)। Org के मालिक सब कुछ कर सकते हैं; कुछ endpoints केवल-मालिक हैं जैसा चिह्नित है।

Account

API keys

पूरी सिमेंटिक्स API keys & limits पर।

BYOK keys

पूरी गाइड BYOK पेज पर।

Billing

पूरी सिमेंटिक्स Credits & billing पर।

Routing chains

सहेजी गई org-wide फेलओवर चेन — पूरी गाइड Routing पर।

Collections

पूरी गाइड Collections पर।

Custom endpoints (BYOE)

पूरी गाइड Bring your own endpoint पर।

Reliability monitoring

पूरी गाइड Reliability monitoring पर।

Teams & workspaces

पूरी गाइड Teams & workspaces पर।

Usage & activity

पूरी गाइड Usage, activity & rankings पर।

Webhooks

Response headers

Platform limits

प्रति-key limits और मासिक ₹ बजट कॉन्फ़िगर करने योग्य हैं — देखेंAPI keys & limits। Errors एक ही JSON envelope का उपयोग करती हैं — देखें Errors।