The OpenRouter TypeScript SDK is a type-safe toolkit for building AI applications with access to 300+ language models through a unified API.
npm install @openrouter/sdkThe OpenRouter SDK is a TypeScript toolkit designed to help you build AI-powered features and solutions in any JS or TS based runtime. Giving you easy access to over 300 models across providers in an easy and type-safe way.
To learn more about how to use the OpenRouter SDK, check out our API Reference and Documentation.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
``bash`
npm add @openrouter/sdk
`bash`
pnpm add @openrouter/sdk
`bash`
bun add @openrouter/sdk
`bash`
yarn add @openrouter/sdk
> [!NOTE]
> This package is published as an ES Module (ESM) only. For applications using
> CommonJS, use await import("@openrouter/sdk") to import and use this package.
For supported JavaScript runtimes, please consult RUNTIMES.md.
`typescript
import { OpenRouter } from "@openrouter/sdk";
const openRouter = new OpenRouter();
const result = await openRouter.chat.send({
messages: [
{
role: "user",
content: "Hello, how are you?",
},
],
model: "openai/gpt-5",
provider: {
zdr: true,
sort: "price",
},
stream: true
});
for await (const chunk of result) {
console.log(chunk.choices[0].delta.content)
}
`
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
> [!WARNING]
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
`typescript
import { OpenRouter } from "@openrouter/sdk";
const sdk = new OpenRouter({ debugLogger: console });
`
You can also enable a default debug logger by setting an environment variable OPENROUTER_DEBUG to true.
To run the test suite, you'll need to set up your environment with an OpenRouter API key.
1. Copy the example environment file:
`bash`
cp .env.example .env
2. Edit .env and add your OpenRouter API key:
`bash`
OPENROUTER_API_KEY=your_api_key_here
3. Run the tests:
`bash``
npx vitest
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.