Error
A valid request URL is required to generate request examples{
"virtual_key_name": "<string>",
"is_active": true,
"budgets": [
{
"id": "<string>",
"max_limit": 123,
"reset_duration": "<string>",
"last_reset": "2023-11-07T05:31:56Z",
"current_usage": 123,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"per_model_usage": [
{
"model": "<string>",
"total_requests": 123,
"total_tokens": 123,
"total_cost": 123,
"provider": "<string>"
}
],
"calendar_aligned": false,
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
}
],
"rate_limit": {
"id": "<string>",
"token_current_usage": 123,
"token_last_reset": "2023-11-07T05:31:56Z",
"request_current_usage": 123,
"request_last_reset": "2023-11-07T05:31:56Z",
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"token_max_limit": 123,
"token_reset_duration": "<string>",
"request_max_limit": 123,
"request_reset_duration": "<string>"
},
"provider_configs": [
{
"id": 123,
"virtual_key_id": "<string>",
"provider": "<string>",
"weight": 123,
"allowed_models": [
"<string>"
],
"blacklisted_models": [
"<string>"
],
"allow_all_keys": true,
"keys": [
{
"id": 123,
"name": "<string>",
"provider_id": 123,
"provider": "<string>",
"key_id": "<string>",
"value": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"models": [
"<string>"
],
"weight": 123,
"enabled": true,
"use_for_batch_api": false,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"config_hash": "<string>",
"azure_endpoint": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"azure_client_id": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"azure_client_secret": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"azure_tenant_id": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"vertex_project_id": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"vertex_project_number": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"vertex_region": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"vertex_auth_credentials": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"bedrock_access_key": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"bedrock_secret_key": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"bedrock_session_token": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"bedrock_region": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"bedrock_arn": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
}
}
],
"rate_limit_id": "<string>",
"budgets": [
{
"id": "<string>",
"max_limit": 123,
"reset_duration": "<string>",
"last_reset": "2023-11-07T05:31:56Z",
"current_usage": 123,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"calendar_aligned": false,
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
}
],
"rate_limit": {
"id": "<string>",
"token_current_usage": 123,
"token_last_reset": "2023-11-07T05:31:56Z",
"request_current_usage": 123,
"request_last_reset": "2023-11-07T05:31:56Z",
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"token_max_limit": 123,
"token_reset_duration": "<string>",
"request_max_limit": 123,
"request_reset_duration": "<string>"
}
}
],
"model_configs": [
{
"model_name": "<string>",
"provider": "<string>",
"budgets": [
{
"id": "<string>",
"max_limit": 123,
"reset_duration": "<string>",
"last_reset": "2023-11-07T05:31:56Z",
"current_usage": 123,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"calendar_aligned": false,
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
}
],
"rate_limit": {
"id": "<string>",
"token_current_usage": 123,
"token_last_reset": "2023-11-07T05:31:56Z",
"request_current_usage": 123,
"request_last_reset": "2023-11-07T05:31:56Z",
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"token_max_limit": 123,
"token_reset_duration": "<string>",
"request_max_limit": 123,
"request_reset_duration": "<string>"
}
}
]
}{
"error": "<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": {
"model_requested": "<string>",
"request_type": "<string>"
}
}Governance
Get virtual key quota
Returns the overall budget and rate limit quota for the authenticated virtual key, as well as per-provider and per-model budgets and rate limits (with current usage). Each budget also carries the actual per-model usage for its current cycle. This is a self-service endpoint - no admin authentication required. The virtual key value itself (provided via header) is the credential.
GET
/
api
/
governance
/
virtual-keys
/
quota
Error
A valid request URL is required to generate request examples{
"virtual_key_name": "<string>",
"is_active": true,
"budgets": [
{
"id": "<string>",
"max_limit": 123,
"reset_duration": "<string>",
"last_reset": "2023-11-07T05:31:56Z",
"current_usage": 123,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"per_model_usage": [
{
"model": "<string>",
"total_requests": 123,
"total_tokens": 123,
"total_cost": 123,
"provider": "<string>"
}
],
"calendar_aligned": false,
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
}
],
"rate_limit": {
"id": "<string>",
"token_current_usage": 123,
"token_last_reset": "2023-11-07T05:31:56Z",
"request_current_usage": 123,
"request_last_reset": "2023-11-07T05:31:56Z",
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"token_max_limit": 123,
"token_reset_duration": "<string>",
"request_max_limit": 123,
"request_reset_duration": "<string>"
},
"provider_configs": [
{
"id": 123,
"virtual_key_id": "<string>",
"provider": "<string>",
"weight": 123,
"allowed_models": [
"<string>"
],
"blacklisted_models": [
"<string>"
],
"allow_all_keys": true,
"keys": [
{
"id": 123,
"name": "<string>",
"provider_id": 123,
"provider": "<string>",
"key_id": "<string>",
"value": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"models": [
"<string>"
],
"weight": 123,
"enabled": true,
"use_for_batch_api": false,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"config_hash": "<string>",
"azure_endpoint": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"azure_client_id": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"azure_client_secret": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"azure_tenant_id": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"vertex_project_id": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"vertex_project_number": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"vertex_region": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"vertex_auth_credentials": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"bedrock_access_key": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"bedrock_secret_key": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"bedrock_session_token": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"bedrock_region": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
},
"bedrock_arn": {
"value": "<string>",
"env_var": "<string>",
"from_env": true
}
}
],
"rate_limit_id": "<string>",
"budgets": [
{
"id": "<string>",
"max_limit": 123,
"reset_duration": "<string>",
"last_reset": "2023-11-07T05:31:56Z",
"current_usage": 123,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"calendar_aligned": false,
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
}
],
"rate_limit": {
"id": "<string>",
"token_current_usage": 123,
"token_last_reset": "2023-11-07T05:31:56Z",
"request_current_usage": 123,
"request_last_reset": "2023-11-07T05:31:56Z",
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"token_max_limit": 123,
"token_reset_duration": "<string>",
"request_max_limit": 123,
"request_reset_duration": "<string>"
}
}
],
"model_configs": [
{
"model_name": "<string>",
"provider": "<string>",
"budgets": [
{
"id": "<string>",
"max_limit": 123,
"reset_duration": "<string>",
"last_reset": "2023-11-07T05:31:56Z",
"current_usage": 123,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"calendar_aligned": false,
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
}
],
"rate_limit": {
"id": "<string>",
"token_current_usage": 123,
"token_last_reset": "2023-11-07T05:31:56Z",
"request_current_usage": 123,
"request_last_reset": "2023-11-07T05:31:56Z",
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"token_max_limit": 123,
"token_reset_duration": "<string>",
"request_max_limit": 123,
"request_reset_duration": "<string>"
}
}
]
}{
"error": "<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": {
"model_requested": "<string>",
"request_type": "<string>"
}
}Authorizations
VirtualKeyAuthBearerAuthApiKeyAuth
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/*).
Example: sk-bf-* prefixed keys.
Response
Successful response
Virtual key quota response (self-service, no admin auth required)
Name of the virtual key
Whether the virtual key is active
Overall budget quotas for this virtual key. Each budget also carries the actual per-model spend (from request logs) accumulated in its current cycle.
Show child attributes
Show child attributes
Rate limit configuration
Show child attributes
Show child attributes
Per-provider budget quotas and rate limits (provider-level splits and limits)
Show child attributes
Show child attributes
Per-model budget quotas and rate limits configured for this virtual key (model-level limits). Always an array — the endpoint fails closed (500) rather than returning null when the model-config lookup errors.
Show child attributes
Show child attributes
Was this page helpful?
⌘I