The TypeScript SDK and docs are currently in beta.
Report issues on GitHub.
Example Usage
import { OpenRouterMetadata } from "@openrouter/sdk/models";
let value: OpenRouterMetadata = {
attempt: 1,
endpoints: {
available: [
{
model: "openai/gpt-4o",
provider: "OpenAI",
selected: true,
},
],
total: 1,
},
isByok: false,
region: "iad",
requested: "openai/gpt-4o",
strategy: "direct",
summary: "available=1, selected=OpenAI",
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
attempt | number | :heavy_check_mark: | N/A | |
attempts | models.RouterAttempt[] | :heavy_minus_sign: | N/A | |
endpoints | models.EndpointsMetadata | :heavy_check_mark: | N/A | {"available": [{"model": "openai/gpt-4o","provider": "OpenAI","selected": true}], “total”: 3<br/>} |
isByok | boolean | :heavy_check_mark: | N/A | |
params | models.RouterParams | :heavy_minus_sign: | N/A | {"version_group": "anthropic/claude-sonnet-4"} |
pipeline | models.PipelineStage[] | :heavy_minus_sign: | N/A | |
region | string | :heavy_check_mark: | N/A | |
requested | string | :heavy_check_mark: | N/A | |
strategy | models.RoutingStrategy | :heavy_check_mark: | N/A | direct |
summary | string | :heavy_check_mark: | N/A |