Error

A valid request URL is required to generate request examples

{
  "name": "anthropic",
  "network_config": {
    "base_url": "<string>",
    "extra_headers": {},
    "default_request_timeout_in_seconds": 123,
    "max_retries": 123,
    "retry_backoff_initial": 123,
    "retry_backoff_max": 123,
    "insecure_skip_verify": true,
    "ca_cert_pem": "<string>",
    "allow_private_network": false
  },
  "concurrency_and_buffer_size": {
    "concurrency": 123,
    "buffer_size": 123
  },
  "proxy_config": {
    "type": "none",
    "url": "<string>",
    "username": "<string>",
    "password": "<string>",
    "ca_cert_pem": "<string>"
  },
  "send_back_raw_request": true,
  "send_back_raw_response": true,
  "store_raw_request_response": true,
  "custom_provider_config": {
    "is_key_less": true,
    "does_not_send_done_marker": true,
    "base_provider_type": "anthropic",
    "allowed_requests": {
      "list_models": true,
      "text_completion": true,
      "text_completion_stream": true,
      "chat_completion": true,
      "chat_completion_stream": true,
      "responses": true,
      "responses_stream": true,
      "count_tokens": true,
      "embedding": true,
      "speech": true,
      "speech_stream": true,
      "transcription": true,
      "transcription_stream": true,
      "image_generation": true,
      "image_generation_stream": true,
      "batch_create": true,
      "batch_list": true,
      "batch_retrieve": true,
      "batch_cancel": true,
      "batch_results": true,
      "file_upload": true,
      "file_list": true,
      "file_retrieve": true,
      "file_delete": true,
      "file_content": true
    },
    "request_path_overrides": {}
  },
  "prompt_cache": {
    "auto_inject": true,
    "ttl": "1h",
    "cache_control_injection_points": [
      {
        "location": "message",
        "role": "system",
        "index": 123
      }
    ]
  },
  "provider_status": "active",
  "status": "<string>",
  "description": "<string>",
  "config_hash": "<string>"
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>"
  }
}

Providers

Update a provider

Updates a provider’s configuration. Expects ALL fields to be provided, including both edited and non-edited fields. Partial updates are not supported. Changing network_config.base_url, or turning on network_config.allow_private_network (with or without a base URL), requires a genuinely authenticated admin session - it is refused with 403 if dashboard authentication is disabled or unconfigured, even though other management endpoints remain reachable in that state. The same applies to setting or changing proxy_config.url, proxy_config.ca_cert_pem, network_config.ca_cert_pem, or an absolute (scheme and host) custom_provider_config.request_path_overrides value, and to turning on network_config.insecure_skip_verify. Sending the stored values back unchanged (including redacted placeholders), clearing the base URL, proxy or an override, path-only overrides, or turning allow_private_network or insecure_skip_verify off is allowed.

PUT

api

providers

{provider}

Error

A valid request URL is required to generate request examples

{
  "name": "anthropic",
  "network_config": {
    "base_url": "<string>",
    "extra_headers": {},
    "default_request_timeout_in_seconds": 123,
    "max_retries": 123,
    "retry_backoff_initial": 123,
    "retry_backoff_max": 123,
    "insecure_skip_verify": true,
    "ca_cert_pem": "<string>",
    "allow_private_network": false
  },
  "concurrency_and_buffer_size": {
    "concurrency": 123,
    "buffer_size": 123
  },
  "proxy_config": {
    "type": "none",
    "url": "<string>",
    "username": "<string>",
    "password": "<string>",
    "ca_cert_pem": "<string>"
  },
  "send_back_raw_request": true,
  "send_back_raw_response": true,
  "store_raw_request_response": true,
  "custom_provider_config": {
    "is_key_less": true,
    "does_not_send_done_marker": true,
    "base_provider_type": "anthropic",
    "allowed_requests": {
      "list_models": true,
      "text_completion": true,
      "text_completion_stream": true,
      "chat_completion": true,
      "chat_completion_stream": true,
      "responses": true,
      "responses_stream": true,
      "count_tokens": true,
      "embedding": true,
      "speech": true,
      "speech_stream": true,
      "transcription": true,
      "transcription_stream": true,
      "image_generation": true,
      "image_generation_stream": true,
      "batch_create": true,
      "batch_list": true,
      "batch_retrieve": true,
      "batch_cancel": true,
      "batch_results": true,
      "file_upload": true,
      "file_list": true,
      "file_retrieve": true,
      "file_delete": true,
      "file_content": true
    },
    "request_path_overrides": {}
  },
  "prompt_cache": {
    "auto_inject": true,
    "ttl": "1h",
    "cache_control_injection_points": [
      {
        "location": "message",
        "role": "system",
        "index": 123
      }
    ]
  },
  "provider_status": "active",
  "status": "<string>",
  "description": "<string>",
  "config_hash": "<string>"
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "anthropic",
    "model_requested": "<string>",
    "request_type": "<string>",
    "error_type": "<string>"
  }
}

Required Permissions

Permission	Granted via
`ModelProvider:Update`	RBAC role or API key scope

How permissions work

Authorizations

Authorization

string

header

required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <token>, where <token> is one of:

a Bifrost management API key,
a dashboard session token issued by POST /api/session/login,
base64 of <admin-username>:<admin-password> (legacy equivalent of BasicAuth).

Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs - the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.

Authentication alone is not sufficient in Bifrost Enterprise: each operation page shows a Required Permissions table (Resource:Operation, for example Dashboard:View) above its Authorizations section, and the caller's RBAC role or management API key scopes must include what it lists, otherwise the request is rejected with 403 Forbidden.

A local admin — authenticated with the admin password, or any caller on a deployment with dashboard auth disabled — bypasses these checks and can call every management endpoint. See Required permissions for how permissions are derived and which endpoints are exempt.

Path Parameters

provider

string

required

Provider name

Body

application/json

Update provider request. Keys are managed separately via /api/providers/{provider}/keys.

network_config

object

Network configuration for provider connections

Show child attributes

concurrency_and_buffer_size

object

Concurrency settings

Show child attributes

proxy_config

object

Proxy configuration

Show child attributes

send_back_raw_request

boolean

send_back_raw_response

boolean

store_raw_request_response

boolean

custom_provider_config

object

Custom provider configuration

Show child attributes

prompt_cache

object

Synthesize prompt-cache breakpoints for requests that carry none. Off by default. Requests that already carry their own cache markers are never modified.

Show child attributes

Response

Provider updated successfully

Provider configuration response

name

enum<string>

AI model provider identifier

Available options:

anthropic,

azure,

bedrock,

bedrock_mantle,

cerebras,

cohere,

deepseek,

gemini,

groq,

mistral,

ollama,

opencode-go,

opencode-zen,

openai,

parasail,

perplexity,

sgl,

vertex,

openrouter,

elevenlabs,

huggingface,

nebius,

xai,

replicate,

vllm,

runway,

runware,

fireworks,

sarvam,

wafer,

databricks

network_config

object

Network configuration for provider connections

Show child attributes

concurrency_and_buffer_size

object

Concurrency settings

Show child attributes

proxy_config

object

Proxy configuration

Show child attributes

send_back_raw_request

boolean

send_back_raw_response

boolean

store_raw_request_response

boolean

custom_provider_config

object

Custom provider configuration

Show child attributes

prompt_cache

object

Synthesize prompt-cache breakpoints for requests that carry none. Off by default. Requests that already carry their own cache markers are never modified.

Show child attributes

provider_status

enum<string>

Status of the provider

Available options:

active,

error,

deleted

status

string

Operational status (e.g., list_models_failed)

description

string

Error/status description

config_hash

string

Hash of config.json version, used for change detection

Authentication

Inference

Integrations

Platform

Governance

Routing

Deprecated

Update a provider

Authorizations

Path Parameters

Body

Response