The TypeScript SDK and docs are currently in beta.
Report issues on GitHub.
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
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 |
canonicalSlug | string | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 |
huggingFaceId | string | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium |
name | string | :heavy_check_mark: | Display name of the model | GPT-4 |
created | number | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 |
description | string | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. |
pricing | models.PublicPricing | :heavy_check_mark: | Pricing information for the model | {"prompt": "0.00003","completion": "0.00006","request": "0","image": "0"} |
contextLength | number | :heavy_check_mark: | Maximum context length in tokens | 8192 |
architecture | models.ModelArchitecture | :heavy_check_mark: | Model architecture information | {"tokenizer": "GPT","instruct_type": "chatml","modality": "text-\u003etext","input_modalities": ["text"],"output_modalities": ["text"]} |
topProvider | models.TopProviderInfo | :heavy_check_mark: | Information about the top provider for this model | {"context_length": 8192,"max_completion_tokens": 4096,"is_moderated": true} |
perRequestLimits | models.PerRequestLimits | :heavy_check_mark: | Per-request token limits | {"prompt_tokens": 1000,"completion_tokens": 1000} |
supportedParameters | models.Parameter[] | :heavy_check_mark: | List of supported parameters for this model | |
defaultParameters | models.DefaultParameters | :heavy_check_mark: | Default parameters for this model | {"temperature": 0.7,"top_p": 0.9,"frequency_penalty": 0} |
expirationDate | string | :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 |