GetCurrentKeyData Type | OpenRouter TypeScript SDK | OpenRouter

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Current API key information

Example Usage

1 import { GetCurrentKeyData } from "@openrouter/sdk/models/operations";
2 
3 let value: GetCurrentKeyData = {
4   byokUsage: 17.38,
5   byokUsageDaily: 17.38,
6   byokUsageMonthly: 17.38,
7   byokUsageWeekly: 17.38,
8   creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000",
9   includeByokInLimit: false,
10   isFreeTier: false,
11   isManagementKey: false,
12   isProvisioningKey: false,
13   label: "sk-or-v1-au7...890",
14   limit: 100,
15   limitRemaining: 74.5,
16   limitReset: "monthly",
17   rateLimit: {
18     interval: "1h",
19     note: "This field is deprecated and safe to ignore.",
20     requests: 1000,
21   },
22   usage: 25.5,
23   usageDaily: 25.5,
24   usageMonthly: 25.5,
25   usageWeekly: 25.5,
26 };

Fields

Field	Type	Required	Description	Example
`byokUsage`	number	✔️	Total external BYOK usage (in USD) for the API key	17.38
`byokUsageDaily`	number	✔️	External BYOK usage (in USD) for the current UTC day	17.38
`byokUsageMonthly`	number	✔️	External BYOK usage (in USD) for current UTC month	17.38
`byokUsageWeekly`	number	✔️	External BYOK usage (in USD) for the current UTC week (Monday-Sunday)	17.38
`creatorUserId`	string	✔️	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`	Date	➖	ISO 8601 UTC timestamp when the API key expires, or null if no expiration	2027-12-31T23:59:59Z
`includeByokInLimit`	boolean	✔️	Whether to include external BYOK usage in the credit limit	false
`isFreeTier`	boolean	✔️	Whether this is a free tier API key	false
`isManagementKey`	boolean	✔️	Whether this is a management key	false
~~`isProvisioningKey`~~	boolean	✔️	: 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	✔️	Human-readable label for the API key	sk-or-v1-0e6…1c96
`limit`	number	✔️	Spending limit for the API key in USD	100
`limitRemaining`	number	✔️	Remaining spending limit in USD	74.5
`limitReset`	string	✔️	Type of limit reset for the API key	monthly
~~`rateLimit`~~	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`	number	✔️	Total OpenRouter credit usage (in USD) for the API key	25.5
`usageDaily`	number	✔️	OpenRouter credit usage (in USD) for the current UTC day	25.5
`usageMonthly`	number	✔️	OpenRouter credit usage (in USD) for the current UTC month	25.5
`usageWeekly`	number	✔️	OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday)	25.5