SDK Reference (BETA)TypeScript SDKOperations

GetCurrentKeyResponse - TypeScript SDK

GetCurrentKeyResponse type definition

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

API key details

Example Usage

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

Fields

FieldTypeRequiredDescriptionExample
dataoperations.GetCurrentKeyData✔️Current API key information{"label": "sk-or-v1-au78b3456789012345678901234567890","limit": 100,"usage": 25.5,"usage_daily": 25.5,"usage_weekly": 25.5,"usage_monthly": 25.5,"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_weekly": 17.38,"byok_usage_monthly": 17.38,"is_free_tier": false,"is_provisioning_key": false,"limit_remaining": 74.5,"limit_reset": "monthly","include_byok_in_limit": false,"rate_limit": {"requests": 1000,"interval": "1h","note": "This field is deprecated and safe to ignore."}
}