> ## 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. # Get configuration > Retrieves the current Bifrost configuration including client config, framework config, auth config, and connection status for various stores. ## OpenAPI ````yaml /openapi/openapi.json get /api/config 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: 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 paths: /api/config: get: tags: - Configuration summary: Get configuration description: > Retrieves the current Bifrost configuration including client config, framework config, auth config, and connection status for various stores. operationId: getConfig parameters: - name: from_db in: query description: If true, fetch configuration directly from the database schema: type: string enum: - 'true' - 'false' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetConfigResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/BifrostError' components: schemas: GetConfigResponse: type: object description: Configuration response properties: client_config: type: object description: Client configuration properties: drop_excess_requests: type: boolean description: Whether to drop excess requests when rate limited prometheus_labels: type: array items: type: string description: Custom Prometheus labels allowed_origins: type: array items: type: string description: Allowed CORS origins initial_pool_size: type: integer description: Initial connection pool size enable_logging: type: boolean description: Whether logging is enabled disable_content_logging: type: boolean description: Whether content logging is disabled allow_per_request_content_storage_override: type: boolean default: false description: >- Allow individual requests to override content storage via the x-bf-disable-content-logging header or context key. When false (default), per-request overrides are ignored. allow_per_request_raw_override: type: boolean default: false description: >- Allow individual requests to override raw request/response visibility via the x-bf-send-back-raw-request and x-bf-send-back-raw-response headers. When false (default), provider-level settings are authoritative and per-request overrides are ignored. enforce_auth_on_inference: type: boolean description: >- Whether to enforce virtual key authentication on inference requests enforce_governance_header: type: boolean deprecated: true description: 'Deprecated: use enforce_auth_on_inference instead' max_request_body_size_mb: type: integer description: Maximum request body size in MB compat: type: object description: Compat plugin configuration properties: convert_text_to_chat: type: boolean description: Convert text completion requests to chat convert_chat_to_responses: type: boolean description: Convert chat completion requests to responses should_drop_params: type: boolean description: Drop unsupported parameters based on model catalog should_convert_params: type: boolean default: false description: >- Converts model parameter values that are not supported by the model additionalProperties: false log_retention_days: type: integer description: Number of days to retain logs header_filter_config: type: object description: Header filter configuration properties: allowlist: type: array items: type: string denylist: type: array items: type: string mcp_agent_depth: type: integer description: Depth of MCP agent mcp_tool_execution_timeout: type: integer description: Timeout for MCP tool execution in seconds mcp_code_mode_binding_level: type: string description: Binding level for MCP code mode required_headers: type: array items: type: string description: >- Headers that must be present on every request. Requests missing any of these headers are rejected with 400. Case-insensitive matching. logging_headers: type: array items: type: string description: >- Headers to capture in log metadata. Values are extracted from incoming requests and stored in the metadata field of log entries. Case-insensitive matching. No restart required. mcp_external_base_url: oneOf: - type: string description: Plain URL or env var reference (e.g. "env.MY_VAR") - type: object properties: value: type: string env_var: type: string from_env: type: boolean additionalProperties: false description: > Public base URL for OAuth callbacks and discovery metadata when Bifrost runs behind a reverse proxy. Overrides the host derived from the incoming request. Supports env var syntax ("env.MY_VAR"). Configurable via UI, API, or config.json. framework_config: type: object description: Framework configuration properties: id: type: integer description: Unique identifier for the framework config pricing_url: type: string description: URL for pricing data pricing_sync_interval: type: integer format: int64 description: Pricing sync interval in seconds auth_config: type: object description: Authentication configuration properties: admin_username: type: string admin_password: type: string description: Password (redacted as in responses) is_enabled: type: boolean disable_auth_on_inference: type: boolean is_db_connected: type: boolean is_cache_connected: type: boolean is_logs_connected: type: boolean proxy_config: type: object description: Global proxy configuration properties: enabled: type: boolean type: type: string enum: - http - socks5 - tcp url: type: string username: type: string password: type: string description: Password (redacted as in responses) no_proxy: type: string timeout: type: integer skip_tls_verify: type: boolean enable_for_scim: type: boolean enable_for_inference: type: boolean enable_for_api: type: boolean restart_required: type: object description: Restart required configuration properties: required: type: boolean reason: type: string 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' 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 - 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. ````