Documentation

Setup Guide

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

Prerequisites

Quick Install

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

npx opusmax

Windows (PowerShell)

Alternative: Run the PowerShell setup script directly:

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

macOS / Linux

Alternative: Run the shell script:

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

Claude Code CLI

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

Automatic (Recommended)

Run npx opusmax and select Claude Code CLI.

Manual Configuration

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

{
  "mcpServers": {
    "OpusMax": {
      "command": "npx",
      "args": [
        "-y",
        "opusmax-mcp"
      ],
      "env": {
        "OPUSMAX_API_KEY": "YOUR_API_KEY",
        "OPUSMAX_URL": "https://api.opusmax.pro"
      }
    }
  }
}

VS Code

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

Automatic (Recommended)

Run npx opusmax and select VS Code.

Manual Configuration

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

Cursor

Configure Cursor IDE to use OpusMax for AI assistance.

Automatic (Recommended)

Run npx opusmax and select Cursor.

Manual MCP Configuration

{
  "mcpServers": {
    "OpusMax": {
      "command": "npx",
      "args": [
        "-y",
        "opusmax-mcp"
      ],
      "env": {
        "OPUSMAX_API_KEY": "YOUR_API_KEY",
        "OPUSMAX_URL": "https://api.opusmax.pro"
      }
    }
  }
}

API Routing

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

• Base URL: https://api.opusmax.pro/v1
• API Key: Your OpusMax API key
• Model: claude-sonnet-4-6

Windsurf

Configure Windsurf IDE to use OpusMax for AI assistance.

Automatic (Recommended)

Run npx opusmax and select Windsurf.

Manual MCP Configuration

{
  "mcpServers": {
    "OpusMax": {
      "command": "npx",
      "args": [
        "-y",
        "opusmax-mcp"
      ],
      "env": {
        "OPUSMAX_API_KEY": "YOUR_API_KEY",
        "OPUSMAX_URL": "https://api.opusmax.pro"
      }
    }
  }
}

API Routing

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

https://api.opusmax.pro/v1

Cline

Configure Cline (VS Code extension) to use OpusMax.

Automatic (Recommended)

Run npx opusmax and select Cline.

Manual Configuration

Add to your VS Code settings.json:

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

Roo Code

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

Automatic (Recommended)

Run npx opusmax and select Roo Code.

Manual Configuration

Add to your VS Code settings.json:

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

Authentication

All proxy endpoints accept API key authentication via either header:

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

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

Messages

{
  "model": "claude-sonnet-4-6",
  "max_tokens": 1024,
  "messages": [
    { "role": "user", "content": "Hello, Claude!" }
  ],
  "stream": false
}

{
  "id": "msg_...",
  "type": "message",
  "role": "assistant",
  "model": "claude-sonnet-4-6",
  "content": [
    { "type": "text", "text": "Hello! How can I help you today?" }
  ],
  "stop_reason": "end_turn",
  "usage": {
    "input_tokens": 12,
    "output_tokens": 15
  }
}

Models

{
  "data": [
    {
      "id": "claude-opus-4-6",
      "object": "model",
      "display_name": "Claude Opus 4.6",
      "created_at": "2025-01-01T00:00:00Z"
    },
    {
      "id": "claude-sonnet-4-6",
      "object": "model",
      "display_name": "Claude Sonnet 4.6",
      "created_at": "2025-01-01T00:00:00Z"
    },
    {
      "id": "claude-haiku-4-5-20251001",
      "object": "model",
      "display_name": "Claude Haiku 4.5",
      "created_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Token Counting

{
  "model": "claude-sonnet-4-6",
  "messages": [
    { "role": "user", "content": "How many tokens is this?" }
  ]
}

Key Status

{
  "status": "found",
  "name": "My Key",
  "isActive": true,
  "windowTokenLimit": "5000000",
  "windowTokensUsed": "1234567",
  "windowActive": true,
  "windowResetAt": "2026-03-19T15:00:00.000Z",
  "planName": "Pro",
  "expiresAt": "2026-06-19T00:00:00.000Z",
  "totalRequests": 142,
  "last24h": {
    "requests": 28,
    "tokensIn": 45000,
    "tokensOut": 12000,
    "totalTokens": 57000,
    "avgLatencyMs": 1250
  }
}

Web Search

{
  "query": "latest Node.js release 2026"
}

Image Analysis

{
  "prompt": "Describe what you see in this image",
  "image_url": "https://example.com/photo.jpg"
}

MCP Tools

OpusMax MCP server provides two tools for Claude Code and other MCP-compatible clients:

Installed automatically by npx opusmax or manually:

npm install -g opusmax-mcp

Available Models

Troubleshooting