Skip to main content
GitHub

JavaScript SDK

Install and configure the Risicare JavaScript/TypeScript SDK.

Get started with Risicare in your Node.js or TypeScript application.

Installation

npm install risicare
# or
yarn add risicare
# or
pnpm add risicare

Requirements

Node.js 18.0.0 or later is required. The SDK supports both ESM and CommonJS.

Quick Start

import { init } from 'risicare';
import { patchOpenAI } from 'risicare/openai';
import OpenAI from 'openai';
 
// Initialize Risicare (API key determines project)
init({
  apiKey: process.env.RISICARE_API_KEY,
});
 
// Patch OpenAI for auto-instrumentation
const openai = patchOpenAI(new OpenAI());
 
// All calls are now automatically traced
const response = await openai.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'Hello!' }],
});

Environment Variables

Configure the SDK without code changes:

export RISICARE_API_KEY="rsk-..."
export RISICARE_ENVIRONMENT="production"
export RISICARE_SERVICE_NAME="my-agent"
export RISICARE_TRACING="true"

Sub-Path Imports

Provider patches are available via sub-path imports:

// Provider patches — always import from sub-paths
import { patchOpenAI } from 'risicare/openai';
import { patchAnthropic } from 'risicare/anthropic';
import { patchVercelAI } from 'risicare/vercel-ai';
 
// Core functions — import from main package
import { init, agent, session, traceThink } from 'risicare';

ESM vs CommonJS

The SDK supports both module systems:

TypeScript Support

Full TypeScript support with exported types:

import type { RisicareConfig, Span, SpanKind } from 'risicare';
 
const config: RisicareConfig = {
  apiKey: 'rsk-...',
  serviceName: 'my-agent',
  environment: 'production',
};

Next Steps