Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
BYOKUsage | float64 | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 |
BYOKUsageDaily | float64 | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 |
BYOKUsageMonthly | float64 | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 |
BYOKUsageWeekly | float64 | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 |
CreatorUserID | *string | :heavy_check_mark: | 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 |
ExpiresAt | optionalnullable.OptionalNullable[time.Time] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z |
IncludeBYOKInLimit | bool | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false |
IsFreeTier | bool | :heavy_check_mark: | Whether this is a free tier API key | false |
IsManagementKey | bool | :heavy_check_mark: | Whether this is a management key | false |
IsProvisioningKey | bool | :heavy_check_mark: | : 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 | string | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6…1c96 |
Limit | *float64 | :heavy_check_mark: | Spending limit for the API key in USD | 100 |
LimitRemaining | *float64 | :heavy_check_mark: | Remaining spending limit in USD | 74.5 |
LimitReset | *string | :heavy_check_mark: | Type of limit reset for the API key | monthly |
RateLimit | operations.RateLimit | :heavy_check_mark: | : 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 | float64 | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 |
UsageDaily | float64 | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 |
UsageMonthly | float64 | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 |
UsageWeekly | float64 | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 |