TypeScript SDKAPI ReferenceOperations

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    byokUsage: 17.38,
6    byokUsageDaily: 17.38,
7    byokUsageMonthly: 17.38,
8    byokUsageWeekly: 17.38,
9    creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000",
10    includeByokInLimit: false,
11    isFreeTier: false,
12    isManagementKey: false,
13    isProvisioningKey: false,
14    label: "sk-or-v1-au7...890",
15    limit: 100,
16    limitRemaining: 74.5,
17    limitReset: "monthly",
18    rateLimit: {
19      interval: "1h",
20      note: "This field is deprecated and safe to ignore.",
21      requests: 1000,
22    },
23    usage: 25.5,
24    usageDaily: 25.5,
25    usageMonthly: 25.5,
26    usageWeekly: 25.5,
27  },
28};

Fields

FieldTypeRequiredDescriptionExample
dataoperations.GetCurrentKeyData✔️Current API key information{"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_monthly": 17.38,"byok_usage_weekly": 17.38,"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000","expires_at": "2027-12-31T23:59:59Z","include_byok_in_limit": false,"is_free_tier": false,"is_management_key": false,"is_provisioning_key": false,"label": "sk-or-v1-au7...890","limit": 100,"limit_remaining": 74.5,"limit_reset": "monthly","rate_limit": {"interval": "1h","note": "This field is deprecated and safe to ignore.","requests": 1000},
“usage”: 25.5,
“usage_daily”: 25.5,
“usage_monthly”: 25.5,
“usage_weekly”: 25.5
}