OpenRouterMetadata - TypeScript SDK
OpenRouterMetadata - TypeScript SDK
OpenRouterMetadata type definition
OpenRouterMetadata - TypeScript SDK
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
1 import { OpenRouterMetadata } from "@openrouter/sdk/models"; 2 3 let value: OpenRouterMetadata = { 4 attempt: 1, 5 endpoints: { 6 available: [ 7 { 8 model: "openai/gpt-4o", 9 provider: "OpenAI", 10 selected: true, 11 }, 12 ], 13 total: 1, 14 }, 15 isByok: false, 16 region: "iad", 17 requested: "openai/gpt-4o", 18 strategy: "direct", 19 summary: "available=1, selected=OpenAI", 20 };
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
attempt | number | ✔️ | N/A | |
attempts | models.RouterAttempt[] | ➖ | N/A | |
endpoints | models.EndpointsMetadata | ✔️ | N/A | {"available": [{"model": "openai/gpt-4o","provider": "OpenAI","selected": true}], “total”: 3<br />} |
isByok | boolean | ✔️ | N/A | |
params | models.RouterParams | ➖ | N/A | {"version_group": "anthropic/claude-sonnet-4"} |
pipeline | models.PipelineStage[] | ➖ | N/A | |
region | string | ✔️ | N/A | |
requested | string | ✔️ | N/A | |
strategy | models.RoutingStrategy | ✔️ | N/A | direct |
summary | string | ✔️ | N/A |