Skip to main content
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>",
      "calendar_aligned": false,
      "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"
    }
  ],
  "rate_limit": {
    "id": "<string>",
    "token_max_limit": 123,
    "token_reset_duration": "<string>",
    "token_current_usage": 123,
    "token_last_reset": "2023-11-07T05:31:56Z",
    "request_max_limit": 123,
    "request_reset_duration": "<string>",
    "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"
  }
}

Authorizations

x-bf-vk
string
header
required

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)

virtual_key_name
string

Name of the virtual key

is_active
boolean

Whether the virtual key is active

budgets
object[]

Budget quotas assigned to this virtual key

rate_limit
object

Rate limit configuration