Error
A valid request URL is required to generate request examples{
"keys": [
{
"id": "<string>",
"name": "<string>",
"value": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"models": [
"<string>"
],
"blacklisted_models": [
"<string>"
],
"weight": 123,
"aliases": {},
"azure_key_config": {
"endpoint": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"api_version": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"client_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"client_secret": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"tenant_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"scopes": [
"<string>"
]
},
"vertex_key_config": {
"project_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"project_number": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"region": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"auth_credentials": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
}
},
"bedrock_key_config": {
"access_key": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"secret_key": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"session_token": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"region": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"arn": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"batch_s3_config": {
"buckets": [
{
"bucket_name": "<string>",
"prefix": "<string>",
"is_default": true
}
]
}
},
"vllm_key_config": {
"url": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"model_name": "<string>"
},
"ollama_key_config": {
"url": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
}
},
"sgl_key_config": {
"url": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
}
},
"replicate_key_config": {
"use_deployments_endpoint": true
},
"enabled": true,
"use_for_batch_api": true,
"config_hash": "<string>",
"status": "<string>",
"description": "<string>"
}
],
"total": 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": {
"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>"
}
}{
"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
List keys for a provider
Returns all keys configured for a specific provider.
GET
/
api
/
providers
/
{provider}
/
keys
Error
A valid request URL is required to generate request examples{
"keys": [
{
"id": "<string>",
"name": "<string>",
"value": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"models": [
"<string>"
],
"blacklisted_models": [
"<string>"
],
"weight": 123,
"aliases": {},
"azure_key_config": {
"endpoint": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"api_version": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"client_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"client_secret": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"tenant_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"scopes": [
"<string>"
]
},
"vertex_key_config": {
"project_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"project_number": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"region": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"auth_credentials": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
}
},
"bedrock_key_config": {
"access_key": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"secret_key": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"session_token": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"region": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"arn": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"batch_s3_config": {
"buckets": [
{
"bucket_name": "<string>",
"prefix": "<string>",
"is_default": true
}
]
}
},
"vllm_key_config": {
"url": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"model_name": "<string>"
},
"ollama_key_config": {
"url": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
}
},
"sgl_key_config": {
"url": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
}
},
"replicate_key_config": {
"use_deployments_endpoint": true
},
"enabled": true,
"use_for_batch_api": true,
"config_hash": "<string>",
"status": "<string>",
"description": "<string>"
}
],
"total": 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": {
"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>"
}
}{
"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
How permissions work
| Permission | Granted via |
|---|---|
ModelProvider:View | RBAC role or API key scope |
Authorizations
ManagementBearerAuthBasicAuth
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. See Required permissions for how permissions are derived and which endpoints are exempt.
Path Parameters
Provider name
Was this page helpful?