TypeScript SDKAPI ReferenceOperations

GetKeyResponse - TypeScript SDK

GetKeyResponse type definition

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

API key details

Example Usage

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

Fields

FieldTypeRequiredDescriptionExample
dataoperations.GetKeyData✔️The API key information{"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_monthly": 17.38,"byok_usage_weekly": 17.38,"created_at": "2025-08-24T10:30:00Z","creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000","disabled": false,"expires_at": "2027-12-31T23:59:59Z","hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943","include_byok_in_limit": false,"label": "sk-or-v1-0e6...1c96","limit": 100,"limit_remaining": 74.5,"limit_reset": "monthly","name": "My Production Key","updated_at": "2025-08-24T15:45:00Z","usage": 25.5,"usage_daily": 25.5,"usage_monthly": 25.5,"usage_weekly": 25.5}