Models | OpenRouter TypeScript SDK | OpenRouter

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

(models)

Overview

Model information endpoints

Available Operations

count - Get total count of available models
list - List all models and their properties
listForUser - List models filtered by user provider preferences

count

Get total count of available models

Example Usage

1 import { OpenRouter } from "@openrouter/sdk";
2 
3 const openRouter = new OpenRouter({
4   apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
5 });
6 
7 async function run() {
8   const result = await openRouter.models.count();
9 
10   console.log(result);
11 }
12 
13 run();

Standalone function

The standalone function version of this method:

1 import { OpenRouterCore } from "@openrouter/sdk/core.js";
2 import { modelsCount } from "@openrouter/sdk/funcs/modelsCount.js";
3 
4 // Use `OpenRouterCore` for best tree-shaking performance.
5 // You can create one instance of it to use across an application.
6 const openRouter = new OpenRouterCore({
7   apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
8 });
9 
10 async function run() {
11   const res = await modelsCount(openRouter);
12   if (res.ok) {
13     const { value: result } = res;
14     console.log(result);
15   } else {
16     console.log("modelsCount failed:", res.error);
17   }
18 }
19 
20 run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

1 import {
2   // Query hooks for fetching data.
3   useModelsCount,
4   useModelsCountSuspense,
5 
6   // Utility for prefetching data during server-side rendering and in React
7   // Server Components that will be immediately available to client components
8   // using the hooks.
9   prefetchModelsCount,
10   
11   // Utility to invalidate the query cache for this query in response to
12   // mutations and other user actions.
13   invalidateAllModelsCount,
14 } from "@openrouter/sdk/react-query/modelsCount.js";

Parameters

Parameter	Type	Required	Description
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ModelsCountResponse>

Errors

Error Type	Status Code	Content Type
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

list

List all models and their properties

Example Usage

1 import { OpenRouter } from "@openrouter/sdk";
2 
3 const openRouter = new OpenRouter({
4   apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
5 });
6 
7 async function run() {
8   const result = await openRouter.models.list();
9 
10   console.log(result);
11 }
12 
13 run();

Standalone function

The standalone function version of this method:

1 import { OpenRouterCore } from "@openrouter/sdk/core.js";
2 import { modelsList } from "@openrouter/sdk/funcs/modelsList.js";
3 
4 // Use `OpenRouterCore` for best tree-shaking performance.
5 // You can create one instance of it to use across an application.
6 const openRouter = new OpenRouterCore({
7   apiKey: process.env["OPENROUTER_API_KEY"] ?? "",
8 });
9 
10 async function run() {
11   const res = await modelsList(openRouter);
12   if (res.ok) {
13     const { value: result } = res;
14     console.log(result);
15   } else {
16     console.log("modelsList failed:", res.error);
17   }
18 }
19 
20 run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

1 import {
2   // Query hooks for fetching data.
3   useModelsList,
4   useModelsListSuspense,
5 
6   // Utility for prefetching data during server-side rendering and in React
7   // Server Components that will be immediately available to client components
8   // using the hooks.
9   prefetchModelsList,
10   
11   // Utilities to invalidate the query cache for this query in response to
12   // mutations and other user actions.
13   invalidateModelsList,
14   invalidateAllModelsList,
15 } from "@openrouter/sdk/react-query/modelsList.js";

Parameters

Parameter	Type	Required	Description
`request`	operations.GetModelsRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ModelsListResponse>

Errors

Error Type	Status Code	Content Type
errors.BadRequestResponseError	400	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/

listForUser

List models filtered by user provider preferences

Example Usage

1 import { OpenRouter } from "@openrouter/sdk";
2 
3 const openRouter = new OpenRouter();
4 
5 async function run() {
6   const result = await openRouter.models.listForUser({
7     bearer: process.env["OPENROUTER_BEARER"] ?? "",
8   });
9 
10   console.log(result);
11 }
12 
13 run();

Standalone function

The standalone function version of this method:

1 import { OpenRouterCore } from "@openrouter/sdk/core.js";
2 import { modelsListForUser } from "@openrouter/sdk/funcs/modelsListForUser.js";
3 
4 // Use `OpenRouterCore` for best tree-shaking performance.
5 // You can create one instance of it to use across an application.
6 const openRouter = new OpenRouterCore();
7 
8 async function run() {
9   const res = await modelsListForUser(openRouter, {
10     bearer: process.env["OPENROUTER_BEARER"] ?? "",
11   });
12   if (res.ok) {
13     const { value: result } = res;
14     console.log(result);
15   } else {
16     console.log("modelsListForUser failed:", res.error);
17   }
18 }
19 
20 run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

1 import {
2   // Query hooks for fetching data.
3   useModelsListForUser,
4   useModelsListForUserSuspense,
5 
6   // Utility for prefetching data during server-side rendering and in React
7   // Server Components that will be immediately available to client components
8   // using the hooks.
9   prefetchModelsListForUser,
10   
11   // Utility to invalidate the query cache for this query in response to
12   // mutations and other user actions.
13   invalidateAllModelsListForUser,
14 } from "@openrouter/sdk/react-query/modelsListForUser.js";

Parameters

Parameter	Type	Required	Description
`security`	operations.ListModelsUserSecurity	✔️	The security requirements to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ModelsListResponse>

Errors

Error Type	Status Code	Content Type
errors.UnauthorizedResponseError	401	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	/