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

run_id
string
required
router_id
string
required

The model router; an unknown router is 404.

Response

Run cancelled, or asked to stop

id
string
router_id
string
router_version
string
window_start
string<date-time>

Start of the window the run read; it ends at started_at.

triggered_by
enum<string>
Available options:
schedule,
manual
status
enum<string>

cancelled runs were stopped by a user; what they had written is kept.

Available options:
queued,
skipped,
running,
succeeded,
failed,
cancelled
stage
enum<string>

How far a running run got; absent once it ends.

Available options:
backfilling,
reading,
clustering,
suggesting,
saving
embedding_signature
string
model
string

provider/model the suggestions were written with.

prompt_hash
string

SHA-256 of the instructions and tier guidance in force.

requests_read
integer

Captured requests in the window.

requests_clustered
integer

The sample the clusters were formed from.

requests_assigned
integer

Requests counted into the clusters after the sample.

requests_skipped
integer

Requests past the counting bound, read into no cluster.

requests_grouped
integer

Requests in clusters big enough to keep.

clusters
integer
clusters_decided
integer

Clusters matching an accepted or dismissed suggestion, not asked about again.

clusters_over_limit
integer

Clusters not suggested because of this run's limits: past the bound on clusters asked per run, or after the phrases already written filled the room left in the phrase bank.

clusters_asked
integer
clusters_done
integer

Clusters asked about so far; equals clusters_asked once the run ends.

clusters_failed
integer
clusters_covered
integer

Clusters the phrase bank already routes well.

clusters_incoherent
integer

Clusters that were not one kind of request, or got no usable answer.

clusters_unreadable
integer

Clusters none of whose example requests could be read back.

created
integer
refreshed
integer
superseded
integer
cost
number

Cost of the run's suggestion-model calls, in USD.

error
string

Why the run failed, why a skipped run did not start, or, on a run that succeeded, the clusters it left for the next run.

started_at
string<date-time>
finished_at
string<date-time>