GetBYOKKeyRequest Type | OpenRouter TypeScript SDK | OpenRouter

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

Example Usage

1 import { GetBYOKKeyRequest } from "@openrouter/sdk/models/operations";
2 
3 let value: GetBYOKKeyRequest = {
4   id: "11111111-2222-3333-4444-555555555555",
5 };

Fields

Field	Type	Required	Description	Example
`httpReferer`	string	➖	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.
`appTitle`	string	➖	The app display name allows you to customize how your app appears in OpenRouter’s dashboard.
`appCategories`	string	➖	Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings.
`id`	string	✔️	The BYOK credential ID (UUID).	11111111-2222-3333-4444-555555555555
`workspaceId`	string	➖	Optional workspace ID. Defaults to the authenticated entity’s default workspace.	550e8400-e29b-41d4-a716-446655440000