A valid request URL is required to generate request examples{
"name": "anthropic",
"network_config": {
"base_url": "<string>",
"extra_headers": {},
"extra_headers_secret_vars": {},
"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>",
"stream_idle_timeout_in_seconds": 1,
"keep_alive_timeout_in_seconds": 1,
"max_conns_per_host": 1,
"enforce_http2": true,
"http2_ping_interval_in_seconds": 1,
"beta_header_overrides": {},
"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,
"ignore_provider_cost": true,
"custom_provider_config": {
"is_key_less": true,
"does_not_send_done_marker": true,
"wait_for_usage": true,
"base_provider_type": "anthropic",
"allowed_requests": {
"list_models": true,
"model_retrieve": true,
"text_completion": true,
"text_completion_stream": true,
"chat_completion": true,
"chat_completion_stream": true,
"responses": true,
"responses_stream": true,
"responses_retrieve": true,
"responses_delete": true,
"responses_cancel": true,
"responses_input_items": true,
"count_tokens": true,
"compaction": true,
"embedding": true,
"rerank": true,
"decisions": true,
"ocr": true,
"speech": true,
"speech_stream": true,
"transcription": true,
"transcription_stream": true,
"image_generation": true,
"image_generation_stream": true,
"image_edit": true,
"image_edit_stream": true,
"image_variation": true,
"video_generation": true,
"video_edit": true,
"video_retrieve": true,
"video_download": true,
"video_delete": true,
"video_list": true,
"video_remix": true,
"batch_create": true,
"batch_list": true,
"batch_retrieve": true,
"batch_cancel": true,
"batch_delete": true,
"batch_results": true,
"file_upload": true,
"file_list": true,
"file_retrieve": true,
"file_delete": true,
"file_content": true,
"container_create": true,
"container_list": true,
"container_retrieve": true,
"container_delete": true,
"container_file_create": true,
"container_file_list": true,
"container_file_retrieve": true,
"container_file_content": true,
"container_file_delete": true,
"passthrough": true,
"passthrough_stream": true,
"websocket_responses": true,
"realtime": true,
"live": true,
"cached_content_create": true,
"cached_content_list": true,
"cached_content_retrieve": true,
"cached_content_update": true,
"cached_content_delete": true
},
"request_path_overrides": {}
},
"openai_config": {
"disable_store": false
},
"prompt_cache": {
"auto_inject": true,
"ttl": "1h",
"cache_control_injection_points": [
{
"location": "message",
"role": "system",
"index": 123
}
]
},
"injected_tools": [
{
"name": "<string>",
"mcp_client_name": "<string>",
"tool_name": "<string>"
}
],
"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": {
"routing_info": {
"provider": "anthropic",
"model": "<string>",
"key": "<string>",
"resolved_key_alias": {
"model_id": "<string>",
"model_name": "<string>",
"model_family": "<string>"
},
"is_fallback": true,
"primary_provider": "anthropic",
"primary_model": "<string>",
"requested_provider": "anthropic",
"requested_model": "<string>",
"server_side_fallback_model": "<string>"
},
"provider": "anthropic",
"original_model_requested": "<string>",
"resolved_model_used": "<string>",
"request_type": "<string>",
"mcp_request_type": "<string>",
"a2a_request_type": "<string>",
"a2a_agent_name": "<string>",
"error_type": "<string>",
"retry_after_ms": 150500,
"raw_request": "<unknown>",
"raw_response": "<unknown>",
"converted_request_type": "<string>",
"dropped_compat_plugin_params": [
"<string>"
],
"latency": 123,
"key_statuses": [
{
"key_id": "<string>",
"status": "success",
"provider": "anthropic",
"error": "<unknown>"
}
],
"fallback_attempts": [
{
"provider": "anthropic",
"model": "<string>",
"status_code": 123,
"type": "<string>",
"message": "<string>",
"skipped": true
}
],
"mcp_auth_required": {
"kind": "<string>",
"mcp_client_id": "<string>",
"mcp_client_name": "<string>",
"message": "<string>",
"authorize_url": "<string>",
"session_id": "<string>",
"subject_token_missing": true,
"exchange_error": "<string>"
},
"billed_usage": {
"prompt_tokens": 123,
"prompt_tokens_details": {
"text_tokens": 123,
"audio_tokens": 123,
"image_tokens": 123,
"cached_read_tokens": 123,
"cached_write_tokens": 123
},
"completion_tokens": 123,
"completion_tokens_details": {
"text_tokens": 123,
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"citation_tokens": 123,
"num_search_queries": 123,
"reasoning_tokens": 123,
"image_tokens": 123,
"rejected_prediction_tokens": 123
},
"total_tokens": 123,
"tool_usage": {
"web_search": {
"num_requests": 123
}
},
"cost": {
"input_tokens_cost": 123,
"output_tokens_cost": 123,
"reasoning_tokens_cost": 123,
"citation_tokens_cost": 123,
"search_queries_cost": 123,
"request_cost": 123,
"total_cost": 123
}
}
}
}{
"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": {
"routing_info": {
"provider": "anthropic",
"model": "<string>",
"key": "<string>",
"resolved_key_alias": {
"model_id": "<string>",
"model_name": "<string>",
"model_family": "<string>"
},
"is_fallback": true,
"primary_provider": "anthropic",
"primary_model": "<string>",
"requested_provider": "anthropic",
"requested_model": "<string>",
"server_side_fallback_model": "<string>"
},
"provider": "anthropic",
"original_model_requested": "<string>",
"resolved_model_used": "<string>",
"request_type": "<string>",
"mcp_request_type": "<string>",
"a2a_request_type": "<string>",
"a2a_agent_name": "<string>",
"error_type": "<string>",
"retry_after_ms": 150500,
"raw_request": "<unknown>",
"raw_response": "<unknown>",
"converted_request_type": "<string>",
"dropped_compat_plugin_params": [
"<string>"
],
"latency": 123,
"key_statuses": [
{
"key_id": "<string>",
"status": "success",
"provider": "anthropic",
"error": "<unknown>"
}
],
"fallback_attempts": [
{
"provider": "anthropic",
"model": "<string>",
"status_code": 123,
"type": "<string>",
"message": "<string>",
"skipped": true
}
],
"mcp_auth_required": {
"kind": "<string>",
"mcp_client_id": "<string>",
"mcp_client_name": "<string>",
"message": "<string>",
"authorize_url": "<string>",
"session_id": "<string>",
"subject_token_missing": true,
"exchange_error": "<string>"
},
"billed_usage": {
"prompt_tokens": 123,
"prompt_tokens_details": {
"text_tokens": 123,
"audio_tokens": 123,
"image_tokens": 123,
"cached_read_tokens": 123,
"cached_write_tokens": 123
},
"completion_tokens": 123,
"completion_tokens_details": {
"text_tokens": 123,
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"citation_tokens": 123,
"num_search_queries": 123,
"reasoning_tokens": 123,
"image_tokens": 123,
"rejected_prediction_tokens": 123
},
"total_tokens": 123,
"tool_usage": {
"web_search": {
"num_requests": 123
}
},
"cost": {
"input_tokens_cost": 123,
"output_tokens_cost": 123,
"reasoning_tokens_cost": 123,
"citation_tokens_cost": 123,
"search_queries_cost": 123,
"request_cost": 123,
"total_cost": 123
}
}
}
}{
"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": {
"routing_info": {
"provider": "anthropic",
"model": "<string>",
"key": "<string>",
"resolved_key_alias": {
"model_id": "<string>",
"model_name": "<string>",
"model_family": "<string>"
},
"is_fallback": true,
"primary_provider": "anthropic",
"primary_model": "<string>",
"requested_provider": "anthropic",
"requested_model": "<string>",
"server_side_fallback_model": "<string>"
},
"provider": "anthropic",
"original_model_requested": "<string>",
"resolved_model_used": "<string>",
"request_type": "<string>",
"mcp_request_type": "<string>",
"a2a_request_type": "<string>",
"a2a_agent_name": "<string>",
"error_type": "<string>",
"retry_after_ms": 150500,
"raw_request": "<unknown>",
"raw_response": "<unknown>",
"converted_request_type": "<string>",
"dropped_compat_plugin_params": [
"<string>"
],
"latency": 123,
"key_statuses": [
{
"key_id": "<string>",
"status": "success",
"provider": "anthropic",
"error": "<unknown>"
}
],
"fallback_attempts": [
{
"provider": "anthropic",
"model": "<string>",
"status_code": 123,
"type": "<string>",
"message": "<string>",
"skipped": true
}
],
"mcp_auth_required": {
"kind": "<string>",
"mcp_client_id": "<string>",
"mcp_client_name": "<string>",
"message": "<string>",
"authorize_url": "<string>",
"session_id": "<string>",
"subject_token_missing": true,
"exchange_error": "<string>"
},
"billed_usage": {
"prompt_tokens": 123,
"prompt_tokens_details": {
"text_tokens": 123,
"audio_tokens": 123,
"image_tokens": 123,
"cached_read_tokens": 123,
"cached_write_tokens": 123
},
"completion_tokens": 123,
"completion_tokens_details": {
"text_tokens": 123,
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"citation_tokens": 123,
"num_search_queries": 123,
"reasoning_tokens": 123,
"image_tokens": 123,
"rejected_prediction_tokens": 123
},
"total_tokens": 123,
"tool_usage": {
"web_search": {
"num_requests": 123
}
},
"cost": {
"input_tokens_cost": 123,
"output_tokens_cost": 123,
"reasoning_tokens_cost": 123,
"citation_tokens_cost": 123,
"search_queries_cost": 123,
"request_cost": 123,
"total_cost": 123
}
}
}
}Delete a provider
Removes a provider from the configuration.
A valid request URL is required to generate request examples{
"name": "anthropic",
"network_config": {
"base_url": "<string>",
"extra_headers": {},
"extra_headers_secret_vars": {},
"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>",
"stream_idle_timeout_in_seconds": 1,
"keep_alive_timeout_in_seconds": 1,
"max_conns_per_host": 1,
"enforce_http2": true,
"http2_ping_interval_in_seconds": 1,
"beta_header_overrides": {},
"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,
"ignore_provider_cost": true,
"custom_provider_config": {
"is_key_less": true,
"does_not_send_done_marker": true,
"wait_for_usage": true,
"base_provider_type": "anthropic",
"allowed_requests": {
"list_models": true,
"model_retrieve": true,
"text_completion": true,
"text_completion_stream": true,
"chat_completion": true,
"chat_completion_stream": true,
"responses": true,
"responses_stream": true,
"responses_retrieve": true,
"responses_delete": true,
"responses_cancel": true,
"responses_input_items": true,
"count_tokens": true,
"compaction": true,
"embedding": true,
"rerank": true,
"decisions": true,
"ocr": true,
"speech": true,
"speech_stream": true,
"transcription": true,
"transcription_stream": true,
"image_generation": true,
"image_generation_stream": true,
"image_edit": true,
"image_edit_stream": true,
"image_variation": true,
"video_generation": true,
"video_edit": true,
"video_retrieve": true,
"video_download": true,
"video_delete": true,
"video_list": true,
"video_remix": true,
"batch_create": true,
"batch_list": true,
"batch_retrieve": true,
"batch_cancel": true,
"batch_delete": true,
"batch_results": true,
"file_upload": true,
"file_list": true,
"file_retrieve": true,
"file_delete": true,
"file_content": true,
"container_create": true,
"container_list": true,
"container_retrieve": true,
"container_delete": true,
"container_file_create": true,
"container_file_list": true,
"container_file_retrieve": true,
"container_file_content": true,
"container_file_delete": true,
"passthrough": true,
"passthrough_stream": true,
"websocket_responses": true,
"realtime": true,
"live": true,
"cached_content_create": true,
"cached_content_list": true,
"cached_content_retrieve": true,
"cached_content_update": true,
"cached_content_delete": true
},
"request_path_overrides": {}
},
"openai_config": {
"disable_store": false
},
"prompt_cache": {
"auto_inject": true,
"ttl": "1h",
"cache_control_injection_points": [
{
"location": "message",
"role": "system",
"index": 123
}
]
},
"injected_tools": [
{
"name": "<string>",
"mcp_client_name": "<string>",
"tool_name": "<string>"
}
],
"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": {
"routing_info": {
"provider": "anthropic",
"model": "<string>",
"key": "<string>",
"resolved_key_alias": {
"model_id": "<string>",
"model_name": "<string>",
"model_family": "<string>"
},
"is_fallback": true,
"primary_provider": "anthropic",
"primary_model": "<string>",
"requested_provider": "anthropic",
"requested_model": "<string>",
"server_side_fallback_model": "<string>"
},
"provider": "anthropic",
"original_model_requested": "<string>",
"resolved_model_used": "<string>",
"request_type": "<string>",
"mcp_request_type": "<string>",
"a2a_request_type": "<string>",
"a2a_agent_name": "<string>",
"error_type": "<string>",
"retry_after_ms": 150500,
"raw_request": "<unknown>",
"raw_response": "<unknown>",
"converted_request_type": "<string>",
"dropped_compat_plugin_params": [
"<string>"
],
"latency": 123,
"key_statuses": [
{
"key_id": "<string>",
"status": "success",
"provider": "anthropic",
"error": "<unknown>"
}
],
"fallback_attempts": [
{
"provider": "anthropic",
"model": "<string>",
"status_code": 123,
"type": "<string>",
"message": "<string>",
"skipped": true
}
],
"mcp_auth_required": {
"kind": "<string>",
"mcp_client_id": "<string>",
"mcp_client_name": "<string>",
"message": "<string>",
"authorize_url": "<string>",
"session_id": "<string>",
"subject_token_missing": true,
"exchange_error": "<string>"
},
"billed_usage": {
"prompt_tokens": 123,
"prompt_tokens_details": {
"text_tokens": 123,
"audio_tokens": 123,
"image_tokens": 123,
"cached_read_tokens": 123,
"cached_write_tokens": 123
},
"completion_tokens": 123,
"completion_tokens_details": {
"text_tokens": 123,
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"citation_tokens": 123,
"num_search_queries": 123,
"reasoning_tokens": 123,
"image_tokens": 123,
"rejected_prediction_tokens": 123
},
"total_tokens": 123,
"tool_usage": {
"web_search": {
"num_requests": 123
}
},
"cost": {
"input_tokens_cost": 123,
"output_tokens_cost": 123,
"reasoning_tokens_cost": 123,
"citation_tokens_cost": 123,
"search_queries_cost": 123,
"request_cost": 123,
"total_cost": 123
}
}
}
}{
"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": {
"routing_info": {
"provider": "anthropic",
"model": "<string>",
"key": "<string>",
"resolved_key_alias": {
"model_id": "<string>",
"model_name": "<string>",
"model_family": "<string>"
},
"is_fallback": true,
"primary_provider": "anthropic",
"primary_model": "<string>",
"requested_provider": "anthropic",
"requested_model": "<string>",
"server_side_fallback_model": "<string>"
},
"provider": "anthropic",
"original_model_requested": "<string>",
"resolved_model_used": "<string>",
"request_type": "<string>",
"mcp_request_type": "<string>",
"a2a_request_type": "<string>",
"a2a_agent_name": "<string>",
"error_type": "<string>",
"retry_after_ms": 150500,
"raw_request": "<unknown>",
"raw_response": "<unknown>",
"converted_request_type": "<string>",
"dropped_compat_plugin_params": [
"<string>"
],
"latency": 123,
"key_statuses": [
{
"key_id": "<string>",
"status": "success",
"provider": "anthropic",
"error": "<unknown>"
}
],
"fallback_attempts": [
{
"provider": "anthropic",
"model": "<string>",
"status_code": 123,
"type": "<string>",
"message": "<string>",
"skipped": true
}
],
"mcp_auth_required": {
"kind": "<string>",
"mcp_client_id": "<string>",
"mcp_client_name": "<string>",
"message": "<string>",
"authorize_url": "<string>",
"session_id": "<string>",
"subject_token_missing": true,
"exchange_error": "<string>"
},
"billed_usage": {
"prompt_tokens": 123,
"prompt_tokens_details": {
"text_tokens": 123,
"audio_tokens": 123,
"image_tokens": 123,
"cached_read_tokens": 123,
"cached_write_tokens": 123
},
"completion_tokens": 123,
"completion_tokens_details": {
"text_tokens": 123,
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"citation_tokens": 123,
"num_search_queries": 123,
"reasoning_tokens": 123,
"image_tokens": 123,
"rejected_prediction_tokens": 123
},
"total_tokens": 123,
"tool_usage": {
"web_search": {
"num_requests": 123
}
},
"cost": {
"input_tokens_cost": 123,
"output_tokens_cost": 123,
"reasoning_tokens_cost": 123,
"citation_tokens_cost": 123,
"search_queries_cost": 123,
"request_cost": 123,
"total_cost": 123
}
}
}
}{
"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": {
"routing_info": {
"provider": "anthropic",
"model": "<string>",
"key": "<string>",
"resolved_key_alias": {
"model_id": "<string>",
"model_name": "<string>",
"model_family": "<string>"
},
"is_fallback": true,
"primary_provider": "anthropic",
"primary_model": "<string>",
"requested_provider": "anthropic",
"requested_model": "<string>",
"server_side_fallback_model": "<string>"
},
"provider": "anthropic",
"original_model_requested": "<string>",
"resolved_model_used": "<string>",
"request_type": "<string>",
"mcp_request_type": "<string>",
"a2a_request_type": "<string>",
"a2a_agent_name": "<string>",
"error_type": "<string>",
"retry_after_ms": 150500,
"raw_request": "<unknown>",
"raw_response": "<unknown>",
"converted_request_type": "<string>",
"dropped_compat_plugin_params": [
"<string>"
],
"latency": 123,
"key_statuses": [
{
"key_id": "<string>",
"status": "success",
"provider": "anthropic",
"error": "<unknown>"
}
],
"fallback_attempts": [
{
"provider": "anthropic",
"model": "<string>",
"status_code": 123,
"type": "<string>",
"message": "<string>",
"skipped": true
}
],
"mcp_auth_required": {
"kind": "<string>",
"mcp_client_id": "<string>",
"mcp_client_name": "<string>",
"message": "<string>",
"authorize_url": "<string>",
"session_id": "<string>",
"subject_token_missing": true,
"exchange_error": "<string>"
},
"billed_usage": {
"prompt_tokens": 123,
"prompt_tokens_details": {
"text_tokens": 123,
"audio_tokens": 123,
"image_tokens": 123,
"cached_read_tokens": 123,
"cached_write_tokens": 123
},
"completion_tokens": 123,
"completion_tokens_details": {
"text_tokens": 123,
"accepted_prediction_tokens": 123,
"audio_tokens": 123,
"citation_tokens": 123,
"num_search_queries": 123,
"reasoning_tokens": 123,
"image_tokens": 123,
"rejected_prediction_tokens": 123
},
"total_tokens": 123,
"tool_usage": {
"web_search": {
"num_requests": 123
}
},
"cost": {
"input_tokens_cost": 123,
"output_tokens_cost": 123,
"reasoning_tokens_cost": 123,
"citation_tokens_cost": 123,
"search_queries_cost": 123,
"request_cost": 123,
"total_cost": 123
}
}
}
}| Permission | Granted via |
|---|---|
ModelProvider:Delete | RBAC role or API key scope |
Authorizations
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 ofBasicAuth).
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.
OSS setup lock. On Bifrost OSS, while dashboard auth is not active (no admin account,
or auth disabled), every management endpoint except the public ones (/health,
/api/version, /api/session/is-auth-enabled, /api/session/login, ...) requires the
operator's setup token in the X-Bifrost-Setup-Token header, in place of Authorization.
The token is set with setup_token in config.json or the BIFROST_SETUP_TOKEN
environment variable. A missing header returns 401, a wrong token 403. The header
stops working once dashboard auth is enabled. The dashboard instead trades the token once
for an HttpOnly bifrost_setup_session cookie via POST /api/session/setup.
See Required permissions for how
permissions are derived and which endpoints are exempt.
Response
Provider deleted successfully
Provider configuration response
AI model provider identifier
anthropic, azure, bedrock, bedrock_mantle, sagemaker, 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, cloudflare, typesafe, minimax, byteplus, machgen, baseten, kimchi, soniox Was this page helpful?

