Retrieve Virtual Key

Get a Virtual Key

get
Authorizations
Path parameters
slugstringRequired
Responses
200

Successful response

application/json
get
from portkey_ai import Portkey

# Initialize the Portkey client
portkey = Portkey(
    api_key="PORTKEY_API_KEY",
)

# Get a specific virtual key
virtual_key = portkey.virtual_keys.retrieve(
    slug='VIRTUAL_KEY_SLUG'
)

print(virtual_key)
{
  "name": "Open AI Workspace",
  "note": "randomness",
  "status": "active",
  "usage_limits": {
    "credit_limit": 10,
    "periodic_reset": "monthly",
    "alert_threshold": 8
  },
  "reset_usage": 0,
  "created_at": "2025-08-23T01:32:01.455Z",
  "slug": "text",
  "model_config": {},
  "rate_limits": [
    {
      "type": "requests",
      "unit": "rpm",
      "value": 1
    }
  ],
  "expires_at": "2025-08-23T01:32:01.455Z",
  "object": "virtual-key"
}

Last updated

Was this helpful?