Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
API key details

​
Example Usage

import { GetKeyResponse } from "@openrouter/sdk/models/operations";

let value: GetKeyResponse = {
  data: {
    byokUsage: 17.38,
    byokUsageDaily: 17.38,
    byokUsageMonthly: 17.38,
    byokUsageWeekly: 17.38,
    createdAt: "2025-08-24T10:30:00Z",
    creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000",
    disabled: false,
    hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
    includeByokInLimit: false,
    label: "Production API Key",
    limit: 100,
    limitRemaining: 74.5,
    limitReset: "monthly",
    name: "My Production Key",
    updatedAt: "2025-08-24T15:45:00Z",
    usage: 25.5,
    usageDaily: 25.5,
    usageMonthly: 25.5,
    usageWeekly: 25.5,
    workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11",
  },
};

​
Fields

FieldTypeRequiredDescriptionExample
dataoperations.GetKeyData:heavy_check_mark: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,"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"}