> ## Documentation Index > Fetch the complete documentation index at: https://docs.getbifrost.ai/llms.txt > Use this file to discover all available pages before exploring further. # Publish a dashboard notification > Persists a notification and pushes it over the dashboard WebSocket to every connected client the audience covers. Administrators only. Reading is open to any authenticated user because a caller only ever receives rows their role already entitles them to, but a single publish reaches every dashboard user on the deployment, so it is restricted to the local admin. On a deployment with dashboard auth disabled every request is treated as local admin. Notifications expire 30 days after creation and are pruned hourly. ## OpenAPI ````yaml /openapi/openapi.json post /api/notifications openapi: 3.1.0 info: title: Bifrost API description: > Bifrost HTTP Transport API for AI model inference and gateway management. This API provides a unified interface for interacting with multiple AI providers including OpenAI, Anthropic, Bedrock, Gemini, and more through a single API, along with comprehensive management APIs for configuring and monitoring the gateway. ## API Structure ### Unified Inference API (`/v1/*`) The primary API using Bifrost's unified format. Model parameters use the format `provider/model` (e.g., `openai/gpt-4`, `anthropic/claude-3-opus`). ### Async Inference API (`/v1/async/*`) Submit inference requests for asynchronous execution. Returns a job ID immediately and allows polling for results. Supports all inference types except batches, files, and containers. ### Provider Integration APIs Native provider-format APIs for drop-in compatibility: - `/openai/*` - OpenAI-compatible API - `/anthropic/*` - Anthropic-compatible API - `/genai/*` - Google GenAI (Gemini) compatible API - `/bedrock/*` - AWS Bedrock compatible API - `/cohere/*` - Cohere compatible API ### Framework Integration APIs Multi-provider proxy endpoints for AI frameworks: - `/litellm/*` - LiteLLM proxy with all provider formats - `/langchain/*` - LangChain compatible endpoints - `/pydanticai/*` - PydanticAI compatible endpoints ### Management APIs (`/api/*`) APIs for managing and monitoring the Bifrost gateway: - `/api/config` - Configuration management - `/api/providers` - Provider and API key management - `/api/plugins` - Plugin management - `/api/governance/*` - Virtual keys, teams, customers, budgets, rate limits, routing rules, and pricing overrides - `/api/logs` - Log search and analytics - `/api/mcp/*` - MCP (Model Context Protocol) client management - `/api/session/*` - Authentication and session management - `/api/cache/*` - Cache management - `/health` - Health check endpoint ## Fallbacks Requests can include fallback models that will be tried if the primary model fails. version: 1.0.0 contact: name: Contact Us url: https://getmaxim.ai/bifrost license: name: Apache 2.0 url: https://opensource.org/licenses/Apache-2.0 servers: - url: '{baseUrl}' description: Your Bifrost instance variables: baseUrl: default: http://localhost:8080 description: Base URL of your Bifrost instance (e.g. https://bifrost.mycompany.com) security: - BearerAuth: [] - BasicAuth: [] - ApiKeyAuth: [] tags: - name: Models description: Model listing and information - name: Chat Completions description: Chat-based text generation - name: Text Completions description: Text completion generation - name: Responses description: OpenAI Responses API compatible endpoints - name: OCR description: Optical character recognition for documents and images - name: Rerank description: Document reranking by relevance to a query - name: Embeddings description: Text embedding generation - name: Images description: Image generations, editing, and variations - name: Videos description: Video generation and management - name: Audio description: Speech synthesis and transcription - name: Count Tokens description: Token counting utilities - name: Batch description: Batch processing operations - name: Files description: File management operations - name: Containers description: Container management operations - name: Async Jobs description: Asynchronous job submission and retrieval endpoints - name: Realtime description: Realtime WebSocket and WebRTC endpoints - name: OpenAI Integration description: OpenAI-compatible API endpoints (/openai/*) - name: Azure Integration description: Azure OpenAI integration endpoints - name: Anthropic Integration description: Anthropic-compatible API endpoints (/anthropic/*) - name: GenAI Integration description: Google GenAI (Gemini) compatible API endpoints (/genai/*) - name: Bedrock Integration description: AWS Bedrock compatible API endpoints (/bedrock/*) - name: Cohere Integration description: Cohere compatible API endpoints (/cohere/*) - name: LiteLLM Integration description: LiteLLM proxy endpoints with multi-provider support (/litellm/*) - name: LangChain Integration description: LangChain compatible endpoints with multi-provider support (/langchain/*) - name: PydanticAI Integration description: >- PydanticAI compatible endpoints with multi-provider support (/pydanticai/*) - name: Health description: Health check endpoints - name: Configuration description: Configuration management endpoints - name: Session description: Session and authentication endpoints - name: Providers description: Provider management endpoints - name: Plugins description: Plugin management endpoints - name: MCP description: Model Context Protocol endpoints - name: Governance description: Virtual keys, teams, and customers management - name: Routing description: Routing rules and complexity analyzer configuration - name: Logging description: Log search and management endpoints - name: Cache description: Cache management endpoints - name: Vault description: Vault secret management endpoints - name: Skills description: Skills Repository management, marketplace, and download endpoints - name: Audit Logs description: >- CADF-compliant audit log search, export, and signature verification endpoints - name: Webhooks description: Webhook endpoint management and signed async-job delivery history - name: Notifications description: >- Role-targeted dashboard notifications, delivered over the dashboard WebSocket paths: /api/notifications: post: tags: - Notifications summary: Publish a dashboard notification description: > Persists a notification and pushes it over the dashboard WebSocket to every connected client the audience covers. Administrators only. Reading is open to any authenticated user because a caller only ever receives rows their role already entitles them to, but a single publish reaches every dashboard user on the deployment, so it is restricted to the local admin. On a deployment with dashboard auth disabled every request is treated as local admin. Notifications expire 30 days after creation and are pruned hourly. operationId: createNotification requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NotificationInput' responses: '201': description: Notification published and broadcast content: application/json: schema: $ref: '#/components/schemas/Notification' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BifrostError' '403': description: Forbidden — authenticated, but not permitted to perform this action content: application/json: schema: $ref: '#/components/schemas/BifrostError' '503': description: Config store not available content: application/json: schema: $ref: '#/components/schemas/BifrostError' security: - ManagementBearerAuth: [] components: schemas: NotificationInput: type: object description: | A notification to publish. IDs and both timestamps are assigned by the server and cannot be supplied. required: - audience - severity - title - message properties: audience: $ref: '#/components/schemas/NotificationAudience' role_ids: type: array description: | Required when `audience` is `roles`, and must be empty otherwise. Duplicates are removed and the list is sorted before it is stored. items: type: integer format: int64 minimum: 1 severity: $ref: '#/components/schemas/NotificationSeverity' title: type: string description: Trimmed before validation. minLength: 1 maxLength: 160 message: type: string description: Trimmed before validation. minLength: 1 maxLength: 4000 action_label: type: string description: | Label for the notification's action. Must be supplied together with `action_path`, or not at all. action_path: type: string description: > Dashboard-internal absolute path the action opens, for example `/workspace/providers`. Absolute URLs, host-relative `//` paths, and anything not starting with `/` are rejected, so a notification cannot be used to send users off-site. pattern: ^/(?!/).* Notification: type: object description: A persisted dashboard notification. required: - id - audience - severity - title - message - created_at - expires_at properties: id: type: string format: uuid audience: $ref: '#/components/schemas/NotificationAudience' role_ids: type: array items: type: integer format: int64 severity: $ref: '#/components/schemas/NotificationSeverity' title: type: string message: type: string action_label: type: string action_path: type: string created_at: type: string format: date-time expires_at: type: string format: date-time description: > Always 30 days after `created_at`. Expired rows are pruned hourly and are not returned once pruned. BifrostError: type: object description: Error response from Bifrost properties: event_id: type: string type: type: string is_bifrost_error: type: boolean status_code: type: integer error: $ref: '#/components/schemas/ErrorField' extra_fields: $ref: '#/components/schemas/BifrostErrorExtraFields' NotificationAudience: type: string description: > Who the notification reaches. `all` is every dashboard user; `roles` limits it to the listed RBAC roles, enforced on both the list endpoint and the WebSocket fan-out. enum: - all - roles NotificationSeverity: type: string description: Visual weight the dashboard gives the notification. enum: - info - success - warning - error ErrorField: type: object properties: type: type: string code: type: string message: type: string param: type: string event_id: type: string BifrostErrorExtraFields: type: object properties: provider: $ref: '#/components/schemas/ModelProvider' model_requested: type: string request_type: type: string ModelProvider: type: string description: AI model provider identifier enum: - openai - azure - anthropic - bedrock - cohere - vertex - vllm - mistral - ollama - groq - sgl - parasail - perplexity - replicate - cerebras - deepseek - gemini - openrouter - elevenlabs - huggingface - nebius - xai - runway - fireworks securitySchemes: BearerAuth: type: http scheme: bearer description: > Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with `sk-bf-`) can also be passed here. BasicAuth: type: http scheme: basic description: | Basic authentication using username and password. ApiKeyAuth: type: apiKey in: header name: x-api-key description: | API key authentication via the `x-api-key` header. Virtual keys (prefixed with `sk-bf-`) can also be passed here. ManagementBearerAuth: type: http scheme: bearer description: > Management API authentication for `/api/*` endpoints. Use the `Authorization` header with `Bearer `. Virtual keys, dashboard/user/session tokens, and `x-api-key` headers are not supported on management APIs. ````