UpdateKeysData - TypeScript SDK

UpdateKeysData method reference

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

The updated API key information

Example Usage

1import { UpdateKeysData } from "@openrouter/sdk/models/operations";
2
3let value: UpdateKeysData = {
4 hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
5 name: "My Production Key",
6 label: "sk-or-v1-0e6...1c96",
7 disabled: false,
8 limit: 100,
9 limitRemaining: 74.5,
10 limitReset: "monthly",
11 includeByokInLimit: false,
12 usage: 25.5,
13 usageDaily: 25.5,
14 usageWeekly: 25.5,
15 usageMonthly: 25.5,
16 byokUsage: 17.38,
17 byokUsageDaily: 17.38,
18 byokUsageWeekly: 17.38,
19 byokUsageMonthly: 17.38,
20 createdAt: "2025-08-24T10:30:00Z",
21 updatedAt: "2025-08-24T15:45:00Z",
22};

Fields

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