WebSocket connection

Upgrades to a WebSocket connection for real-time updates. Server pushes log events, MCP log events, and store update notifications. Heartbeat pings are sent every 30 seconds.

Browsers cannot set an Authorization header on a WebSocket handshake, so this endpoint additionally accepts a single-use ticket query parameter obtained from POST /api/session/ws-ticket, or the HTTPOnly token session cookie.

GET /ws

Error

A valid request URL is required to generate request examples

401

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

Authorizations

ManagementBearerAuthBasicAuthSessionCookieAuth

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.

Query Parameters

ticket · string

Single-use WebSocket ticket from POST /api/session/ws-ticket. Use this when an Authorization header cannot be set (browser WebSocket clients).

Response

101

WebSocket upgrade successful