Installation

You’ll learn how to install Opswald and get your API key. Takes about 2 minutes.

Install the SDK

Python

pip install opswald

TypeScript

npm install opswald

Get Your API Key

1. Sign up at app.opswald.com
2. Go to Settings → API Keys
3. Click Create Key and copy it

Initialize the SDK

Python

import opswald

opswald.init(
    api_key='ops_your_key_here',
    base_url='https://api.opswald.com'
)

TypeScript

import { init } from 'opswald';

init({
    apiKey: 'ops_your_key_here',
    baseUrl: 'https://api.opswald.com'
});

Tip

Set your API key as an environment variable OPSWALD_API_KEY to avoid hardcoding it.

Proxy Setup (Zero Code)

If you’d rather not add SDK calls to your code, use the Opswald proxy. Point your LLM provider’s base URL to the proxy and it captures traces automatically.

# Start the proxy
npx opswald-proxy --port 4000 --api-key ops_your_key_here

# Point OpenAI to the proxy
export OPENAI_BASE_URL=http://localhost:4000/openai/v1

All your existing OpenAI/Anthropic calls will now be traced without any code changes.

Next Steps

• Quick Start — Create your first trace in 5 minutes
• Proxy Configuration — Full proxy config reference