Documentation

Setup Guide

Get up and running with OpusLive in under a minute. Choose your platform and IDE below.

Drop-in Compatible

Per-Key Budgets

Built-in Tools

Full Claude Lineup

Prerequisites

Node.js 18+ — Download from nodejs.org

An OpusLive API key — Get one from your admin or reseller

A supported IDE — Claude Code, VS Code, Cursor, Windsurf, Cline, or Roo Code

Quick Install

The fastest way to get started. Run the interactive wizard:

Terminal

npx opuslive

What it does

1Asks for your API key

2Lets you choose which IDEs to configure

3Configures your IDE with the correct API settings

4Web search & image analysis work automatically — no extra setup

5Verifies your connection

Windows (PowerShell)

Alternative: Run the PowerShell setup script directly:

PowerShell (Administrator)

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
irm https://opusmax.live/setup.ps1 | iex

macOS / Linux

Alternative: Run the shell script:

Terminal

curl -fsSL https://opusmax.live/setup.sh | bash

Claude Code CLI

Configure Claude Code CLI to use OpusLive as the API gateway.

Automatic (Recommended)

Run npx opuslive and select Claude Code CLI.

Manual Configuration

Create or edit ~/.claude/settings.json:

~/.claude/settings.json

{
  "env": {
    "ANTHROPIC_AUTH_TOKEN": "YOUR_API_KEY",
    "ANTHROPIC_BASE_URL": "https://api.opusmax.live",
    "ANTHROPIC_MODEL": "Opus 4.7[1m]",
    "ANTHROPIC_SMALL_FAST_MODEL": "Haiku 4.5",
    "ANTHROPIC_DEFAULT_SONNET_MODEL": "Sonnet 4.6",
    "ANTHROPIC_DEFAULT_OPUS_MODEL": "Opus 4.7[1m]",
    "ANTHROPIC_DEFAULT_HAIKU_MODEL": "Haiku 4.5",
    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1"
  },
  "hasCompletedOnboarding": true
}

Create or edit ~/.claude.json:

~/.claude.json

// No MCP configuration needed — web search and image analysis work automatically

Replace YOUR_API_KEY with your actual API key.

VS Code

The VS Code Claude extension uses the same configuration as Claude Code CLI.

Automatic (Recommended)

Run npx opuslive and select VS Code.

Manual Configuration

Same files as Claude Code CLI above. Restart VS Code after configuration.

Cursor

Configure Cursor IDE to use OpusLive for AI assistance.

Automatic (Recommended)

Run npx opuslive and select Cursor.

API Routing

Open Cursor Settings → Models → Add OpenAI-compatible model with:

Base URL: https://api.opusmax.live/v1
API Key: Your OpusLive API key
Model: claude-sonnet-4-6

Windsurf

Configure Windsurf IDE to use OpusLive for AI assistance.

Automatic (Recommended)

Run npx opuslive and select Windsurf.

API Routing

Open Windsurf Settings → AI Provider → set base URL to:

Base URL

https://api.opusmax.live/v1

Cline

Configure Cline (VS Code extension) to use OpusLive.

Automatic (Recommended)

Run npx opuslive and select Cline.

Manual Configuration

Add to your VS Code settings.json:

settings.json

{
  "cline.apiProvider": "anthropic",
  "cline.anthropicBaseUrl": "https://api.opusmax.live",
  "cline.apiKey": "YOUR_API_KEY"
}

Roo Code

Configure Roo Code (VS Code extension) to use OpusLive.

Automatic (Recommended)

Run npx opuslive and select Roo Code.

Manual Configuration

Add to your VS Code settings.json:

settings.json

{
  "roo-cline.apiProvider": "anthropic",
  "roo-cline.anthropicBaseUrl": "https://api.opusmax.live",
  "roo-cline.apiKey": "YOUR_API_KEY"
}

Authentication

All proxy endpoints accept API key authentication via either header:

Header Options

x-api-key: YOUR_API_KEY
# OR
Authorization: Bearer YOUR_API_KEY

Dashboard endpoints use JWT tokens obtained from the /auth/login endpoint.

Messages

POST/api/v1/messagesAPI Key

Create a message. Supports streaming via stream: true. Anthropic-compatible request/response format.

Streaming: When stream: true, returns Server-Sent Events (SSE) with message_start, content_block_delta, and message_stop events.

Models

GET/api/v1/modelsNone

List all available models. Each entry includes a context_window field (in tokens) so clients can size their context indicators correctly. Opus 4.7 is 1,000,000; other models are 200,000.

Token Counting

POST/api/v1/messages/count_tokensAPI Key

Count tokens for a message without sending it.

Key Status

GET/api/key-status?key=None

Check the status, usage, and limits of an API key.

Web Search

POST/tools/web_searchAPI Key

Search the web for real-time information. Use 3-5 keywords for best results.

Image Analysis

POST/tools/understand_imageAPI Key

Analyze images with AI. Accepts HTTP URLs, local file paths, or base64 data URLs. Max 18MB.

Built-in Tools

OpusLive includes built-in tools that work automatically — no client-side installation or MCP setup needed:

Web Search

Real-time web search for up-to-date information. Works automatically when the model needs current data.

Image Analysis

AI-powered image understanding. Send any image and get detailed analysis — processed server-side.

Available Models

Opus 4.7

Premium

claude-opus-4-7

Most capable — flagship model with 1M context, adaptive thinking, and improved agentic coding.

Sonnet 4.6

Popular

claude-sonnet-4-6

Best balance of speed and intelligence for everyday tasks.

Haiku 4.5

Fast

claude-haiku-4-5-20251001

Fastest responses for simple queries and high-throughput use cases.

Troubleshooting

Connection errors

Check your API key is active and not expired.

Web search or image tools not working?

These tools are built into the server and work automatically. If issues persist, check your API key is valid.

Model not found

Use exact model IDs from the models section.

Rate limited

Your 5-hour usage window may be exhausted. Check /api/key-status.

Changes not applying

Restart your IDE after any config change.

Cursor/Windsurf not routing

Make sure you're using the /v1 endpoint URL.