GET
/
api-keys
/
{id}
from portkey_ai import Portkey

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

# Get API keys
api_keys = portkey.api_keys.retrieve(
  id="API_KEY_ID"
)

print(api_keys)
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "key": "Xk*******S4",
  "name": "Development API Key",
  "description": "API key for development environment",
  "type": "organisation-service",
  "organisation_id": "a1b2c3d4-e5f6-4a5b-8c7d-9e0f1a2b3c4d",
  "workspace_id": "ws-myworkspace",
  "user_id": "c3d4e5f6-a7b8-6c7d-0e1f-2a3b4c5d6e7f",
  "status": "active",
  "created_at": "2023-09-15T10:30:00Z",
  "last_updated_at": "2023-09-15T10:30:00Z",
  "creation_mode": "ui",
  "rate_limits": [
    {
      "type": "requests",
      "unit": "rpm",
      "value": 100
    }
  ],
  "usage_limits": {
    "credit_limit": 10,
    "periodic_reset": "monthly",
    "alert_threshold": 8
  },
  "reset_usage": 0,
  "scopes": [
    "completions.write"
  ],
  "defaults": {
    "metadata": {
      "environment": "development",
      "team": "backend"
    },
    "config_id": "config-abc"
  },
  "alert_emails": [
    "foo@bar.com"
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "object": "api-key"
}

Authorizations

​
x-portkey-api-key
string
header
required

Path Parameters

​
id
string
required

Response

200 - application/json

OK

The response is of type object.