Skip to main content
POST
Error
Required Permissions How permissions work

Authorizations

Authorization
string
header
required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <token>, where <token> is one of:

  • a Bifrost management API key,
  • a dashboard session token issued by POST /api/session/login,
  • base64 of <admin-username>:<admin-password> (legacy equivalent of BasicAuth).

Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs - the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.

Authentication alone is not sufficient in Bifrost Enterprise: each operation page shows a Required Permissions table (Resource:Operation, for example Dashboard:View) above its Authorizations section, and the caller's RBAC role or management API key scopes must include what it lists, otherwise the request is rejected with 403 Forbidden.

A local admin — authenticated with the admin password, or any caller on a deployment with dashboard auth disabled — bypasses these checks and can call every management endpoint.

OSS setup lock. On Bifrost OSS, while dashboard auth is not active (no admin account, or auth disabled), every management endpoint except the public ones (/health, /api/version, /api/session/is-auth-enabled, /api/session/login, ...) requires the operator's setup token in the X-Bifrost-Setup-Token header, in place of Authorization. The token is set with setup_token in config.json or the BIFROST_SETUP_TOKEN environment variable. A missing header returns 401, a wrong token 403. The header stops working once dashboard auth is enabled. The dashboard instead trades the token once for an HttpOnly bifrost_setup_session cookie via POST /api/session/setup. See Required permissions for how permissions are derived and which endpoints are exempt.

Path Parameters

router_id
string
required

The model router; an unknown router is 404.

Query Parameters

window
string

Hours or days (24h, 7d); omitted is the whole lookback.

Example:

"7d"

Body

application/json
phrases
object
required

Phrases by tier, keyed SIMPLE, MEDIUM or COMPLEX; the gateway also accepts these keys in any case. A phrase is compared as the bank compares phrases, ignoring case and runs of whitespace.

Example:
min_similarity
number

The similarity floor the draft would save, when the draft changes it; the draft side is replayed at it and the live side at the serving floor. Omitted replays the draft at the serving floor. At least 0 and less than 1.

Required range: x >= 0

Response

Draft replayed

What the phrases tried would do to a router's recent captured traffic, added to its saved phrases. Costs are in USD over the window, for the changed requests only. added and skipped say which of the phrases tried were new and which the bank already held.

added
object

The phrases the replay added to the router's saved ones, by tier.

skipped
object[]

Phrases tried that their tier already holds.

window_seconds
integer
requests
integer

Requests replayed.

total
integer

Requests captured in the window; more than requests when a sample was replayed.

tiers
object[]
changed_count
integer
changed
object[]

The first 25 requests that change tier.

attention
object[]

New draft phrases that take requests the live bank placed confidently in another tier.

live_cost
number
draft_cost
number
savings
number

live_cost minus draft_cost; negative when the draft costs more.

priced
integer
unpriced
integer