> ## 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. # Delete a key from a provider > Deletes a key from the specified provider. Returns the deleted key. ## OpenAPI ````yaml /openapi/openapi.json delete /api/providers/{provider}/keys/{key_id} 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/providers/{provider}/keys/{key_id}: delete: tags: - Providers summary: Delete a key from a provider description: Deletes a key from the specified provider. Returns the deleted key. operationId: deleteProviderKey parameters: - name: provider in: path required: true description: Provider name schema: type: string - name: key_id in: path required: true description: Key ID schema: type: string responses: '200': description: Key deleted successfully content: application/json: schema: $ref: '#/components/schemas/Key' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BifrostError' '404': description: Provider or key not found content: application/json: schema: $ref: '#/components/schemas/BifrostError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/BifrostError' components: schemas: Key: type: object description: API key configuration properties: id: type: string description: Unique identifier for the key name: type: string description: Name of the key value: type: object description: API key value (redacted in responses) properties: value: type: string env_var: type: string from_env: type: boolean models: type: array items: type: string description: List of models this key can access (whitelist) blacklisted_models: type: array items: type: string description: List of models this key cannot access (blacklist) weight: type: number description: Weight for load balancing aliases: type: object propertyNames: minLength: 1 additionalProperties: type: string minLength: 1 description: >- Model alias mappings - maps a user-facing model name to a provider-specific identifier (deployment name, inference profile ID, fine-tuned model ID, etc.) azure_key_config: type: object description: Azure-specific key configuration properties: endpoint: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean api_version: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean client_id: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean client_secret: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean tenant_id: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean scopes: type: array items: type: string description: List of scopes to use for authentication vertex_key_config: type: object description: Vertex-specific key configuration properties: project_id: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean project_number: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean region: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean auth_credentials: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean bedrock_key_config: type: object description: AWS Bedrock-specific key configuration properties: access_key: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean secret_key: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean session_token: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean region: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean arn: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean batch_s3_config: type: object properties: buckets: type: array items: type: object properties: bucket_name: type: string prefix: type: string is_default: type: boolean vllm_key_config: type: object description: VLLM-specific key configuration properties: url: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean model_name: type: string required: - url ollama_key_config: type: object description: Ollama-specific key configuration properties: url: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean required: - url sgl_key_config: type: object description: SGLang-specific key configuration properties: url: type: object description: Environment variable configuration properties: value: type: string env_var: type: string from_env: type: boolean required: - url replicate_key_config: type: object description: Replicate-specific key configuration properties: use_deployments_endpoint: type: boolean description: >- Whether to use the deployments endpoint instead of the models endpoint enabled: type: boolean description: Whether the key is active (defaults to true) use_for_batch_api: type: boolean description: Whether this key can be used for batch API operations config_hash: type: string description: Hash of config.json version, used for change detection status: type: string description: Status of key (e.g., success, list_models_failed) description: type: string description: Error or status description for the key 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. ````