Skip to content
Documentation
Hosted platformREST API reference

Offers

Models by the token: an offer is one catalogue model served by one provider endpoint (`vendor/model@provider`), synthesised into the routing catalogue and sold at the customer price the pricing engine computes.

Hosted platformAPI version 1.4.0

Models by the token: an offer is one catalogue model served by one provider endpoint (`vendor/model@provider`), synthesised into the routing catalogue and sold at the customer price the pricing engine computes. `GET /offers` is the public storefront (list price next to the price the caller pays, the endpoints with health and traffic); `/admin/offers` and `/admin/providers/{provider_id}/offers` list, pause and remove offers. `POST /v1/chat/completions` accepts `vendor/model` (the router picks the endpoint) and `vendor/model@provider` (one pinned); `GET /v1/models` lists offers in OpenRouter's shape.

get/api/v1/offers

List Offers

Every model this deployment sells, grouped by catalogue id: list price, the customer price (the caller's plan and rules when signed in, else the deployment's public tariff), the endpoints serving it with health and seven-day traffic. Anonymous callers get the public prices.

Requires an API key

Parameters

NameInTypeDefaultDescription
qquerystring""
vendorquerystring | null
providerquerystring | null

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s "$OSR_URL/api/v1/offers?q=" \
  -H "Authorization: Bearer $OSR_API_KEY"

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

One Model

One model's endpoints (model may carry a :variant suffix) with prices, health and traffic.

Requires an API key

Parameters

NameInTypeDefaultDescription
vendor(required)pathstring
model(required)pathstring

Responses

200Successful Response
422Validation ErrorHTTPValidationError
401Missing, invalid or revoked API key
Requestbash
curl -s "$OSR_URL/api/v1/offers/<vendor>/<model>" \
  -H "Authorization: Bearer $OSR_API_KEY"