The TypeScript SDK and docs are currently in beta.
Report issues on GitHub.
Example Usage
import { GetKeyData } from "@openrouter/sdk/models/operations";
let value: GetKeyData = {
byokUsage: 17.38,
byokUsageDaily: 17.38,
byokUsageMonthly: 17.38,
byokUsageWeekly: 17.38,
createdAt: "2025-08-24T10:30:00Z",
creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000",
disabled: false,
hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
includeByokInLimit: false,
label: "sk-or-v1-0e6...1c96",
limit: 100,
limitRemaining: 74.5,
limitReset: "monthly",
name: "My Production Key",
updatedAt: "2025-08-24T15:45:00Z",
usage: 25.5,
usageDaily: 25.5,
usageMonthly: 25.5,
usageWeekly: 25.5,
workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11",
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
byokUsage | number | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 |
byokUsageDaily | number | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 |
byokUsageMonthly | number | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 |
byokUsageWeekly | number | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 |
createdAt | string | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z |
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 |
disabled | boolean | :heavy_check_mark: | Whether the API key is disabled | false |
expiresAt | Date | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z |
hash | string | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 |
includeByokInLimit | boolean | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false |
label | string | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6…1c96 |
limit | number | :heavy_check_mark: | Spending limit for the API key in USD | 100 |
limitRemaining | number | :heavy_check_mark: | Remaining spending limit in USD | 74.5 |
limitReset | string | :heavy_check_mark: | Type of limit reset for the API key | monthly |
name | string | :heavy_check_mark: | Name of the API key | My Production Key |
updatedAt | string | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z |
usage | number | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 |
usageDaily | number | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 |
usageMonthly | number | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 |
usageWeekly | number | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 |
workspaceId | string | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 |