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.

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:
suggestion_ids
string[]

The suggestions the phrases came from. Each must be the router's and open; once the phrases are saved they are marked accepted where they still can be (see accepted in the response).

Response

Phrases added and the router served

What phrases given by tier did to a phrase bank.

added
object

The phrases added, by tier.

skipped
object[]

Phrases left out because their tier already holds them.

router
object

A model router - an id, a name and a description beside the same settings as ComplexityAnalyzerConfig, sent and returned at the top level; its phrase suggestions, which only model routers make; the model each tier gets; and the routing that decides which requests it takes. Routers are separate from the complexity analyzer config, which routing rules read complexity_tier from. The cross-field rules of ComplexityAnalyzerConfig apply, and the suggestion rules below.

accepted
string[]

Only the suggestions actually marked accepted. One a run superseded while the phrases were saved, or whose status could not be written, is left out; the phrases stay saved either way.