Error
A valid request URL is required to generate request examples{
"virtual_key": {
"id": "<string>",
"name": "<string>",
"value": "<string>",
"is_active": true,
"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>",
"ref": "<string>",
"type": "plain_text"
},
"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>",
"ref": "<string>",
"type": "plain_text"
},
"azure_client_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"azure_client_secret": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"azure_tenant_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"vertex_project_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"vertex_project_number": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"vertex_region": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"vertex_auth_credentials": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"bedrock_access_key": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"bedrock_secret_key": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"bedrock_session_token": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"bedrock_region": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"bedrock_arn": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
}
}
],
"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",
"reset_config": {
"quarter_start_month": 6
},
"calendar_aligned": false,
"override_amount": 123,
"override_mode": "cycles",
"override_cycles_remaining": 123,
"override_cycles_total": 123,
"override_anchor_reset": "2023-11-07T05:31:56Z",
"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>"
}
}
],
"mcp_configs": [
{
"id": 123,
"virtual_key_id": "<string>",
"mcp_client_id": 123,
"mcp_client": {
"client_id": "<string>",
"name": "<string>",
"is_code_mode_client": true,
"connection_type": "http",
"connection_string": "<string>",
"stdio_config": {
"command": "<string>",
"args": [
"<string>"
],
"envs": [
"<string>"
]
},
"tls_config": {
"insecure_skip_verify": true,
"ca_cert_pem": "<string>"
},
"auth_type": "none",
"oauth_config_id": "<string>",
"headers": {},
"tools_to_execute": [
"<string>"
],
"tools_to_auto_execute": [
"<string>"
],
"tool_pricing": {},
"allow_on_all_virtual_keys": false,
"per_user_header_keys": [
"<string>"
],
"token_exchange": {
"audience": "<string>",
"use_idp_credentials": true,
"client_id": "<string>",
"client_secret": "<string>",
"scopes": [
"<string>"
],
"authorization_server_url": "<string>"
},
"disabled": false
},
"tools_to_execute": [
"<string>"
]
}
],
"calendar_aligned": true,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"team_id": "<string>",
"customer_id": "<string>",
"rate_limit_id": "<string>",
"team": {
"id": "<string>",
"name": "<string>",
"customer_id": "<string>",
"customer": {
"id": "<string>",
"name": "<string>",
"budget_id": "<string>",
"budget": {
"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",
"reset_config": {
"quarter_start_month": 6
},
"calendar_aligned": false,
"override_amount": 123,
"override_mode": "cycles",
"override_cycles_remaining": 123,
"override_cycles_total": 123,
"override_anchor_reset": "2023-11-07T05:31:56Z",
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
},
"teams": "<array>",
"virtual_keys": "<array>",
"virtual_key_count": 123,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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",
"reset_config": {
"quarter_start_month": 6
},
"calendar_aligned": false,
"override_amount": 123,
"override_mode": "cycles",
"override_cycles_remaining": 123,
"override_cycles_total": 123,
"override_anchor_reset": "2023-11-07T05:31:56Z",
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
}
],
"virtual_keys": "<array>",
"profile": {},
"config": {},
"claims": {},
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"customer": {
"id": "<string>",
"name": "<string>",
"budget_id": "<string>",
"budget": {
"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",
"reset_config": {
"quarter_start_month": 6
},
"calendar_aligned": false,
"override_amount": 123,
"override_mode": "cycles",
"override_cycles_remaining": 123,
"override_cycles_total": 123,
"override_anchor_reset": "2023-11-07T05:31:56Z",
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
},
"teams": "<array>",
"virtual_keys": "<array>",
"virtual_key_count": 123,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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",
"reset_config": {
"quarter_start_month": 6
},
"calendar_aligned": false,
"override_amount": 123,
"override_mode": "cycles",
"override_cycles_remaining": 123,
"override_cycles_total": 123,
"override_anchor_reset": "2023-11-07T05:31:56Z",
"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>"
},
"created_by_user_id": "<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": "openai",
"model_requested": "<string>",
"request_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": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}Virtual Keys
Get virtual key
Returns a specific virtual key by ID.
GET
/
api
/
governance
/
virtual-keys
/
{vk_id}
Error
A valid request URL is required to generate request examples{
"virtual_key": {
"id": "<string>",
"name": "<string>",
"value": "<string>",
"is_active": true,
"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>",
"ref": "<string>",
"type": "plain_text"
},
"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>",
"ref": "<string>",
"type": "plain_text"
},
"azure_client_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"azure_client_secret": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"azure_tenant_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"vertex_project_id": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"vertex_project_number": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"vertex_region": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"vertex_auth_credentials": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"bedrock_access_key": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"bedrock_secret_key": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"bedrock_session_token": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"bedrock_region": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
},
"bedrock_arn": {
"value": "<string>",
"ref": "<string>",
"type": "plain_text"
}
}
],
"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",
"reset_config": {
"quarter_start_month": 6
},
"calendar_aligned": false,
"override_amount": 123,
"override_mode": "cycles",
"override_cycles_remaining": 123,
"override_cycles_total": 123,
"override_anchor_reset": "2023-11-07T05:31:56Z",
"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>"
}
}
],
"mcp_configs": [
{
"id": 123,
"virtual_key_id": "<string>",
"mcp_client_id": 123,
"mcp_client": {
"client_id": "<string>",
"name": "<string>",
"is_code_mode_client": true,
"connection_type": "http",
"connection_string": "<string>",
"stdio_config": {
"command": "<string>",
"args": [
"<string>"
],
"envs": [
"<string>"
]
},
"tls_config": {
"insecure_skip_verify": true,
"ca_cert_pem": "<string>"
},
"auth_type": "none",
"oauth_config_id": "<string>",
"headers": {},
"tools_to_execute": [
"<string>"
],
"tools_to_auto_execute": [
"<string>"
],
"tool_pricing": {},
"allow_on_all_virtual_keys": false,
"per_user_header_keys": [
"<string>"
],
"token_exchange": {
"audience": "<string>",
"use_idp_credentials": true,
"client_id": "<string>",
"client_secret": "<string>",
"scopes": [
"<string>"
],
"authorization_server_url": "<string>"
},
"disabled": false
},
"tools_to_execute": [
"<string>"
]
}
],
"calendar_aligned": true,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"team_id": "<string>",
"customer_id": "<string>",
"rate_limit_id": "<string>",
"team": {
"id": "<string>",
"name": "<string>",
"customer_id": "<string>",
"customer": {
"id": "<string>",
"name": "<string>",
"budget_id": "<string>",
"budget": {
"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",
"reset_config": {
"quarter_start_month": 6
},
"calendar_aligned": false,
"override_amount": 123,
"override_mode": "cycles",
"override_cycles_remaining": 123,
"override_cycles_total": 123,
"override_anchor_reset": "2023-11-07T05:31:56Z",
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
},
"teams": "<array>",
"virtual_keys": "<array>",
"virtual_key_count": 123,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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",
"reset_config": {
"quarter_start_month": 6
},
"calendar_aligned": false,
"override_amount": 123,
"override_mode": "cycles",
"override_cycles_remaining": 123,
"override_cycles_total": 123,
"override_anchor_reset": "2023-11-07T05:31:56Z",
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
}
],
"virtual_keys": "<array>",
"profile": {},
"config": {},
"claims": {},
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"customer": {
"id": "<string>",
"name": "<string>",
"budget_id": "<string>",
"budget": {
"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",
"reset_config": {
"quarter_start_month": 6
},
"calendar_aligned": false,
"override_amount": 123,
"override_mode": "cycles",
"override_cycles_remaining": 123,
"override_cycles_total": 123,
"override_anchor_reset": "2023-11-07T05:31:56Z",
"team_id": "<string>",
"virtual_key_id": "<string>",
"provider_config_id": 123
},
"teams": "<array>",
"virtual_keys": "<array>",
"virtual_key_count": 123,
"config_hash": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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",
"reset_config": {
"quarter_start_month": 6
},
"calendar_aligned": false,
"override_amount": 123,
"override_mode": "cycles",
"override_cycles_remaining": 123,
"override_cycles_total": 123,
"override_anchor_reset": "2023-11-07T05:31:56Z",
"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>"
},
"created_by_user_id": "<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": "openai",
"model_requested": "<string>",
"request_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": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}Authorizations
Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>.
Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.
Path Parameters
Virtual key ID
Query Parameters
If true, returns virtual key from in-memory cache instead of database
Response
Successful response
Virtual key configuration
Show child attributes
Show child attributes
Was this page helpful?
⌘I