Skip to main content
GET
/
virtual-keys
from portkey_ai import Portkey

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

# List virtual keys
virtual_keys = portkey.virtual_keys.list()

print(virtual_keys)
{
  "object": "list",
  "total": 123,
  "data": [
    {
      "name": "Open AI Workspace",
      "note": "randomness",
      "status": "active",
      "usage_limits": {
        "credit_limit": 10,
        "periodic_reset": "monthly",
        "alert_threshold": 8
      },
      "reset_usage": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "slug": "<string>",
      "model_config": {},
      "rate_limits": [
        {
          "type": "requests",
          "unit": "rpd",
          "value": 123
        }
      ],
      "expires_at": "2023-11-07T05:31:56Z",
      "object": "virtual-key"
    }
  ]
}

Authorizations

​
x-portkey-api-key
string
header
required

Query Parameters

​
current_page
integer
required

Current page, defaults to 0

​
page_size
integer
required

Page size, default to 50

Response

Successful response

​
object
enum<string>
Available options:
list
​
total
integer

Total number of virtual keys

​
data
object[]