The TypeScript SDK and docs are currently in beta.
Report issues on GitHub.
Example Usage
import { CreateAuthKeysCodeRequestBody } from "@openrouter/sdk/models/operations";
let value: CreateAuthKeysCodeRequestBody = {
callbackUrl: "https://myapp.com/auth/callback",
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
callbackUrl | string | :heavy_check_mark: | The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed. | https://myapp.com/auth/callback |
codeChallenge | string | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM |
codeChallengeMethod | operations.CreateAuthKeysCodeCodeChallengeMethod | :heavy_minus_sign: | The method used to generate the code challenge | S256 |
expiresAt | Date | :heavy_minus_sign: | Optional expiration time for the API key to be created | 2027-12-31T23:59:59Z |
keyLabel | string | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key |
limit | number | :heavy_minus_sign: | Credit limit for the API key to be created | 100 |
usageLimitType | operations.UsageLimitType | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly |