TypeScript SDKAPI ReferenceOperations
GetModelsRequest - TypeScript SDK
GetModelsRequest - TypeScript SDK
GetModelsRequest type definition
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
Example Usage
1 import { GetModelsRequest } from "@openrouter/sdk/models/operations"; 2 3 let value: GetModelsRequest = {};
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. | |
category | operations.GetModelsCategory | ➖ | Filter models by use case category | programming |
supportedParameters | string | ➖ | Filter models by supported parameter (comma-separated) | temperature |
outputModalities | string | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, audio, embeddings) or “all” to include all models. Defaults to “text”. | text |
sort | operations.GetModelsSort | ➖ | Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date). When omitted, the existing default ordering is preserved. | newest |