Example Usage
import { GetCurrentKeyResponse } from "@openrouter/sdk/models/operations";
let value: GetCurrentKeyResponse = {
data: {
allowedDataRegions: [
"global",
"europe",
"us",
],
budgets: [
{
budgetId: null,
guardrailId: "0df9e665-d932-5740-b2c7-b52af166bc11",
includeByok: false,
limitUsd: 50,
remainingUsd: 17.5,
resetInterval: "weekly",
resetsAt: new Date("2026-10-12T00:00:00.000Z"),
scope: "member",
spendUsd: 32.5,
},
],
byokUsage: 17.38,
byokUsageDaily: 17.38,
byokUsageMonthly: 17.38,
byokUsageWeekly: 17.38,
creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000",
effectiveBudget: {
budgetId: null,
guardrailId: "0df9e665-d932-5740-b2c7-b52af166bc11",
includeByok: false,
limitUsd: 50,
remainingUsd: 17.5,
resetInterval: "weekly",
resetsAt: new Date("2026-10-12T00:00:00.000Z"),
scope: "member",
spendUsd: 32.5,
},
freeModelDailyRequests: {
limit: 50,
remaining: 38,
used: 12,
},
includeByokInLimit: false,
isFreeTier: false,
isManagementKey: false,
isProvisioningKey: false,
label: "sk-or-v1-au7...890",
limit: 100,
limitRemaining: 74.5,
limitReset: "monthly",
organizationId: null,
rateLimit: {
interval: "1h",
note: "This field is deprecated and safe to ignore.",
requests: 1000,
},
usage: 25.5,
usageDaily: 25.5,
usageMonthly: 25.5,
usageWeekly: 25.5,
workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11",
},
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
data | operations.GetCurrentKeyData | ✔️ | Current API key information | { “allowed_data_regions”: [ “global”, “europe”, “us” ], “budgets”: [ { “budget_id”: null, “guardrail_id”: “0df9e665-d932-5740-b2c7-b52af166bc11”, “include_byok”: false, “limit_usd”: 50, “remaining_usd”: 17.5, “reset_interval”: “weekly”, “resets_at”: “2026-10-12T00:00:00.000Z”, “scope”: “member”, “spend_usd”: 32.5 } ], “byok_usage”: 17.38, “byok_usage_daily”: 17.38, “byok_usage_monthly”: 17.38, “byok_usage_weekly”: 17.38, “creator_user_id”: “user_2dHFtVWx2n56w6HkM0000000000”, “effective_budget”: { “budget_id”: null, “guardrail_id”: “0df9e665-d932-5740-b2c7-b52af166bc11”, “include_byok”: false, “limit_usd”: 50, “remaining_usd”: 17.5, “reset_interval”: “weekly”, “resets_at”: “2026-10-12T00:00:00.000Z”, “scope”: “member”, “spend_usd”: 32.5 }, “expires_at”: “2027-12-31T23:59:59Z”, “free_model_daily_requests”: { “limit”: 50, “remaining”: 38, “used”: 12 }, “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 } |