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

Example Usage

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

let value: CreateKeysRequestBody = {
  name: "My New API Key",
};

Fields

FieldTypeRequiredDescriptionExample
creatorUserIdstring:heavy_minus_sign:Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key.user_2dHFtVWx2n56w6HkM0000000000
expiresAtDate:heavy_minus_sign:Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected2027-12-31T23:59:59Z
includeByokInLimitboolean:heavy_minus_sign:Whether to include BYOK usage in the limittrue
limitnumber:heavy_minus_sign:Optional spending limit for the API key in USD50
limitResetoperations.CreateKeysLimitReset:heavy_minus_sign:Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.monthly
namestring:heavy_check_mark:Name for the new API keyMy New API Key
workspaceIdstring:heavy_minus_sign:The workspace to create the API key in. Defaults to the default workspace if not provided.0df9e665-d932-5740-b2c7-b52af166bc11