Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
The API key information

​
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

FieldTypeRequiredDescriptionExample
byokUsagenumber:heavy_check_mark:Total external BYOK usage (in USD) for the API key17.38
byokUsageDailynumber:heavy_check_mark:External BYOK usage (in USD) for the current UTC day17.38
byokUsageMonthlynumber:heavy_check_mark:External BYOK usage (in USD) for current UTC month17.38
byokUsageWeeklynumber:heavy_check_mark:External BYOK usage (in USD) for the current UTC week (Monday-Sunday)17.38
createdAtstring:heavy_check_mark:ISO 8601 timestamp of when the API key was created2025-08-24T10:30:00Z
creatorUserIdstring: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
disabledboolean:heavy_check_mark:Whether the API key is disabledfalse
expiresAtDate:heavy_minus_sign:ISO 8601 UTC timestamp when the API key expires, or null if no expiration2027-12-31T23:59:59Z
hashstring:heavy_check_mark:Unique hash identifier for the API keyf01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943
includeByokInLimitboolean:heavy_check_mark:Whether to include external BYOK usage in the credit limitfalse
labelstring:heavy_check_mark:Human-readable label for the API keysk-or-v1-0e6…1c96
limitnumber:heavy_check_mark:Spending limit for the API key in USD100
limitRemainingnumber:heavy_check_mark:Remaining spending limit in USD74.5
limitResetstring:heavy_check_mark:Type of limit reset for the API keymonthly
namestring:heavy_check_mark:Name of the API keyMy Production Key
updatedAtstring:heavy_check_mark:ISO 8601 timestamp of when the API key was last updated2025-08-24T15:45:00Z
usagenumber:heavy_check_mark:Total OpenRouter credit usage (in USD) for the API key25.5
usageDailynumber:heavy_check_mark:OpenRouter credit usage (in USD) for the current UTC day25.5
usageMonthlynumber:heavy_check_mark:OpenRouter credit usage (in USD) for the current UTC month25.5
usageWeeklynumber:heavy_check_mark:OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday)25.5
workspaceIdstring:heavy_check_mark:The workspace ID this API key belongs to.0df9e665-d932-5740-b2c7-b52af166bc11