Retrieve Virtual Key

GET /virtual-keys/{slug}

Python

Default

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)

200

{
  "name": "Open AI Workspace",
  "note": "randomness",
  "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": [
    {
      "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"
}

{
  "success": false,
  "data": {
    "message": "Unauthorised Request"
  }
}

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

200

application/json

Successful response

name · string

Example:

"Open AI Workspace"

note · string | null

Example:

"randomness"

status · enum<string>

Available options: active, exhausted

usage_limits · object

Show child attributes

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

Show child attributes

expires_at · string<date-time>

secret_mappings · object[]

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

Show child attributes

object · enum<string>

Available options: virtual-key