Models - TypeScript SDK
Models - TypeScript SDK
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
Overview
Model information endpoints
Available Operations
- get - Get a model by its slug
- list - List all models and their properties
- count - Get total count of available models
- listForUser - List models filtered by user provider preferences, privacy settings, and guardrails
get
Returns full details for a single model identified by its author and slug (e.g. openai/gpt-4). Supports variant suffixes (e.g. openai/gpt-4:free) and resolves known slug aliases.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<models.ModelResponse>
Errors
list
List all models and their properties
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<models.ModelsListResponse>
Errors
count
Get total count of available models
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<models.ModelsCountResponse>
Errors
listForUser
List models filtered by user provider preferences, privacy settings, and guardrails. If requesting through eu.openrouter.ai/api/v1/... the results will be filtered to models that satisfy EU in-region routing.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<models.ModelsListResponse>