Skip to main content
GET
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.

Query Parameters

query
string[]
required

A phrasing of what to look for. Repeat the parameter for up to 5 phrasings.

Required array length: 1 - 5 elements
Maximum string length: 2000
limit
integer

Matches to return, at most 25. Defaults to, and is capped by, Warp's configured semantic search limit.

Required range: 1 <= x <= 25
providers
string

Comma-separated list of providers to filter by

models
string

Comma-separated list of models to filter by

status
string

Comma-separated list of statuses to filter by

virtual_key_ids
string

Comma-separated list of virtual key IDs to filter by

team_ids
string

Comma-separated list of team IDs to filter by

customer_ids
string

Comma-separated list of customer IDs to filter by

user_ids
string

Comma-separated list of user IDs to filter by

business_unit_ids
string

Comma-separated list of business unit IDs to filter by

start_time
string<date-time>

Start time filter (RFC3339 format)

end_time
string<date-time>

End time filter (RFC3339 format)

period
enum<string>

Time window resolved server-side; takes precedence over start_time and end_time. Sliding periods (1h, 6h, 24h, 7d, 30d) end now. Calendar periods (today, this_week, this_month) start at midnight of the current day, week (Monday) or month in timezone.

Available options:
1h,
6h,
24h,
7d,
30d,
today,
this_week,
this_month
timezone
string

IANA timezone that calendar periods are measured in (e.g. America/New_York). Empty or unknown values fall back to UTC. Ignored for sliding periods.

min_latency
number

Minimum latency filter

max_latency
number

Maximum latency filter

min_cost
number

Minimum cost filter

max_cost
number

Maximum cost filter

apps
string

Detected client apps to filter by. Send a JSON array of strings or a comma-separated list.

session_id
string

Exact Bifrost session ID used for key stickiness and request correlation

Search in request/response content

Response

Successful response

Logged conversations matching a search by meaning, best match first

rows
object[]
required
returned
integer
required

Number of rows returned

threshold
number
required

The Warp similarity a row had to reach to be returned, on the same 0-1 scale as score