Skip to main content
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

FieldTypeRequiredDescriptionExample
attemptnumber:heavy_check_mark:N/A
attemptsmodels.RouterAttempt[]:heavy_minus_sign:N/A
endpointsmodels.EndpointsMetadata:heavy_check_mark:N/A{"available": [{"model": "openai/gpt-4o","provider": "OpenAI","selected": true}
],
“total”: 3<br/>}
isByokboolean:heavy_check_mark:N/A
paramsmodels.RouterParams:heavy_minus_sign:N/A{"version_group": "anthropic/claude-sonnet-4"}
pipelinemodels.PipelineStage[]:heavy_minus_sign:N/A
regionstring:heavy_check_mark:N/A
requestedstring:heavy_check_mark:N/A
strategymodels.RoutingStrategy:heavy_check_mark:N/Adirect
summarystring:heavy_check_mark:N/A