Documentation

Setup guide

One command gets you running. Everything below is the manual version, plus the full API reference — endpoints, model IDs and the tools that are already switched on.

Drop-in compatiblePer-key budgetsBuilt-in tools13 models

Prerequisites

Node.js 18+Download from nodejs.org

An OpusLive API keyFrom your dashboard, admin or reseller

A supported editorClaude Code, VS Code, Cursor, Windsurf, Cline or Roo Code

Quick install

The fastest route. The wizard writes the right config for whichever editors you pick.

Terminal
npx opuslive

What it does

1Asks for your API key
2Lets you choose which editors to configure
3Writes the correct base URL and model defaults
4Leaves web search and image analysis on — no extra setup
5Verifies the connection before it exits

Windows (PowerShell)

Or run the setup script directly:

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

macOS / Linux

Or run the shell script:

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

Claude Code CLI

Point Claude Code at OpusLive and every model below becomes selectable from /model.

Automatic

Run npx opuslive and select Claude Code CLI.

Manual

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": "Fable 5[1m]",
    "ANTHROPIC_SMALL_FAST_MODEL": "Haiku 4.5",
    "ANTHROPIC_DEFAULT_SONNET_MODEL": "Sonnet 5[1m]",
    "ANTHROPIC_DEFAULT_OPUS_MODEL": "Opus 4.8[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 own key. The [1m] suffix selects the 1M-token context tier and is stripped before the request is forwarded.

VS Code

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

Automatic

Run npx opuslive and select VS Code.

Manual

Same two files as Claude Code CLI above. Restart VS Code afterwards.

Cursor

Automatic

Run npx opuslive and select Cursor.

Manual

Settings → Models → add an OpenAI-compatible model with:

  • Base URL: https://api.opusmax.live/v1
  • API key: your OpusLive key
  • Model: claude-sonnet-5

Windsurf

Automatic

Run npx opuslive and select Windsurf.

Manual

Settings → AI Provider → set the base URL to:

Base URL
https://api.opusmax.live/v1

Cline

Automatic

Run npx opuslive and select Cline.

Manual

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

Automatic

Run npx opuslive and select Roo Code.

Manual

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

Every proxy endpoint accepts either header:

Header options
x-api-key: YOUR_API_KEY
# or
Authorization: Bearer YOUR_API_KEY

Dashboard endpoints use a JWT from /auth/login instead.

Messages

POST/api/v1/messagesAPI key

Create a message. Anthropic-compatible request and response shapes. Set stream: true for SSE.

Streaming. With stream: true you get server-sent events — message_start, content_block_delta and message_stop — forwarded as they arrive.

Models

GET/api/v1/modelsNone

List every available model. Each entry carries a context_window in tokens so clients can size their context indicators correctly. Fable 5, Opus 5, Sonnet 5, Opus 4.8, Opus 4.7, Opus 4.6, Sonnet 4.6 are 1,000,000; the rest are 200,000.

Token counting

POST/api/v1/messages/count_tokensAPI key

Count the tokens in a message without sending it.

Key status

GET/api/key-status?key=None

Read the status, usage and limits of an API key. This is what the Check Usage page calls.

Image analysis

POST/tools/understand_imageAPI key

Analyse an image. Accepts HTTP URLs, local paths or base64 data URLs, up to 18MB.

Built-in tools

These run on the server and fire on their own. There is no client-side package to install and no MCP configuration to write.

Web search

Live web results whenever the model needs current information.

Image analysis

Send any image and get a detailed reading back, processed server-side.

Available models

Every model is open on every plan. Pass the ID, or the friendly alias — both resolve to the same model.

Claude Fable 5

New1M context
claude-fable-5

The most capable model in the lineup. Frontier reasoning and long-horizon agentic work.

Claude Opus 5

New1M context
claude-opus-5

The new Opus flagship. Thinks before answering by default, and its knowledge runs to May 2026 — the most recent of any model here.

Claude Sonnet 5

New1M context
claude-sonnet-5

Frontier intelligence at Sonnet speed. The new default for day-to-day building.

Claude Opus 4.8

1M context
claude-opus-4-8

The previous Opus flagship. Adaptive thinking and sustained agentic coding across a 1M window.

Claude Opus 4.7

1M context
claude-opus-4-7

The previous flagship. Still the pick for teams pinned to a known-good version.

Claude Opus 4.6

1M context
claude-opus-4-6

Long-context Opus for deep repository work.

Claude Sonnet 4.6

1M context
claude-sonnet-4-6

The workhorse — balanced speed and reasoning for everyday tasks.

Claude Opus 4.5

200K context
claude-opus-4-5

Opus-class reasoning on the 200K window.

Claude Sonnet 4.5

200K context
claude-sonnet-4-5-20250929

Dated Sonnet build for pinned, reproducible deployments.

Claude Haiku 4.5

200K context
claude-haiku-4-5-20251001

The fastest model here. Built for high-throughput, latency-sensitive calls.

Claude Opus 4.1

200K context
claude-opus-4-1-20250805

Kept available for workloads already tuned against it.

Claude Opus 4

200K context
claude-opus-4-20250514

Kept available for workloads already tuned against it.

Claude Sonnet 4

200K context
claude-sonnet-4-20250514

Kept available for workloads already tuned against it.

Troubleshooting

Connection errors

Check the key is active and not expired on the Check Usage page.

Web search or image tools not firing

They are server-side and always on. If they seem inactive, the key is usually the problem, not the config.

Model not found

Use an exact ID from the models list above, or a friendly alias.

Rate limited

Your five-hour window may be spent. Check /api/key-status for the reset time.

Changes not applying

Restart the editor after any config change.

Cursor or Windsurf not routing

Make sure the URL you pasted ends in /v1.