Skip to main content

Installation

Install the Tracia SDK using your preferred package manager:
npm install tracia

Requirements

  • Node.js 18+ (uses native fetch)
  • Works in modern browsers with native fetch support

Configuration

Initialize the Tracia client with your API key:
import { Tracia } from 'tracia';

const tracia = new Tracia({
  apiKey: process.env.TRACIA_API_KEY
});

Configuration Options

OptionTypeRequiredDescription
apiKeystringYesYour Tracia API key (starts with tr_)
onSpanError(error: Error, spanId: string) => voidNoCallback for background span submission failures

Environment Variables

We recommend storing your API key in environment variables:
.env
TRACIA_API_KEY=tr_your_api_key_here
Never commit API keys to version control. Use environment variables or a secrets manager.

TypeScript Support

The SDK is written in TypeScript and exports all types:
import {
  Tracia,
  TraciaOptions,
  TraciaSession,
  RunOptions,
  RunResult,
  TokenUsage,
  Prompt,
  PromptListItem,
  PromptMessage,
  MessageRole,
  CreatePromptOptions,
  UpdatePromptOptions,
  TraciaError,
  TraciaErrorCode,
  // runLocal types
  LocalPromptMessage,
  RunLocalInput,
  RunLocalResult,
  LocalStream,
  LLMProvider,
  // Span types
  Span,
  SpanListItem,
  SpanStatus,
  ListSpansOptions,
  ListSpansResult,
  // Tool types
  ToolDefinition,
  ToolCall,
  ToolChoice,
} from 'tracia';

Next Steps