Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
Information about an AI model available on OpenRouter

​
Example Usage

import { Model } from "@openrouter/sdk/models";

let value: Model = {
  id: "openai/gpt-4",
  canonicalSlug: "openai/gpt-4",
  name: "GPT-4",
  created: 1692901234,
  pricing: {
    prompt: "0.00003",
    completion: "0.00006",
  },
  contextLength: 8192,
  architecture: {
    modality: "text->text",
    inputModalities: [
      "text",
    ],
    outputModalities: [
      "text",
    ],
  },
  topProvider: {
    isModerated: true,
  },
  perRequestLimits: null,
  supportedParameters: [
    "temperature",
    "top_p",
    "max_tokens",
  ],
  defaultParameters: null,
};

​
Fields

FieldTypeRequiredDescriptionExample
idstring:heavy_check_mark:Unique identifier for the modelopenai/gpt-4
canonicalSlugstring:heavy_check_mark:Canonical slug for the modelopenai/gpt-4
huggingFaceIdstring:heavy_minus_sign:Hugging Face model identifier, if applicablemicrosoft/DialoGPT-medium
namestring:heavy_check_mark:Display name of the modelGPT-4
creatednumber:heavy_check_mark:Unix timestamp of when the model was created1692901234
descriptionstring:heavy_minus_sign:Description of the modelGPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.
pricingmodels.PublicPricing:heavy_check_mark:Pricing information for the model{"prompt": "0.00003","completion": "0.00006","request": "0","image": "0"}
contextLengthnumber:heavy_check_mark:Maximum context length in tokens8192
architecturemodels.ModelArchitecture:heavy_check_mark:Model architecture information{"tokenizer": "GPT","instruct_type": "chatml","modality": "text-\u003etext","input_modalities": ["text"],"output_modalities": ["text"]}
topProvidermodels.TopProviderInfo:heavy_check_mark:Information about the top provider for this model{"context_length": 8192,"max_completion_tokens": 4096,"is_moderated": true}
perRequestLimitsmodels.PerRequestLimits:heavy_check_mark:Per-request token limits{"prompt_tokens": 1000,"completion_tokens": 1000}
supportedParametersmodels.Parameter[]:heavy_check_mark:List of supported parameters for this model
defaultParametersmodels.DefaultParameters:heavy_check_mark:Default parameters for this model{"temperature": 0.7,"top_p": 0.9,"frequency_penalty": 0}
expirationDatestring:heavy_minus_sign:The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration.2025-06-01