Installation
Let’s get the Overseer SDK installed and configured in your project. The process is straightforward and should only take a few minutes.
Quick Install
-
Set Up Your Environment
Terminal window # Create a new project directorymkdir my-ai-projectcd my-ai-project# Initialize package.jsonnpm init -y# Create a .env file for your API keytouch .envAdd your API key to the
.env
file:# Your API key from the Overseer dashboardAPI_KEY=your_api_key -
Install the SDK
Terminal window npm install @overseerai/sdk -
Verify Installation
import { Overseer } from '@overseerai/sdk';// Initialize the clientconst overseer = new Overseer({apiKey: process.env.API_KEY});// Test the connectionconst result = await overseer.validate('Hello world');console.log('Connection successful:', result.isAllowed);
Environment Variables
Make sure to load your environment variables in your application. We recommend using dotenv
:
npm install dotenv
Then in your application:
import 'dotenv/config';// Now process.env.API_KEY will be available
Next Steps
Once you have the SDK installed, head over to the Quick Start Guide to learn how to integrate it with your AI system.