Documentation

Setup Guide

Get Omega Plus running inside your IDE or AI client with the real proxy URL, Omega model IDs, and Anthropic-compatible endpoints.

Drop-in Compatible Per-Key Budgets Proxy Auth 23 Models

Prerequisites

Node.js 18 or newer

Required for running the Omega Plus npm setup wizard with npx.

Omega Plus API key

Create or receive a customer API key before connecting a coding tool.

Supported coding tool

Claude Code, Codex, OpenCode, Cline, Roo Code, Kilo Code, Factory Droid, OpenClaw, Zed, Warp, Continue, Aider, Cursor, Windsurf, or any OpenAI/Anthropic-compatible client.

If Node.js is not installed, download the official installer from nodejs.org, then reopen your terminal and run the setup command.

Quick Setup

Run the Omega Plus setup wizard, paste your API key, then choose the coding tool you want to configure.

Install

macOS / Linux:      curl -fsSL https://omegaplusapi.com/omega-helper.sh | sh
Windows PowerShell: irm https://omegaplusapi.com/omega-helper.ps1 | iex

Then run: omega-plus

Connection Values

API origin: https://api.omegaplusapi.com
Anthropic-compatible URL: https://api.omegaplusapi.com
OpenAI-compatible URL: https://api.omegaplusapi.com/api/v1
API Key: YOUR_API_KEY
Primary model: omega-plus
Fast model: omega-plus

Interactive Setup Flow

The wizard keeps the API key out of the shell history, detects installed tools, and writes the right config for the selected tool.

Omega Plus banner appears in the terminal.

User pastes the Omega API key when prompted.

Wizard validates the key and lists available coding tools.

User enters the tool number, then Omega Plus writes the config.

User opens or restarts the selected coding tool.

Connect your workspace

Coding-agent setup

23 public models. Complete files, OS-specific instructions and honest compatibility notes. Helper 2.9.1 · catalog verified 2026-09-12.

Loading complete tutorial…

Authentication

Proxy endpoints accept API key authentication through either header. Dashboard endpoints use JWT tokens returned from the login endpoint.

Header Options

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

POST/v1/messagesAPI Key

Messages

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

Request

{
  "model": "omega-plus",
  "max_tokens": 1024,
  "messages": [
    { "role": "user", "content": "Hello, Omega!" }
  ],
  "stream": false
}

Image & Vision

All 23 public models advertise image input. Send images via /v1/messages (Anthropic format) or /api/v1/chat/completions (OpenAI format).

Anthropic Format (POST /v1/messages)

Request

{
  "model": "claude-fable-5",
  "max_tokens": 256,
  "messages": [{
    "role": "user",
    "content": [
      {
        "type": "image",
        "source": {
          "type": "base64",
          "media_type": "image/png",
          "data": "<base64-encoded-image>"
        }
      },
      {
        "type": "text",
        "text": "What do you see in this image?"
      }
    ]
  }]
}

OpenAI Format (POST /api/v1/chat/completions)

Request

{
  "model": "claude-fable-5",
  "max_tokens": 256,
  "messages": [{
    "role": "user",
    "content": [
      {
        "type": "image_url",
        "image_url": {
          "url": "data:image/png;base64,<base64-encoded-image>"
        }
      },
      {
        "type": "text",
        "text": "What do you see in this image?"
      }
    ]
  }]
}

Vision Capability

Model	Vision	Method
Omega Plus	Yes	Native
Claude Opus 4.6 / 4.7 / 4.8	Yes	Native
Claude Sonnet 4.6	Yes	Native
Fable 5	Yes	Native
GPT 5.5	Yes	Native
Gemini 3.1 Pro	Yes	Native
MiniMax M3	Yes	Native (multimodal)
DeepSeek V4 Pro	Bridge	Omega Vision Bridge
Qwen 3.7 Plus	Bridge	Omega Vision Bridge
GLM 5.2	Bridge	Omega Vision Bridge

Omega Vision Bridge — DeepSeek V4 Pro, Qwen 3.7 Plus, and GLM 5.2 don't natively support vision. Omega Vision Bridge automatically describes images to text, then sends the text description to the model. Fully transparent — no configuration needed, images work out of the box.

POST/api/v1/audio/speechAPI Key

Omega Voice 1

Generate a complete MP3 or WAV file using the same Omega Plus API key as the LLM endpoints. Pricing is ₹5 per 10,000 successfully generated characters. Every eligible account starts with ₹50 of voice-only launch credit, equal to 100,000 characters.

curl

curl -X POST https://api.omegaplusapi.com/api/v1/audio/speech \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "omega-voice-1",
    "input": "Hello, this is Omega Voice 1!",
    "voice": "omega-ava",
    "response_format": "mp3",
    "speed": 1
  }' \
  --output speech.mp3

Field	Required	Accepted value
`model`	Yes	omega-voice-1
`input`	Yes	1–5,000 Unicode characters
`voice`	No	Omega voice ID; default omega-ava
`response_format`	No	mp3 (default) or wav
`speed`	No	0.5–2.0; default 1.0

ar

Female

omega-laylaomega-nooromega-mariamomega-hanaomega-yasmin

Male

omega-omaromega-zaydomega-kareemomega-samiromega-tarek

Failed or rejected generations do not consume credit. Once the launch balance is exhausted, successful generations use the customer's Media Wallet.

GET/v1/modelsNone

Models

List all available public Omega model IDs.

Response

{
  "data": [
    {
      "id": "omega-plus",
      "object": "model",
      "display_name": "Omega Plus"
    },
    {
      "id": "claude-opus-4-6",
      "object": "model",
      "display_name": "Claude Opus 4.6"
    },
    {
      "id": "claude-opus-4-7",
      "object": "model",
      "display_name": "Claude Opus 4.7"
    },
    {
      "id": "claude-opus-4-8",
      "object": "model",
      "display_name": "Claude Opus 4.8"
    },
    {
      "id": "gpt-5.5",
      "object": "model",
      "display_name": "GPT 5.5"
    },
    {
      "id": "claude-sonnet-4-6",
      "object": "model",
      "display_name": "Claude Sonnet 4.6"
    },
    {
      "id": "gemini-3.1-pro",
      "object": "model",
      "display_name": "Gemini 3.1 Pro"
    },
    {
      "id": "deepseek-v4-pro",
      "object": "model",
      "display_name": "DeepSeek V4 Pro"
    },
    {
      "id": "qwen-3.7-plus",
      "object": "model",
      "display_name": "Qwen 3.7 Plus"
    },
    {
      "id": "minimax-m3",
      "object": "model",
      "display_name": "MiniMax M3"
    },
    {
      "id": "glm-5.2",
      "object": "model",
      "display_name": "GLM 5.2"
    },
    {
      "id": "claude-fable-5",
      "object": "model",
      "display_name": "Fable 5"
    },
    {
      "id": "claude-sonnet-5",
      "object": "model",
      "display_name": "Claude Sonnet 5"
    },
    {
      "id": "gpt-5.6-sol",
      "object": "model",
      "display_name": "GPT-5.6 Sol"
    },
    {
      "id": "claude-opus-5",
      "object": "model",
      "display_name": "Claude Opus 5"
    },
    {
      "id": "quantum-lite-1",
      "object": "model",
      "display_name": "Quantum Lite 1"
    },
    {
      "id": "gemini-3.6-flash",
      "object": "model",
      "display_name": "Gemini 3.6 Flash"
    },
    {
      "id": "gemini-3.7-flash",
      "object": "model",
      "display_name": "Gemini 3.7 Flash"
    },
    {
      "id": "gemini-3.8-flash",
      "object": "model",
      "display_name": "Gemini 3.8 Flash"
    },
    {
      "id": "glm-5.3-flash",
      "object": "model",
      "display_name": "GLM 5.3 Flash"
    },
    {
      "id": "deepseek-v4-flash",
      "object": "model",
      "display_name": "DeepSeek V4 Flash"
    },
    {
      "id": "qwen-3.8",
      "object": "model",
      "display_name": "Qwen 3.8"
    },
    {
      "id": "quantum-flash",
      "object": "model",
      "display_name": "Quantum Flash (temporarily free; eligibility required)"
    }
  ]
}

POST/v1/messages/count_tokensAPI Key

Token Counting

Count tokens for a message without sending it to a provider.

Request

{
  "model": "omega-plus",
  "messages": [
    { "role": "user", "content": "How many tokens is this?" }
  ]
}

Billing & Usage

GET/v1/billingAPI Key

Current Billing

Returns the account mode and the billing source that would currently pay for a request. Coding plans are named explicitly; token packs always return a null expiry because they do not expire.

Request

curl https://api.omegaplusapi.com/v1/billing \
  -H "Authorization: Bearer YOUR_API_KEY"

Token pack response

{
  "object": "billing_status",
  "account_mode": "token_pack",
  "billing_type": "token_pack",
  "coding_plan": null,
  "token_pack": {
    "total_tokens": 250000000,
    "used_tokens": 42000000,
    "remaining_tokens": 208000000,
    "usage_percent": 16.8,
    "assigned_at": "2026-09-01T08:00:00.000Z",
    "expires_at": null,
    "non_expiring": true
  }
}

GET/v1/usageAPI Key

Quota Usage

Returns billable quota counters. Coding-plan daily resets follow IST midnight; each reset timestamp is returned as ISO 8601 UTC.

Request

curl https://api.omegaplusapi.com/v1/usage \
  -H "x-api-key: YOUR_API_KEY"

Coding plan response

{
  "object": "usage",
  "account_mode": "coding_plan",
  "billing_type": "coding_plan",
  "coding_plan": {
    "id": "starter",
    "name": "Starter",
    "status": "active",
    "daily": {
      "used": 2500000,
      "limit": 33300000,
      "remaining": 30800000,
      "usage_percent": 7.5,
      "reset_at": "2026-09-28T18:30:00.000Z"
    },
    "monthly": {
      "used": 81000000,
      "limit": 1000000000,
      "remaining": 919000000,
      "usage_percent": 8.1,
      "reset_at": "2026-10-01T18:30:00.000Z"
    }
  },
  "token_pack": null
}

Hybrid accounts return account_mode: smart_lb. Their billing_type is the effective source currently in use and may change from coding_plan to token_pack after quota exhaustion.

POST/api/auth/loginEmail + Password

Dashboard Auth

Use this route to sign in to dashboard sessions.

Request

{
  "email": "YOUR_EMAIL",
  "password": "YOUR_PASSWORD"
}