SDK Reference (BETA)TypeScript SDKOperations

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    hash:
6      "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",
7    name: "My Production Key",
8    label: "Production API Key",
9    disabled: false,
10    limit: 100,
11    limitRemaining: 74.5,
12    limitReset: "monthly",
13    includeByokInLimit: false,
14    usage: 25.5,
15    usageDaily: 25.5,
16    usageWeekly: 25.5,
17    usageMonthly: 25.5,
18    byokUsage: 17.38,
19    byokUsageDaily: 17.38,
20    byokUsageWeekly: 17.38,
21    byokUsageMonthly: 17.38,
22    createdAt: "2025-08-24T10:30:00Z",
23    updatedAt: "2025-08-24T15:45:00Z",
24  },
25};

Fields

FieldTypeRequiredDescriptionExample
dataoperations.GetKeyData✔️The API key information{"hash": "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","name": "My Production Key","label": "Production API Key","disabled": false,"limit": 100,"limit_remaining": 74.5,"limit_reset": "monthly","include_byok_in_limit": false,"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,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z"}