# sub2 **Repository Path**: To-Mars/sub2 ## Basic Information - **Project Name**: sub2 - **Description**: No description available - **Primary Language**: Unknown - **License**: LGPL-3.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-07-08 - **Last Updated**: 2026-09-09 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Sub2API
[![Go](https://img.shields.io/badge/Go-1.25.7-00ADD8.svg)](https://golang.org/) [![Vue](https://img.shields.io/badge/Vue-3.4+-4FC08D.svg)](https://vuejs.org/) [![PostgreSQL](https://img.shields.io/badge/PostgreSQL-15+-336791.svg)](https://www.postgresql.org/) [![Redis](https://img.shields.io/badge/Redis-7+-DC382D.svg)](https://redis.io/) [![Docker](https://img.shields.io/badge/Docker-Ready-2496ED.svg)](https://www.docker.com/) Wei-Shaw%2Fsub2api | Trendshift **AI API Gateway Platform for Subscription Quota Distribution** English | [中文](README_CN.md) | [日本語](README_JA.md)
## ⚠️ Important Notice Please read the following carefully before using this project: - **🚨 Terms of Service Risk**: Using this project may violate the terms of service of Anthropic and other upstream providers. Please review the relevant providers' user agreements before use; all risks arising from such use are borne solely by the user. - **⚖️ Compliant Use**: Use this project only in compliance with the laws and regulations of your country or region. Any unlawful use is strictly prohibited. - **📖 Disclaimer**: This project is provided for technical learning and research purposes only. The authors assume no liability for account bans, service interruptions, data loss, or any other direct or indirect damages resulting from the use of this project. - **🚫 No Commercial Authorization**: The developers of this project have never authorized any individual or organization to conduct any form of commercial operation based on this project. Any commercial activity conducted in the name of or based on this project is unrelated to this project and its developers, and all resulting disputes, losses, and legal liabilities shall be borne solely by the party conducting such activity. ## ❤️ Sponsors > [Want to appear here?](mailto:support@sub2api.org)
CCTK.AI Thanks to CCTK.AI for sponsoring this project! CCTK.AI is an AI API gateway focused on stability and cost-effectiveness, offering fast relay services for Claude, OpenAI, Gemini, and other popular models. It works seamlessly with Claude Code, Codex, and other mainstream coding tools, delivering the same model capabilities at a fraction of the official cost. Register via this link for faster, more stable, and more affordable AI API access.
openmodel One API, every top model! OpenModel is a production-grade, high-availability AI API gateway that makes your applications truly fast and stable: automatic failover, smart routing to the best-performing channel, and a production-grade SLA. An SLA that far surpasses any single provider — making stability your core competitive advantage. Works directly with Claude Code, Codex, and Gemini CLI. Register via this link to get started.
ETok Thanks to ETok.ai for sponsoring this project! ETok.ai is dedicated to building a one-stop AI programming tool service platform. We offer professional Claude Code packages and technical community services, with support for Google Gemini and OpenAI Codex. Through carefully designed plans and a professional tech community, we provide developers with reliable service guarantees and continuous technical support, making AI-assisted programming a true productivity tool. Click here to register!
APIKEY.FUN Thanks to APIKEY.FUN for sponsoring this project! APIKEY.FUN is one of the core contributors to the sub2api open-source project, dedicated to providing open, stable, and cost-effective AI API access. The platform supports API relay services for Claude, OpenAI, Gemini, and other popular models, with pricing starting from as low as 7% of the original rate. Register via the exclusive link: APIKEY to enjoy a permanent 5% discount on all recharges.
AIGoCode Thanks to AIGoCode for sponsoring this project! AIGoCode is an all-in-one platform that integrates Claude Code, Codex, and the latest Gemini models, providing you with stable, efficient, and highly cost-effective AI coding services. The platform offers flexible subscription plans, zero risk of account suspension, direct access with no VPN required, and lightning-fast responses. AIGoCode has prepared a special benefit for sub2api users: if you register via this link, you'll receive an extra 10% bonus credit on your first top-up!
AICodeMirror Thanks to AICodeMirror for sponsoring this project! AICodeMirror provides official high-stability relay services for Claude Code / Codex / Gemini CLI, with enterprise-grade concurrency, fast invoicing, and 24/7 dedicated technical support. Claude Code / Codex / Gemini official channels at 38% / 2% / 9% of original price, with extra discounts on top-ups! AICodeMirror offers special benefits for sub2api users: register via this link to enjoy 20% off your first top-up, and enterprise customers can get up to 25% off!
bmoplus Huge thanks to BmoPlus for sponsoring this project! BmoPlus is a highly reliable AI account provider built strictly for heavy AI users and developers. They offer rock-solid, ready-to-use accounts and official top-up services for ChatGPT Plus / ChatGPT Pro (Full Warranty) / Claude Pro / Super Grok / Gemini Pro. By registering and ordering through BmoPlus - Premium AI Accounts & Top-ups, users can unlock the mind-blowing rate of 10% of the official GPT subscription price (90% OFF)
bestproxy Thanks to Bestproxy for sponsoring this project! Bestproxy provides high-purity residential IPs with dedicated one-IP-per-account support. By combining real home networks with fingerprint isolation, it enables link environment isolation and reduces the probability of association-based risk control.
pateway Thanks to PatewayAI for sponsoring this project! PatewayAI is a premium API relay built for heavy AI developers, offering the full Claude and Codex series sourced 100% from official providers, with transparent token-level billing. Enterprise plans include high concurrency, dedicated management, contracts, and invoicing. Register now to get $3 in trial credits, top-ups from 60% off, and referral bonuses up to $150.
pptoken Thanks to PPToken.org for sponsoring this project! PPToken.org specializes in GPT model API relay services, supporting Codex, Claude Code, OpenAI-compatible clients, and Gemini CLI integration. Top-ups are 1:1 (¥1 = $1 credit); GPT models start at 0.16x rate multiplier, with overall cost at roughly 2.2% of official pricing and first-token latency around 1 second — ideal for developers seeking low-cost, high-speed access to GPT model capabilities. Technical support: 24/7 real human responses (no bots), @tech in the group chat and get a reply within 10 minutes. Sponsor benefit: the first 200 users who register via the exclusive registration link and enter promo code `SUB2API` can claim free Codex / Claude Code trial credits — no minimum spend, no card required.
unity2 Thanks to Unity2 for sponsoring this project! Unity2 is a high-performance AI model API relay for individuals, teams, and enterprises, handling 30B+ tokens/day with 5000 RPM concurrency. One API Key works across Claude Code, Codex, OpenAI models, IDE plugins, and Agent workflows, with balance billing, bundled subscriptions, enterprise invoicing, and 1-on-1 support. Register to claim $2 in balance, plus $10 more by joining the official group — up to $12 in free credit.
veilx Thanks to Veilx for sponsoring this project! Veilx CDN is purpose-built for large-scale AI API traffic, deeply optimized for relay services and call chains across OpenAI, Claude, Gemini, and scenarios like chat, image generation, embeddings, and streaming — delivering lower latency and higher stability under heavy concurrency. It also offers China three-network optimized return lines, making it ideal for global AI relay platforms, overseas AI SaaS, and cross-border high-concurrency deployments.
veilx Thanks to RoxyBrowser for sponsoring this project! RoxyBrowser RoxyBrowser is the perfect partner for Sub2API: it features a built-in native Roxy AI Agent and high-quality native residential IPs, supports batch automation via simple commands, and significantly boosts security and efficiency for multi-account management! Click this link to sign up and receive a free residential IP package plus a 10% lifetime discount.
apikl Thanks to Apikl for sponsoring this project! Built on Sub2API, the platform provides developers with relay services for Codex / Claude series models, focusing on long-term stability, high-speed direct connections, and excellent cost-effectiveness. It offers pay-as-you-go balance billing, enterprise-grade official invoices, and one-on-one dedicated support. Register now for a 1:1 top-up bonus — double your balance!
tokeneum Thanks to TokenEum for sponsoring this project! TokenEum is a comprehensive AI model aggregation platform and intelligent agent development company. It brings together top-tier international models — including Claude, Gemini, and OpenAI — alongside leading open-source models such as GLM, Qwen, and Kimi, offering a wide range of options across different quality and price tiers to suit every need. TokenEum also provides access to cutting-edge video generation models like Seedance2.0 and Happy Horse. Committed to transparency and honest business practices, TokenEum ensures all model information is accurate and reliable. Visit tokeneum.ai to get started.
666api Thanks to 666api for sponsoring this project! 666api is an all-in-one platform offering:
⚡ API Relay — Pay-as-you-go access to global models sourced 100% from official providers, up to 75% off official pricing
    Exclusive: Zhipu GLM 50% off · DeepSeek V4-pro 50% off · Seedance 2.0 8% off (whitelisted) · HappyHorse Overseas 30% off (whitelisted)
🔑 GPT Subscription Accounts (same-origin IP included) · Global Residential IP
💰 Invoices supported
BytePlus Thanks to Dola seed for sponsoring this project! Dola Seed 2.0 is a full‑modal general large model independently developed by ByteDance for the global market. Built on a unified multimodal architecture, it supports joint understanding and generation of text, images, audio, and video. It natively enables agent collaboration, with strong reasoning, long‑task execution, tool integration, and coding capabilities. It is widely applicable to smart cockpits, personal assistants, education, customer support, marketing, retail, and other scenarios. It excels in multimodal perception, end‑to‑end complex task delivery, stable interaction, and data security, and is readily accessible and deployable via the ModelArk platform.Register via this link to get 500,000 tokens of free inference quota per model. >>中国大陆地区的开发者请点击这里
sui-xiang Thanks to Suixiang AI Gateway for sponsoring this project! Suixiang AI Gateway is a reliable and efficient API relay service provider offering relay services for Claude, Codex, Gemini, and more. A privacy-focused relay — no data reselling, no model dilution; privacy, transparency, and lightning-fast after-sales support. New accounts get ¥0.5 in trial credit daily by signing in; top-ups are 1:1, no subscription required, pay-as-you-go. Multi-line redundancy, cross-region disaster recovery, automatic failover, and uninterrupted long-link SSE. 99.9% availability — critical calls never fall behind.
miyaip Thanks to MiyaIP for sponsoring this project! MiyaIP is a platform dedicated to global residential proxy network services, committed to providing high-quality, pure overseas residential IP resources for enterprise developers, cross-border business teams, and AI application users. It delivers stable, independent overseas network environments for AI platforms, overseas SaaS, and other online services, supporting multi-region access testing and project environment isolation. Ideal for development and testing scenarios that require access to overseas AI services, such as: AI model platform access, AI development testing, AI SaaS service usage, AI API debugging, and multi-region network environment validation.
anpin Thanks to anpin.ai for sponsoring this project! anpin.ai is a premium AI relay service platform dedicated to advancing AI accessibility. With an advanced technical architecture and globally distributed deployment, it provides users with a direct high-speed channel to the world's top-tier large language models.
Self-built primary account pool: 1-3s ultra-fast response, supports channel-partner distribution
Extreme stability: multi-line intelligent routing + redundant backup system, ensuring year-round high-availability operation;
Model authenticity: no content intervention or secondary filtering — experience the purest, most powerful native model capabilities.
1:1 top-up, enterprise-grade service with invoicing available. Anpin AI is not just a relay — it's your secure, reliable, and efficient bridge to the frontier world of intelligence.
proxy4free Thanks to Proxy4Free for sponsoring this project! Proxy4Free is a data proxy service provider for developers and AI applications, offering residential proxies, static residential proxies, ISP proxies, and datacenter proxies for scenarios such as Web Scraping, Browser Automation, and AI Agents. With global IP resources, stable connections, and flexible switching, it helps developers improve data collection success rates and reduce the risk of IP bans. Register via this link to get started and easily build more stable and efficient automation workflows.
fastaitoken 🎉 Thanks to FastAIToken for sponsoring this project! FastAIToken is an AI API aggregation platform for developers, supporting mainstream large models such as OpenAI, Claude, and Gemini. Top-up at 1:1 — 1 CNY = 1 USD of API credit — letting developers use the world's leading large model services at lower cost and with greater convenience.
🚀 The platform offers a variety of channels to choose from: an ultra-low-price 0.02x OpenAI promotional group (limited time), groups as low as 0.25x OpenAI, 0.7x Claude with 95% fixed cache, and a 1.2x Claude Max channel. It also provides a public status page showing real-time availability, latency, and operating status of each group for transparent and reliable service, plus 7×24 human technical support (not bots) with fast responses to developer needs.
## Overview Sub2API is an AI API gateway platform designed to distribute and manage API quotas from AI product subscriptions. Users can access upstream AI services through platform-generated API Keys, while the platform handles authentication, billing, load balancing, and request forwarding. ## Features - **Multi-Account Management** - Support multiple upstream account types (OAuth, API Key) - **API Key Distribution** - Generate and manage API Keys for users - **Precise Billing** - Token-level usage tracking and cost calculation - **Smart Scheduling** - Intelligent account selection with sticky sessions - **Concurrency Control** - Per-user and per-account concurrency limits - **Rate Limiting** - Configurable request and token rate limits - **Built-in Payment System** - Supports EasyPay, Alipay, WeChat Pay, and Stripe for user self-service top-up, no separate payment service needed ([Configuration Guide](docs/PAYMENT.md)) - **Admin Dashboard** - Web interface for monitoring and management - **External System Integration** - Embed external systems (e.g. ticketing) via iframe to extend the admin dashboard ## Ecosystem Community projects that extend or integrate with Sub2API: | Project | Description | Features | |---------|-------------|----------| | ~~[Sub2ApiPay](https://github.com/touwaeriol/sub2apipay)~~ | ~~Self-service payment system~~ | **Now Built-in** — Payment is now integrated into Sub2API, no separate deployment needed. See [Payment Configuration Guide](docs/PAYMENT.md) | | [sub2api-mobile](https://github.com/ckken/sub2api-mobile) | Mobile admin console | Cross-platform app (iOS/Android/Web) for user management, account management, monitoring dashboard, and multi-backend switching; built with Expo + React Native | ## Tech Stack | Component | Technology | |-----------|------------| | Backend | Go 1.25.7, Gin, Ent | | Frontend | Vue 3.4+, Vite 5+, TailwindCSS | | Database | PostgreSQL 15+ | | Cache/Queue | Redis 7+ | --- ## Nginx Reverse Proxy Note When using Nginx as a reverse proxy for Sub2API (or CRS) with Codex CLI, add the following to the `http` block in your Nginx configuration: ```nginx underscores_in_headers on; ``` Nginx drops headers containing underscores by default (e.g. `session_id`), which breaks sticky session routing in multi-account setups. --- ## Deployment ### Method 1: Script Installation (Recommended) One-click installation script that downloads pre-built binaries from GitHub Releases. #### Prerequisites - Linux server (amd64 or arm64) - PostgreSQL 15+ (installed and running) - Redis 7+ (installed and running) - Root privileges #### Installation Steps ```bash curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/install.sh | sudo bash ``` The script will: 1. Detect your system architecture 2. Download the latest release 3. Install binary to `/opt/sub2api` 4. Create systemd service 5. Configure system user and permissions #### Post-Installation ```bash # 1. Start the service sudo systemctl start sub2api # 2. Enable auto-start on boot sudo systemctl enable sub2api # 3. Open Setup Wizard in browser # http://YOUR_SERVER_IP:8080 ``` The Setup Wizard will guide you through: - Database configuration - Redis configuration - Admin account creation #### Upgrade You can upgrade directly from the **Admin Dashboard** by clicking the **Check for Updates** button in the top-left corner. The web interface will: - Check for new versions automatically - Download and apply updates with one click - Support rollback if needed #### Useful Commands ```bash # Check status sudo systemctl status sub2api # View logs sudo journalctl -u sub2api -f # Restart service sudo systemctl restart sub2api # Uninstall curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/install.sh | sudo bash -s -- uninstall -y ``` --- ### Method 2: Docker Compose (Recommended) Deploy with Docker Compose, including PostgreSQL and Redis containers. #### Prerequisites - Docker 20.10+ - Docker Compose v2+ #### Quick Start (One-Click Deployment) Use the automated deployment script for easy setup: ```bash # Create deployment directory mkdir -p sub2api-deploy && cd sub2api-deploy # Download and run deployment preparation script curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/docker-deploy.sh | bash # Start services docker compose up -d # View logs docker compose logs -f sub2api ``` **What the script does:** - Downloads `docker-compose.local.yml` (saved as `docker-compose.yml`) and `.env.example` - Generates secure credentials (JWT_SECRET, TOTP_ENCRYPTION_KEY, POSTGRES_PASSWORD) - Creates `.env` file with auto-generated secrets - Creates data directories (uses local directories for easy backup/migration) - Displays generated credentials for your reference #### Manual Deployment If you prefer manual setup: ```bash # 1. Clone the repository git clone https://github.com/Wei-Shaw/sub2api.git cd sub2api/deploy # 2. Copy environment configuration cp .env.example .env # 3. Edit configuration (generate secure passwords) nano .env ``` **Required configuration in `.env`:** ```bash # PostgreSQL password (REQUIRED) POSTGRES_PASSWORD=your_secure_password_here # JWT Secret (RECOMMENDED - keeps users logged in after restart) JWT_SECRET=your_jwt_secret_here # TOTP Encryption Key (RECOMMENDED - preserves 2FA after restart) TOTP_ENCRYPTION_KEY=your_totp_key_here # Optional: Admin account ADMIN_EMAIL=admin@example.com ADMIN_PASSWORD=your_admin_password # Optional: Custom port SERVER_PORT=8080 ``` **Generate secure secrets:** ```bash # Generate JWT_SECRET openssl rand -hex 32 # Generate TOTP_ENCRYPTION_KEY openssl rand -hex 32 # Generate POSTGRES_PASSWORD openssl rand -hex 32 ``` ```bash # 4. Create data directories (for local version) mkdir -p data postgres_data redis_data # 5. Start all services # Option A: Local directory version (recommended - easy migration) docker compose -f docker-compose.local.yml up -d # Option B: Named volumes version (simple setup) docker compose up -d # 6. Check status docker compose -f docker-compose.local.yml ps # 7. View logs docker compose -f docker-compose.local.yml logs -f sub2api ``` #### Deployment Versions | Version | Data Storage | Migration | Best For | |---------|-------------|-----------|----------| | **docker-compose.local.yml** | Local directories | ✅ Easy (tar entire directory) | Production, frequent backups | | **docker-compose.yml** | Named volumes | ⚠️ Requires docker commands | Simple setup | **Recommendation:** Use `docker-compose.local.yml` (deployed by script) for easier data management. #### Access Open `http://YOUR_SERVER_IP:8080` in your browser. If admin password was auto-generated, find it in logs: ```bash docker compose -f docker-compose.local.yml logs sub2api | grep "admin password" ``` #### Upgrade ```bash # Pull latest image and recreate container docker compose -f docker-compose.local.yml pull docker compose -f docker-compose.local.yml up -d ``` #### Easy Migration (Local Directory Version) When using `docker-compose.local.yml`, migrate to a new server easily: ```bash # On source server docker compose -f docker-compose.local.yml down cd .. tar czf sub2api-complete.tar.gz sub2api-deploy/ # Transfer to new server scp sub2api-complete.tar.gz user@new-server:/path/ # On new server tar xzf sub2api-complete.tar.gz cd sub2api-deploy/ docker compose -f docker-compose.local.yml up -d ``` #### Useful Commands ```bash # Stop all services docker compose -f docker-compose.local.yml down # Restart docker compose -f docker-compose.local.yml restart # View all logs docker compose -f docker-compose.local.yml logs -f # Remove all data (caution!) docker compose -f docker-compose.local.yml down rm -rf data/ postgres_data/ redis_data/ ``` --- ### Method 3: Build from Source Build and run from source code for development or customization. #### Prerequisites - Go 1.21+ - Node.js 18+ - PostgreSQL 15+ - Redis 7+ #### Build Steps ```bash # 1. Clone the repository git clone https://github.com/Wei-Shaw/sub2api.git cd sub2api # 2. Install pnpm (if not already installed) npm install -g pnpm # 3. Build frontend cd frontend pnpm install pnpm run build # Output will be in ../backend/internal/web/dist/ # 4. Build backend with embedded frontend cd ../backend VERSION="$(./scripts/resolve-version.sh)" go build -tags embed -ldflags="-X main.Version=${VERSION}" -o sub2api ./cmd/server # 5. Create configuration file cp ../deploy/config.example.yaml ./config.yaml # 6. Edit configuration nano config.yaml ``` > **Note:** The `-tags embed` flag embeds the frontend into the binary. Without this flag, the binary will not serve the frontend UI. **Key configuration in `config.yaml`:** ```yaml server: host: "0.0.0.0" port: 8080 mode: "release" database: host: "localhost" port: 5432 user: "postgres" password: "your_password" dbname: "sub2api" redis: host: "localhost" port: 6379 password: "" jwt: secret: "change-this-to-a-secure-random-string" expire_hour: 24 default: user_concurrency: 5 user_balance: 0 api_key_prefix: "sk-" rate_multiplier: 1.0 ``` ### Sora Status (Temporarily Unavailable) > ⚠️ Sora-related features are temporarily unavailable due to technical issues in upstream integration and media delivery. > Please do not rely on Sora in production at this time. > Existing `gateway.sora_*` configuration keys are reserved and may not take effect until these issues are resolved. Additional security-related options are available in `config.yaml`: - `cors.allowed_origins` for CORS allowlist - `security.url_allowlist` for upstream/pricing/CRS host allowlists - `security.url_allowlist.enabled` to disable URL validation (use with caution) - `security.url_allowlist.allow_insecure_http` to allow HTTP URLs when validation is disabled - `security.url_allowlist.allow_private_hosts` to allow private/local IP addresses - `security.response_headers.enabled` to enable configurable response header filtering (disabled uses default allowlist) - `security.csp` to control Content-Security-Policy headers - `billing.circuit_breaker` to fail closed on billing errors - `server.trusted_proxies` to enable X-Forwarded-For parsing - `turnstile.required` to require Turnstile in release mode **⚠️ Security Warning: HTTP URL Configuration** When `security.url_allowlist.enabled=false`, the system performs minimal URL validation and **allows HTTP URLs by default** (dev-friendly mode; Docker Compose deployments use the same default). For production, explicitly tighten this to HTTPS-only: ```yaml security: url_allowlist: enabled: false # Disable allowlist checks allow_insecure_http: false # HTTPS only (recommended for production) ``` **Or via environment variable:** ```bash SECURITY_URL_ALLOWLIST_ENABLED=false SECURITY_URL_ALLOWLIST_ALLOW_INSECURE_HTTP=false ``` **Risks of allowing HTTP:** - API keys and data transmitted in **plaintext** (vulnerable to interception) - Susceptible to **man-in-the-middle (MITM) attacks** - **NOT suitable for production** environments **When to use HTTP:** - ✅ Development/testing with local servers (http://localhost) - ✅ Internal networks with trusted endpoints - ✅ Testing account connectivity before obtaining HTTPS - ❌ Production environments (use HTTPS only) **Example error for HTTP URLs when `allow_insecure_http: false` is set:** ``` Invalid base URL: invalid url scheme: http ``` If you disable URL validation or response header filtering, harden your network layer: - Enforce an egress allowlist for upstream domains/IPs - Block private/loopback/link-local ranges - Enforce TLS-only outbound traffic - Strip sensitive upstream response headers at the proxy #### ⚠️ Important: Creating the Admin Account The initial admin account is **only created via the setup wizard** (served at `http://:8080` on first run). The `default.admin_email` / `default.admin_password` fields in `config.yaml` are **not used** to create it — they exist in the template for historical reasons. Because step 5 above pre-creates `config.yaml`, the setup wizard will be **skipped on first run**: the server detects an existing config and boots straight into normal mode with an empty `users` table, so the first login attempt fails with `invalid email or password`. **Two ways to create the admin account:** 1. **Recommended — let the wizard generate `config.yaml`:** Skip step 5 (do not run the `cp`). Start `./sub2api` directly; the setup wizard at `http://localhost:8080` walks you through database, Redis, and admin account setup, then writes `config.yaml` for you. 2. **If you already created `config.yaml`:** Temporarily move it aside so the wizard can trigger on first run, then restore it afterwards: ```bash mv config.yaml config.yaml.bak ./sub2api # wizard runs at http://localhost:8080 and writes a fresh config.yaml # stop the server (Ctrl+C) once the wizard completes, then restore your config: mv config.yaml.bak config.yaml ./sub2api # restart in normal mode and log in with the admin you just created ``` ```bash # 6. Run the application ./sub2api ``` #### Development Mode ```bash # Backend (with hot reload) cd backend go run ./cmd/server # Frontend (with hot reload) cd frontend pnpm run dev ``` #### Code Generation When editing `backend/ent/schema`, regenerate Ent + Wire: ```bash cd backend go generate ./ent go generate ./cmd/server ``` --- ## Simple Mode Simple Mode is designed for individual developers or internal teams who want quick access without full SaaS features. - Enable: Set environment variable `RUN_MODE=simple` - Difference: Hides SaaS-related features and skips billing process - Security note: In production, you must also set `SIMPLE_MODE_CONFIRM=true` to allow startup --- ## Grok / xAI OAuth Support Sub2API supports Grok subscription accounts through xAI OAuth and forwards OpenAI-compatible Responses traffic to xAI. ### Supported Scope - Platform name: `grok` - Account type: OAuth subscription accounts - Public Responses targets: `/v1/responses`, `/responses`, and `/backend-api/codex/responses`, forwarded to `${XAI_BASE_URL:-https://api.x.ai/v1}/responses` - Public Claude-compatible target: `/v1/messages`, converted to xAI Responses and returned as Anthropic Messages output for Claude CLI style clients - Public Chat Completions targets: `/v1/chat/completions` and `/chat/completions`, forwarded to `${XAI_BASE_URL:-https://api.x.ai/v1}/chat/completions` - Codex CLI style Responses WebSocket ingress is accepted on the Responses targets and bridged to xAI HTTP/SSE Responses upstream - Initial text models: `grok-4.3`, `grok-build-0.1`, `grok-4.20-0309-reasoning`, `grok-4.20-0309-non-reasoning`, and `grok-4.20-multi-agent-0309` - Media targets for Grok groups: `/v1/images/generations`, `/images/generations`, `/v1/images/edits`, `/images/edits`, `/v1/videos/generations`, `/videos/generations`, `/v1/videos/{request_id}`, `/videos/{request_id}`, `/v1/files/{file_id}/content`, and `/files/{file_id}/content`. File content responses are authenticated MP4 streams and support HTTP range requests. Generation requests require the group image-generation permission. - Media models: `grok-imagine`, `grok-imagine-image-quality`, `grok-imagine-image`, `grok-imagine-edit`, `grok-imagine-video`, and `grok-imagine-video-1.5` - Out of scope for this provider: TTS, transcription, browser automation, cookies, and Grok web scraping ## Xiaobalong Video Compatibility Xiaobalong video accounts use the OpenAI-compatible video endpoints: - `POST /v1/videos` and `POST /v1/videos/generations` - `GET /v1/videos/{task_id}` - Request fields: `model`, `prompt`, `seconds` or `duration`, `size` or `resolution`, `aspect_ratio`, and `images` or `input_reference` - SD models are accepted only from a Xiaobalong model group; they are never routed through another video provider. - `seconds` accepts either a JSON number or a numeric string. Supported durations are 6, 10, and 15 seconds; the `sd2.5-720p-30s` and `sd2.5-480p-30s` models also support 30 seconds. - Compatibility aliases must not conflict: provide only one of each pair, or provide equivalent values. Invalid reference-image items are rejected instead of being silently dropped. - Reusing an `Idempotency-Key` with a different request body returns a conflict. A concurrent request with the same key returns `409` until the original request completes. - If the service process is interrupted before the claim is finalized, the claim expires to `503 idempotency_recovery_required`; verify the provider task before retrying with a new key. The service does not blindly recreate an uncertain provider request. - The response task ID is the Xiaobalong provider task ID and must be used with the status endpoint. ### OAuth Configuration The Grok OAuth flow uses PKCE and does not require committing private secrets. The default client details follow the public xAI OAuth flow used by compatible clients, and every value can be overridden by environment variable: | Variable | Default | |----------|---------| | `XAI_OAUTH_CLIENT_ID` | Public xAI OAuth client ID | | `XAI_OAUTH_SCOPE` | `openid profile email offline_access grok-cli:access api:access` | | `XAI_OAUTH_REDIRECT_URI` | `http://127.0.0.1:56121/callback` | | `XAI_OAUTH_AUTHORIZE_URL` | `https://auth.x.ai/oauth2/authorize` | | `XAI_OAUTH_TOKEN_URL` | `https://auth.x.ai/oauth2/token` | | `XAI_BASE_URL` | `https://api.x.ai/v1` | Administrators can create or reauthorize Grok accounts from the dashboard, or use the admin API: | Endpoint | Purpose | |----------|---------| | `POST /api/v1/admin/grok/oauth/auth-url` | Generate an xAI OAuth authorization URL | | `POST /api/v1/admin/grok/oauth/exchange-code` | Exchange a callback URL, query string, or code for OAuth credentials | | `POST /api/v1/admin/grok/oauth/refresh-token` | Validate or refresh a Grok refresh token | | `POST /api/v1/admin/grok/accounts/:id/refresh` | Refresh an existing Grok account | Credential storage reuses the existing account JSON fields: `access_token`, `refresh_token`, `token_type`, `expires_at`, optional `email`, optional `subscription_tier`, and `entitlement_status`. ### Usage And Quota Display xAI quota is passive. Sub2API does not invent subscription quota values; it records whitelisted xAI rate-limit headers from successful or rate-limited upstream responses when xAI sends them. Before the first usable upstream response, the dashboard shows quota as unknown and still displays local Sub2API usage stats. `401` responses mark the account as needing reauthorization. `403` responses are treated as entitlement or subscription-tier failures instead of token-refresh loops. `429` responses use `Retry-After` or a short cooldown to temporarily remove the account from scheduling. --- ## Antigravity Support Sub2API supports [Antigravity](https://antigravity.so/) accounts. After authorization, dedicated endpoints are available for Claude and Gemini models. ### Dedicated Endpoints | Endpoint | Model | |----------|-------| | `/antigravity/v1/messages` | Claude models | | `/antigravity/v1beta/` | Gemini models | ### Claude Code Configuration ```bash export ANTHROPIC_BASE_URL="http://localhost:8080/antigravity" export ANTHROPIC_AUTH_TOKEN="sk-xxx" ``` ### Hybrid Scheduling Mode Antigravity accounts support optional **hybrid scheduling**. When enabled, the general endpoints `/v1/messages` and `/v1beta/` will also route requests to Antigravity accounts. > **⚠️ Warning**: Anthropic Claude and Antigravity Claude **cannot be mixed within the same conversation context**. Use groups to isolate them properly. --- ## Project Structure ``` sub2api/ ├── backend/ # Go backend service │ ├── cmd/server/ # Application entry │ ├── internal/ # Internal modules │ │ ├── config/ # Configuration │ │ ├── model/ # Data models │ │ ├── service/ # Business logic │ │ ├── handler/ # HTTP handlers │ │ └── gateway/ # API gateway core │ └── resources/ # Static resources │ ├── frontend/ # Vue 3 frontend │ └── src/ │ ├── api/ # API calls │ ├── stores/ # State management │ ├── views/ # Page components │ └── components/ # Reusable components │ └── deploy/ # Deployment files ├── docker-compose.yml # Docker Compose configuration ├── .env.example # Environment variables for Docker Compose ├── config.example.yaml # Full config file for binary deployment └── install.sh # One-click installation script ``` ## Star History Star History Chart --- ## License This project is licensed under the [GNU Lesser General Public License v3.0](LICENSE) (or later). Copyright (c) 2026 Wesley Liddick ---
**If you find this project useful, please give it a star!**