Public endpoints

get/api/v1/catalogue

Catalogue

No authentication.

curl -s "$OSR_URL/api/v1/catalogue"

post/api/v1/estimate

Estimate Public

Quote a request before sending it: tokens, cost per candidate and the recommended pick. Works without a key (rate limited per client, no tenant rules) and with one (metered as `estimate, workspace tenants and plan applied). monthly_requests` adds a monthly projection.

Requires an API key.

curl -s -X POST "$OSR_URL/api/v1/estimate" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "constraints": {}, "context": {}, "history": [], "kinds": [], "monthly_requests": 1, "objective": {}, "output_tokens": 1, "profile": {} }'

{
  "constraints": {},
  "context": {},
  "history": [],
  "kinds": [],
  "monthly_requests": 1,
  "objective": {},
  "output_tokens": 1,
  "profile": {}
}

get/api/v1/info

Info

No authentication.

curl -s "$OSR_URL/api/v1/info"

get/api/v1/llms

Llms

The reference LLM catalogue: real vendors, prices per million tokens, context windows, modalities. Independent of what this deployment routes to; `routed_by lists the routing targets that resolve to each model. Sorted by newest (default), name, price, price-desc, context or intelligence`.

No authentication.

curl -s "$OSR_URL/api/v1/llms?q=&sort=newest"

get/api/v1/llms/{vendor}/{model}

Llm

One reference model with the routing targets that resolve to it and its vendor siblings.

No authentication.

curl -s "$OSR_URL/api/v1/llms/<vendor>/<model>"

get/api/v1/models

Models

No authentication.

curl -s "$OSR_URL/api/v1/models?days=7"

get/api/v1/models/recommended

Models Recommended

Recommended models per use case (chat, code, reasoning, summaries, extraction, sensitive data). Each use case is quoted live against the catalogue: the router's pick, the cheapest capable target, the best quality and the fastest, with the reasons. Cached for a minute.

No authentication.

curl -s "$OSR_URL/api/v1/models/recommended"

get/api/v1/models/{model_id}

Model

No authentication.

curl -s "$OSR_URL/api/v1/models/<model_id>?days=30"

post/api/v1/newsletter/subscribe

Newsletter Subscribe

Subscribe an address to the newsletter. Always `202`; a confirmation with the one-click unsubscribe link is emailed. Re-subscribing an address re-activates it.

No authentication.

curl -s -X POST "$OSR_URL/api/v1/newsletter/subscribe" \
  -H "Content-Type: application/json" \
  -d '{ "email": "ada@example.com" }'

{
  "email": "ada@example.com"
}

post/api/v1/newsletter/unsubscribe

Newsletter Unsubscribe

One-click unsubscribe with the token from any newsletter message.

No authentication.

curl -s -X POST "$OSR_URL/api/v1/newsletter/unsubscribe" \
  -H "Content-Type: application/json" \
  -d '{ "token": "string" }'

{
  "token": "string"
}

get/api/v1/rankings

Rankings

No authentication.

curl -s "$OSR_URL/api/v1/rankings?days=7"

post/api/v1/signup

Signup

No authentication.

curl -s -X POST "$OSR_URL/api/v1/signup" \
  -H "Content-Type: application/json" \
  -d '{ "email": "ada@example.com" }'

{
  "email": "ada@example.com"
}

get/api/v1/stats/public

Stats Public

No authentication.

curl -s "$OSR_URL/api/v1/stats/public"

get/api/v1/status

Status

Readiness checks, uptime and the observability controls of this deployment (no key needed). The same checks as `GET /readyz` with the edition, versions and tracing state added; the status code is 503 while a check fails so status pages can poll it directly.

No authentication.

curl -s "$OSR_URL/api/v1/status"