API reference

गेटवे जे काही expose करतो, ते सर्व इथे आहे — 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 प्रमाणेच एक्स्टेन्शन, रूटिंग आणि फेलओव्हरसह. प्लॅटफॉर्म key वर भारत-निवासी मॉडेल्स: bge-m3 (1024-dim).

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.