Example Usage
import { GetBenchmarksRequest } from "@openrouter/sdk/models/operations";
let value: GetBenchmarksRequest = {
includeRunConfig: true,
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
httpReferer | string | :heavy_minus_sign: | 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 | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter’s dashboard. | |
appCategories | string | :heavy_minus_sign: | Comma-separated list of app categories (e.g. “cli-agent,cloud-agent”). Used for marketplace rankings. | |
source | operations.Source | :heavy_minus_sign: | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis |
taskType | operations.TaskType | :heavy_minus_sign: | Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. search returns OpenRouter search benchmark results only. | coding |
benchmarkType | operations.BenchmarkType | :heavy_minus_sign: | Return results for one exact OpenRouter benchmark. A search_* value narrows the response to search results only; a classic value narrows the OpenRouter items and leaves other sources’ items as they are. | search_widesearch |
includeRunConfig | boolean | :heavy_minus_sign: | Search benchmarks only: include the published lane configuration whitelist in each search item. Defaults to false. The whitelist is limited to agent turn count, reasoning effort, and temperature so future harness configuration changes do not change the public contract. | true |
searchEngine | string | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the search engine used. | exa |
searchSurface | operations.SearchSurface | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool |
arena | operations.Arena | :heavy_minus_sign: | Design Arena only: arena to query. Defaults to models when source is design-arena. | models |
category | string | :heavy_minus_sign: | Design Arena only: category within the arena (e.g. codecategories, uicomponent, gamedev, 3d, dataviz, image, video, svg). When omitted, returns all categories. | codecategories |
maxResults | number | :heavy_minus_sign: | Maximum number of items to return. When omitted, all matching results are returned. | 50 |