Skip to content

Getting Started

Welcome to FluxionAPI. This guide explains how to add funds, create an API key, configure a client, and resolve common setup problems.

Important: This page covers the basic onboarding flow. See the Help Center for detailed configuration and troubleshooting.

Contents

1. Quick start

Step 1: Add balance or subscribe

FluxionAPI supports two independent billing methods: usage-based balance and subscription plans.

Usage-based balance

  • Best for: small or irregular workloads billed by actual consumption.
  • How to purchase: open the top-up/subscription page, select an amount, and complete payment. The new balance appears in the upper-right corner.
  • How it is charged: API usage is deducted from the account balance.

Subscription plans

  • Best for: sustained token usage with plan allowance and group-multiplier discounts.
  • How to subscribe: switch to subscriptions on the purchase page, select a plan, and complete payment. The plan appears under “My subscriptions.”
  • Separate allowance: subscription allowance is not mixed with account balance.
  • Limits: the plan's daily, weekly, or monthly total is the governing allowance. Shorter limits may also protect shared upstream capacity.

Important

  1. Balance and subscriptions are separate billing methods and require the corresponding API-key type.
  2. Prefer on-site payment for lower fees. If needed, purchase a code from the redemption-code store and redeem it in the console.
  3. Complete on-site payment in a desktop browser; the mobile page may not redirect correctly.

Pricing overview

1. Allowance value

  • The current source states a 1:1 balance conversion: RMB 1 paid equals USD 1 of internal allowance.
  • GPT plans start at roughly 20% off, while Claude plans start at roughly 25% off.

2. Request pricing

  • Base prices follow the corresponding official API price and represent a billing rate.
  • The selected group's multiplier determines the final charge.
  • Example: if the official token charge is USD 2 and the group multiplier is 0.05, the platform deducts 2 × 0.05 = 0.1 internal units.

3. Subscription versus balance

  • Subscriptions generally provide lower effective pricing but include shorter usage windows.
  • A booster card can lift a short-window limit. When an active booster exists, it may be consumed before the main subscription allowance.
  • Subscription groups generally have better multipliers than balance groups.

Check current commercial terms

Prices, conversion ratios, multipliers, and plan limits can change. Confirm the purchase page and console before paying or estimating cost.

Step 2: Create an API key

An API key authenticates requests to FluxionAPI. Create the key type matching the billing method. A key's group determines its available models, upstream sources, and pricing.

API-key types

Key typeName markerBilling sourceIntended use
Balance keyName contains 余额 (balance)Account balanceUsage-based billing
Subscription keyName contains 订阅 (subscription)Subscription allowanceSubscription users

Create a key

  1. Sign in and open “API Keys.”
  2. Select “Create key.”
  3. Enter a name that identifies its purpose.
  4. Create the key, then copy and store it immediately.
  5. Create separate keys for different projects, clients, or model groups when useful.

Step 3: Configure a client

After creating a key, enter it in Claude Code, Codex, CC-Switch, or another compatible client.

3.1 Choose an AI client

AI tools typically fall into two categories: web chat and agent clients. Web chat usually focuses on conversation and web search. Agent clients can also use skills, MCP servers, tools, and multi-agent orchestration, so beginners who need those capabilities should learn an agent client directly.

Agent clients commonly come in two forms:

  1. CLI: tools such as Claude Code CLI provide core functionality in a terminal and can integrate with editors such as VS Code or PyCharm. They are best for users already comfortable with command-line workflows.
  2. Desktop: official or third-party desktop apps combine CLI capabilities with a graphical interface. Common options include Claude Code, Codex, and Cherry Studio. For a simpler start, use Codex with GPT and Claude Code with Claude models.

Using GPT through Claude Code is not recommended for beginners because Claude Code may apply additional limitations to non-Claude models.

Downloads:

Suggested combinations by task:

  1. Programming: Claude Code or Codex. Choose Claude Code with Claude for stronger complex reasoning, or Codex with GPT for value and broad completion.
  2. Documents and copywriting: Codex with GPT.
  3. Industry research and deep analysis: Claude Code with Claude.

These are recommendations based on model characteristics, not requirements. Choose according to your own workflow. After installing a client, replace its official upstream configuration with FluxionAPI. For beginners, the suggested flow is: upstream-compatible API → FluxionAPI → CC-Switch → client.

3.2 Connection parameters

ParameterDescriptionExample
API KeyThe key created in the consolesk-xxxxxxxxxxxxxxxx
Base URLRequest base address for the key's grouphttps://fluxionai.space
ModelExact model call name supported by the groupgpt-5.5, claude-opus-4-8

To identify a group's protocol, open “API Keys” in the console:

  • Yellow: Anthropic format
  • Green: OpenAI format
  • Blue: Gemini format
GroupBase URLComplete request URL
Anthropichttps://fluxionai.spacehttps://fluxionai.space/v1/messages
OpenAIhttps://fluxionai.space/v1https://fluxionai.space/v1/responses for Codex, or https://fluxionai.space/v1/chat/completions for Chat Completions

Use a complete endpoint only when the client does not append its own path.

3.3 Configure CC-Switch

CC-Switch manages providers for agent clients including Claude Code, Codex, Hermes, OpenCode, and OpenClaw. Download it from the CC-Switch repository.

3.3.1 Claude Code CLI / Desktop

1. Add a custom provider

Add a custom Claude Code provider in CC-Switch

2. Enter the configuration

For an Anthropic group, follow this configuration:

Configure an Anthropic group for Claude Code

For an OpenAI group, follow this configuration:

Configure an OpenAI group for Claude Code

Note: An OpenAI group requires local routing. For stability, enable both Full URL and local routing. When Full URL is enabled, use the complete request address from section 3.2.

Enable the CC-Switch local router

Enter a complete request URL in CC-Switch

After it is enabled, the local router can be toggled from the home page:

Toggle the local router from the CC-Switch home page

3. Save the provider and select “Use.”

3.3.2 Codex

1. Add a custom provider

Add a custom Codex provider in CC-Switch

2. Configure the OpenAI group

Configure the Codex OpenAI provider

Configure Codex model mapping

Note

  • To use an Anthropic-group key from Codex, set the request address to https://fluxionai.space/vip/v1.
  • Configure additional models through model mapping.

3.4 Use xAI / Grok

Grok uses the OpenAI-compatible API:

  • Base URL: https://fluxionai.space/v1
  • Endpoint: /v1/chat/completions
  • Model: a supported Grok call name such as grok-4.5

Use /v1/images/generations for image models such as grok-imagine.

2. Common questions

2.1 CC-Switch returns 502 Bad Gateway

Possible causes:

  1. A gateway problem between CC-Switch and the client.
  2. Platform maintenance; check the Help Center or official service status for notices.
  3. The current session exceeded its context limit.

Try these steps:

  1. Toggle local routing off and on.
  2. Restart the client.
  3. Start a new session.

2.2 CC-Switch returns model_not_found

Possible causes:

  1. The model name is incorrect.
  2. The API-key group does not support the model.
  3. A CC-Switch issue.

Try these steps:

  1. Copy the exact model name from Model Marketplace.
  2. Confirm that the group supports it; for example, do not request a Claude model from an OpenAI group.
  3. Toggle local routing off and on.
  4. Restart the client.
  5. Start a new session.

3. Get help

Thank you for using FluxionAPI.