SDK Reference (BETA)TypeScript SDKModels

Model - TypeScript SDK

Model type definition

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Information about an AI model available on OpenRouter

Example Usage

1import { Model } from "@openrouter/sdk/models";
2
3let value: Model = {
4  id: "openai/gpt-4",
5  canonicalSlug: "openai/gpt-4",
6  name: "GPT-4",
7  created: 1692901234,
8  pricing: {
9    prompt: "0.00003",
10    completion: "0.00006",
11  },
12  contextLength: 8192,
13  architecture: {
14    modality: "text->text",
15    inputModalities: [
16      "text",
17    ],
18    outputModalities: [
19      "text",
20    ],
21  },
22  topProvider: {
23    isModerated: true,
24  },
25  perRequestLimits: null,
26  supportedParameters: [
27    "temperature",
28    "top_p",
29    "max_tokens",
30  ],
31  defaultParameters: null,
32};

Fields

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