Skip to main content
GET
/
virtual-keys
/
{slug}
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": "2023-11-07T05:31:56Z",
  "slug": "<string>",
  "model_config": {},
  "rate_limits": [
    {
      "type": "requests",
      "unit": "rpd",
      "value": 123
    }
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "secret_mappings": [
    {
      "target_field": "key",
      "secret_reference_id": "my-aws-secret",
      "secret_key": "<string>"
    }
  ],
  "object": "virtual-key"
}
Deprecated. Use the Providers API instead. Existing virtual keys continue to work — no code changes needed.

Authorizations

​
x-portkey-api-key
string
header
required

Path Parameters

​
slug
string
required

Response

Successful response

​
name
string
Example:

"Open AI Workspace"

​
note
string | null
Example:

"randomness"

​
status
enum<string>
Available options:
active,
exhausted
​
usage_limits
object
Example:
{
  "credit_limit": 10,
  "periodic_reset": "monthly",
  "alert_threshold": 8
}
​
reset_usage
number | null
Example:

0

​
created_at
string<date-time>
​
slug
string
​
model_config
object
​
rate_limits
object[] | null
​
expires_at
string<date-time>
​
secret_mappings
object[]

Secret reference mappings for this virtual key. Valid target_field values are "key" or "model_config.".

​
object
enum<string>
Available options:
virtual-key
Last modified on March 11, 2026