> ## 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. # Set a user's access-profile budget override > Sets or replaces the spending override on one budget of a single user's copy of an access profile. The override is additive — while it is active the budget is enforced against `max_limit + override_amount` — and it leaves the budget's base limit, current usage, and reset schedule untouched. Only this user is affected; the access profile template and every other user assigned to it keep their original limits. Use `mode: cycles` with a `cycles` count to grant extra spend for a finite number of reset windows (the current window counts as the first), or `mode: forever` to keep the override until it is deleted. A finite grant is anchored to the profile's reset window — calendar-aligned profiles anchor at the calendar period start — so every node in a cluster derives the same number of remaining cycles. The change is propagated cluster-wide and survives access-profile cloning and propagation. Requires the `AccessProfiles.Update` permission. `budget_id` must be a budget on the user's own copy of the profile, not on the shared template. ## OpenAPI ````yaml /openapi/openapi.json put /api/users/{target_user_id}/access-profiles/{profile_id}/budgets/{budget_id}/override 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: 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 paths: /api/users/{target_user_id}/access-profiles/{profile_id}/budgets/{budget_id}/override: put: tags: - Access Profiles summary: Set a user's access-profile budget override description: > Sets or replaces the spending override on one budget of a single user's copy of an access profile. The override is additive — while it is active the budget is enforced against `max_limit + override_amount` — and it leaves the budget's base limit, current usage, and reset schedule untouched. Only this user is affected; the access profile template and every other user assigned to it keep their original limits. Use `mode: cycles` with a `cycles` count to grant extra spend for a finite number of reset windows (the current window counts as the first), or `mode: forever` to keep the override until it is deleted. A finite grant is anchored to the profile's reset window — calendar-aligned profiles anchor at the calendar period start — so every node in a cluster derives the same number of remaining cycles. The change is propagated cluster-wide and survives access-profile cloning and propagation. Requires the `AccessProfiles.Update` permission. `budget_id` must be a budget on the user's own copy of the profile, not on the shared template. operationId: updateUserAccessProfileBudgetOverride parameters: - name: target_user_id in: path required: true description: ID of the user whose access-profile budget is being overridden schema: type: string - name: profile_id in: path required: true description: ID of the access profile assigned to the user schema: type: integer - name: budget_id in: path required: true description: ID of a budget on the user's copy of the access profile schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BudgetOverrideRequest' responses: '200': description: Budget override applied successfully content: application/json: schema: $ref: '#/components/schemas/BudgetOverrideResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BifrostError' '404': description: >- User access profile or budget not found, or the profile is outside the caller's access scope '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/BifrostError' security: - ManagementBearerAuth: [] components: schemas: BudgetOverrideRequest: type: object description: > Replaces the active override on one budget. The override is additive: it does not change the budget's `max_limit`, `current_usage`, or reset schedule. Sending this request against a budget that already has an override replaces that override entirely. required: - amount - mode properties: amount: type: number description: >- Additional spend in dollars added on top of `max_limit` while the override is active. Must be greater than 0 and finite. mode: type: string description: > `cycles` keeps the override active for `cycles` reset windows starting with the current one. `forever` keeps it active until it is removed with a DELETE. enum: - cycles - forever cycles: type: integer description: > Number of reset windows the override stays active for, counting the current window as the first. Required and must be greater than 0 when `mode` is `cycles`; must be omitted or 0 when `mode` is `forever`. minimum: 1 BudgetOverrideResponse: type: object description: The persisted budget and the additive limit now in force. required: - budget - effective_max_limit properties: budget: $ref: '#/components/schemas/Budget' effective_max_limit: type: number description: >- `max_limit` plus `override_amount` while an override is active; equal to `max_limit` otherwise. 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' Budget: type: object description: Budget configuration required: - id - max_limit - reset_duration - last_reset - current_usage - config_hash - created_at - updated_at properties: id: type: string max_limit: type: number description: Maximum budget in dollars reset_duration: type: string description: Reset duration (e.g., "30s", "5m", "1h", "1d", "1w", "1M") calendar_aligned: type: boolean description: >- When true, resets align to calendar period boundaries in UTC (not rolling from last reset) default: false last_reset: type: string format: date-time current_usage: type: number override_amount: type: number description: >- Additional spend added on top of `max_limit` while the override is active. Omitted when no override is set. override_mode: type: string description: > How long the override stays active. `cycles` keeps it active for a finite number of reset windows; `forever` keeps it active until it is removed. Omitted when no override is set. enum: - cycles - forever override_cycles_remaining: type: integer description: > Reset windows the override is still valid for, including the current one. Positive only for `cycles` mode; recomputed from the original grant on every reset, never decremented in place. override_cycles_total: type: integer description: >- Number of reset windows the current `cycles` override was granted for. Immutable for the life of the grant. override_anchor_reset: type: string format: date-time description: >- Reset-window boundary at which the current `cycles` override was granted. Immutable for the life of the grant. team_id: type: string description: Team that owns this budget, when the budget is team-scoped virtual_key_id: type: string description: >- Virtual key that owns this budget, when the budget is virtual-key-scoped provider_config_id: type: integer description: >- Provider config that owns this budget, when the budget is provider-config-scoped config_hash: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time 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. ````