TypeScript SDKAPI ReferenceOperations

CreateBYOKKeyRequest - TypeScript SDK

CreateBYOKKeyRequest type definition

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

Example Usage

1import { CreateBYOKKeyRequest } from "@openrouter/sdk/models/operations";
2
3let value: CreateBYOKKeyRequest = {
4  createBYOKKeyRequest: {
5    key: "sk-proj-abc123...",
6    provider: "openai",
7  },
8};

Fields

FieldTypeRequiredDescriptionExample
httpRefererstring➖The app identifier should be your app’s URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
appTitlestring➖The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
appCategoriesstring➖Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
createBYOKKeyRequestmodels.CreateBYOKKeyRequest✔️N/A{"key": "sk-proj-abc123...","name": "Production OpenAI Key","provider": "openai"}