> ## 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 gateway agent card > Accepts a Bifrost virtual key in x-bf-vk, Authorization: Bearer, x-api-key, or x-goog-api-key. Authentication is required when enforce_auth_on_inference is enabled. An explicitly supplied invalid key is rejected even when authentication is optional. Access remains subject to agent grants and governance policy. Returns the card with gateway interfaces and downstream security metadata. Unknown or disabled agents return 404. Responses require private cache revalidation. ## OpenAPI ````yaml /openapi/openapi.json get /agents/a2a/{name}/.well-known/agent-card.json 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: Agent Gateway description: >- Agent registrations, A2A protocol calls, push callbacks, and operation history - 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: Decisions description: Structured decisions evaluated against annotated function-tool definitions - 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: Typesafe Integration description: Typesafe compatible API endpoints (/typesafe/*) - 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 - name: Background Jobs description: >- Status, progress and cancellation of durable background jobs (cost recalculation, Warp log indexing, and others) - name: Warp description: >- Configuration for Warp, the dashboard agent that answers questions about the deployment's own telemetry paths: /agents/a2a/{name}/.well-known/agent-card.json: get: tags: - Agent Gateway summary: Get gateway agent card description: >- Accepts a Bifrost virtual key in x-bf-vk, Authorization: Bearer, x-api-key, or x-goog-api-key. Authentication is required when enforce_auth_on_inference is enabled. An explicitly supplied invalid key is rejected even when authentication is optional. Access remains subject to agent grants and governance policy. Returns the card with gateway interfaces and downstream security metadata. Unknown or disabled agents return 404. Responses require private cache revalidation. operationId: agent_card_get parameters: - name: name in: path required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/A2AAgentCard' '401': description: Authentication required; empty body. '404': description: Unknown or disabled agent; empty body. security: - VirtualKeyAuth: [] - VirtualKeyBearerAuth: [] - VirtualKeyApiKeyAuth: [] - VirtualKeyGoogleAuth: [] - {} components: schemas: A2AAgentCard: type: object properties: supportedInterfaces: type: array items: $ref: '#/components/schemas/A2AAgentInterface' capabilities: $ref: '#/components/schemas/A2AAgentCapabilities' defaultInputModes: type: array items: type: string defaultOutputModes: type: array items: type: string description: type: string documentationUrl: type: string iconUrl: type: string name: type: string provider: $ref: '#/components/schemas/A2AAgentProvider' securityRequirements: type: array items: type: object required: - schemes properties: schemes: type: object additionalProperties: type: array items: type: string securitySchemes: type: object additionalProperties: type: object description: >- A2A v1 security scheme with one of apiKeySecurityScheme, httpAuthSecurityScheme, mtlsSecurityScheme, oauth2SecurityScheme, or openIdConnectSecurityScheme. additionalProperties: true signatures: type: array items: $ref: '#/components/schemas/A2AAgentCardSignature' skills: type: array items: $ref: '#/components/schemas/A2AAgentSkill' version: type: string required: - supportedInterfaces - capabilities - defaultInputModes - defaultOutputModes - description - name - skills - version A2AAgentInterface: type: object properties: url: type: string protocolBinding: type: string tenant: type: string protocolVersion: type: string required: - url - protocolBinding - protocolVersion A2AAgentCapabilities: type: object properties: extensions: type: array items: $ref: '#/components/schemas/A2AAgentExtension' pushNotifications: type: boolean streaming: type: boolean extendedAgentCard: type: boolean A2AAgentProvider: type: object properties: organization: type: string url: type: string required: - organization - url A2AAgentCardSignature: type: object properties: header: type: object additionalProperties: {} protected: type: string signature: type: string required: - protected - signature A2AAgentSkill: type: object properties: description: type: string examples: type: array items: type: string id: type: string inputModes: type: array items: type: string name: type: string outputModes: type: array items: type: string securityRequirements: type: array items: type: object required: - schemes properties: schemes: type: object additionalProperties: type: array items: type: string tags: type: array items: type: string required: - description - id - name - tags A2AAgentExtension: type: object properties: description: type: string params: type: object additionalProperties: {} required: type: boolean uri: type: string 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 the Bifrost admin username and password (`auth_config.admin_username` / `auth_config.admin_password`). Accepted on management APIs (`/api/*`, `/metrics`, `/ws`) only - the inference middleware never validates Basic credentials. 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. VirtualKeyAuth: type: apiKey in: header name: x-bf-vk description: > Bifrost Virtual Key for governance, routing, and access control. Supported on all inference endpoints (`/v1/*`, `/openai/*`, `/anthropic/*`, `/bedrock/*`, `/cohere/*`, `/genai/*`, `/langchain/*`, `/litellm/*`, `/pydanticai/*`, `/mcp`), not on management APIs (`/api/*`) - with the single exception of the self-service `GET /api/governance/virtual-keys/quota`, where the virtual key is the credential. Example: `sk-bf-*` prefixed keys. VirtualKeyBearerAuth: type: http scheme: bearer description: > Virtual key passed as a bearer token. The value MUST be an `sk-bf-` prefixed Bifrost virtual key - provider API keys and Bifrost management/session tokens are not accepted on endpoints that use this scheme. VirtualKeyApiKeyAuth: type: apiKey in: header name: x-api-key description: > Virtual key passed via the `x-api-key` header. The value MUST be `sk-bf-` prefixed; provider API keys are not accepted on endpoints that use this scheme. VirtualKeyGoogleAuth: type: apiKey in: header name: x-goog-api-key description: > Virtual key passed via the Google GenAI `x-goog-api-key` header. The value MUST be `sk-bf-` prefixed. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.