Python SDKAPI ReferenceOperations
GetKeyData - Python SDK
GetKeyData - Python SDK
GetKeyData method reference
The Python SDK and docs are currently in beta. Report issues on GitHub.
The 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 |
created_at | str | ✔️ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z |
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 |
disabled | bool | ✔️ | Whether the API key is disabled | false |
expires_at | date | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z |
hash | str | ✔️ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 |
include_byok_in_limit | bool | ✔️ | Whether to include external BYOK usage in the credit limit | 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 |
name | str | ✔️ | Name of the API key | My Production Key |
updated_at | Nullable[str] | ✔️ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z |
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 |
workspace_id | str | ✔️ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 |