Get Started - TraceRoot

1. Get API Keys

Create API Keys either with TraceRoot Cloud or Self-Hosting.

2. Install the SDK

Python
TypeScript

pip install traceroot

npm install @traceroot-ai/traceroot

3. Set Environment Variables

.env

TRACEROOT_API_KEY=your-api-key
TRACEROOT_HOST_URL=https://app.traceroot.ai  # or your self-hosted URL

4. Instrument Your Code

Python
TypeScript

Add a single line at the start of your application to instrument all OpenAI API calls.

import traceroot
from traceroot import Integration
from openai import OpenAI

# This single line instruments all OpenAI API calls
traceroot.initialize(integrations=[Integration.OPENAI])

client = OpenAI()

Add a single line at the start of your application to instrument all OpenAI API calls.

import OpenAI from 'openai';
import { TraceRoot } from '@traceroot-ai/traceroot';

// This single line instruments all OpenAI API calls
TraceRoot.initialize({ instrumentModules: { openAI: OpenAI } });

const openai = new OpenAI();

For full SDK details, see the Python SDK or TypeScript SDK.

5. View Your Traces

Open TraceRoot Cloud (or your self-hosted dashboard), navigate to your project, and you’ll see the full span hierarchy, token usage, cost, and timing. Prefer the terminal? The TraceRoot CLI lists, inspects, and exports the same traces without leaving your shell.

What’s Next?

Python SDK

Full API reference for the Python SDK.

TypeScript SDK

Full API reference for the TypeScript SDK.

AI Agent

Auto-debug failing traces with the built-in AI agent.

CLI

Read and export your traces from the terminal.

Introduction Python SDK

⌘I

​1. Get API Keys

​2. Install the SDK

​3. Set Environment Variables

​4. Instrument Your Code

​5. View Your Traces

​What’s Next?