SDK Reference (BETA)TypeScript SDKOperations

CreateKeysData - TypeScript SDK

CreateKeysData type definition

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

The created API key information

Example Usage

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

Fields

FieldTypeRequiredDescriptionExample
hashstring✔️Unique hash identifier for the API keysk-or-v1-0e6f44a47a05f1dad2ad7e88c4c1d6b77688157716fb1a5271146f7464951c96
namestring✔️Name of the API keyMy Production Key
labelstring✔️Human-readable label for the API keyProduction API Key
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