mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-07-29 11:23:49 +08:00
7.9 KiB
7.9 KiB
GetKeyData
The API key information
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
hash |
str | ✔️ | Unique hash identifier for the API key | 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 |
name |
str | ✔️ | Name of the API key | My Production Key |
label |
str | ✔️ | Human-readable label for the API key | Production API Key |
disabled |
bool | ✔️ | Whether the API key is disabled | false |
limit |
Nullable[float] | ✔️ | Spending limit for the API key in USD | 100 |
limit_remaining |
Nullable[float] | ✔️ | Remaining spending limit in USD | 74.5 |
limit_reset |
Nullable[str] | ✔️ | Type of limit reset for the API key | monthly |
include_byok_in_limit |
bool | ✔️ | Whether to include external BYOK usage in the credit limit | false |
usage |
float | ✔️ | Total OpenRouter credit usage (in USD) for the API key | 25.5 |
usage_daily |
float | ✔️ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 |
usage_weekly |
float | ✔️ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 |
usage_monthly |
float | ✔️ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 |
byok_usage |
float | ✔️ | Total external BYOK usage (in USD) for the API key | 17.38 |
byok_usage_daily |
float | ✔️ | External BYOK usage (in USD) for the current UTC day | 17.38 |
byok_usage_weekly |
float | ✔️ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 |
byok_usage_monthly |
float | ✔️ | External BYOK usage (in USD) for current UTC month | 17.38 |
created_at |
str | ✔️ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z |
updated_at |
Nullable[str] | ✔️ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z |
expires_at |
date | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z |