Skip to main content

​
Package managers

You can install the ZeroEval SDK using any modern JavaScript package manager: 
npm install zeroeval

​
Requirements

​
Node version

The ZeroEval SDK requires Node.js 18.0.0 or higher.
package.json
{
  "engines": {
    "node": ">=18.0.0"
  }
}

​
Runtime support

The SDK works in multiple JavaScript runtimes:
  • Node.js 18+
  • Bun (latest version)
  • Browser environments (Vite, Next.js, etc.)

​
Peer dependencies

The ZeroEval SDK includes automatic integrations with popular AI libraries. These are all optional peer dependencies that you only need to install if you’re using the corresponding integration.

​
OpenAI

If you’re using the OpenAI SDK, install it alongside ZeroEval: 
npm install openai
Supported versions: OpenAI SDK v5.8.2+ or v6.0.0+

​
Vercel AI SDK

For Vercel AI SDK integration: 
npm install ai @ai-sdk/openai
Supported versions:
  • ai: 5.0.0-beta.28+
  • @ai-sdk/openai: 2.0.0+

​
LangChain

For LangChain or LangGraph integration: 
npm install langchain @langchain/core
Supported versions:
  • langchain: 0.3.29+
  • @langchain/core: 0.3.62+
  • @langchain/langgraph: 0.3.6+ (optional)
All peer dependencies are optional. The SDK will only use integrations for libraries you have installed.

​
Module format

The SDK supports both ESM and CommonJS: 
import * as ze from "zeroeval";

ze.init();

​
CommonJS

const ze = require("zeroeval");

ze.init();

​
TypeScript support

The SDK includes full TypeScript definitions out of the box. No additional @types packages are needed.
tsconfig.json
{
  "compilerOptions": {
    "moduleResolution": "node",
    "esModuleInterop": true,
    "experimentalDecorators": true // Required for @span decorator
  }
}
If you plan to use the @span decorator syntax, you must enable experimentalDecorators: true in your TypeScript configuration.

​
Verify installation

After installation, verify the SDK is working correctly: 
import * as ze from "zeroeval";

ze.init({ apiKey: "your-api-key" });

console.log("SDK initialized:", ze.isInitialized());
// Output: SDK initialized: true

​
Next steps

Authentication

Set up your API keys and authenticate

Quickstart

Build your first traced application

Build docs developers (and LLMs) love

Get started for freeTalk to us