Files
openrouter-python-sdk-retry…/docs/operations/getcurrentkeydata.md
T

20 KiB
Raw Blame History

GetCurrentKeyData

Current API key information

Fields

Field Type Required Description Example
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_monthly float ✔️ External BYOK usage (in USD) for current UTC month 17.38
byok_usage_weekly float ✔️ External BYOK usage (in USD) for the current UTC week (Monday-Sunday) 17.38
creator_user_id Nullable[str] ✔️ The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. user_2dHFtVWx2n56w6HkM0000000000
expires_at date ISO 8601 UTC timestamp when the API key expires, or null if no expiration 2027-12-31T23:59:59Z
include_byok_in_limit bool ✔️ Whether to include external BYOK usage in the credit limit false
is_free_tier bool ✔️ Whether this is a free tier API key false
is_management_key bool ✔️ Whether this is a management key false
is_provisioning_key bool ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether this is a management key
false
label str ✔️ Human-readable label for the API key sk-or-v1-0e6...1c96
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
rate_limit operations.RateLimit ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Legacy rate limit information about a key. Will always return -1.
{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
}
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_monthly float ✔️ OpenRouter credit usage (in USD) for the current UTC month 25.5
usage_weekly float ✔️ OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) 25.5