# Quickstart

Flux is a unified interface for large language models: call mainstream models across various clients through a unified API key.

::: details For AGENTS
For bulk Markdown reads, use [markdown-sitemap.xml](https://docs.tryflux.net/markdown-sitemap.xml). For a single page, append `.md` to any documentation URL that does not end with `/`, for example `/en/docs/quickstart.md`.
:::

## Getting Started

1. Choose a client below. In the [model marketplace](https://tryflux.net/models), confirm that the target model's group supports the required protocol and client.
2. Read [Billing](https://docs.tryflux.net/en/docs/flux/billing.md), check prices, then [top up your balance](https://tryflux.net/purchase).
3. [Create an API key](https://docs.tryflux.net/en/docs/flux/create-apikey.md) on the group you selected.
4. Follow the client guide below to enter the key, endpoint, and model ID.
5. Send a message and check the reply and usage log to [confirm the integration](#confirm-the-integration).

For groups, account pools, balance-based billing, and other terms, see [Core Concepts](https://docs.tryflux.net/en/docs/concepts.md).

## Client Options

<DocsTabs default-tab="agent">
  <DocsTab title="Agent" name="agent">

Best for terminal workflows, programming tasks, or users who want AI Agent assistance while developing.

Follow the guide for your client. [CC-Switch](https://docs.tryflux.net/en/docs/agents/cc-switch.md) is an optional way to manage provider settings for clients such as Claude Code and Codex; it is not a prerequisite.

| Client guide                               | Best for                                        |
| ------------------------------------------ | ----------------------------------------------- |
| [Claude Code](https://docs.tryflux.net/en/docs/agents/claude-code.md) | Anthropic's official CLI, terminal coding       |
| [Codex](https://docs.tryflux.net/en/docs/agents/codex.md)             | OpenAI's official CLI and desktop app           |
| [Codex++](https://docs.tryflux.net/en/docs/agents/codex-plus-plus.md) | Adds extra capabilities on top of Codex         |
| [OpenCode](https://docs.tryflux.net/en/docs/agents/opencode.md)       | Open-source terminal agent with model switching |
| [Pi](https://docs.tryflux.net/en/docs/agents/pi.md)                   | Extensible terminal coding agent                |
| [Hermes](https://docs.tryflux.net/en/docs/agents/hermes.md)           | Lightweight terminal agent                      |

  </DocsTab>

  <DocsTab title="ChatBot" name="chatbot">

Best for users who prefer graphical interfaces, mobile usage, or daily conversational workflows.

| Client guide                                    | Best for                                                 |
| ----------------------------------------------- | -------------------------------------------------------- |
| [Cherry Studio](https://docs.tryflux.net/en/docs/chatbot/cherry-studio.md) | Desktop (Windows / macOS / Linux), multi-model switching |
| [RikkaHub](https://docs.tryflux.net/en/docs/chatbot/rikkahub.md)           | Android, OpenAI compatible                               |

Add Flux as a custom provider in the client settings, enter your API key and an [API endpoint](https://docs.tryflux.net/en/docs/flux/endpoints.md), fetch the model list, and start chatting.

  </DocsTab>
</DocsTabs>

## Confirm the Integration

1. Select the target model in your client, start a new conversation, and send "Reply with OK only". This incurs model call charges.
2. Confirm that you receive model-generated text, not just a model list or a "configuration saved" message.
3. Find the request in the [usage logs](https://tryflux.net/usage), check the key, model, and charge, and confirm the group matches your key configuration.

This only confirms that this text conversation worked. Test tool calls, images, or other capabilities separately if needed. If there is no reply or the usage record differs from your expectations, see [Troubleshooting](https://docs.tryflux.net/en/docs/troubleshooting.md).

## Going Further

After integration, the following may be useful:

- [Creative Studio](https://tryflux.net/creative) - generate images directly on the web without client or API configuration
- [Composite Key](https://docs.tryflux.net/en/docs/flux/composite-key.md) - bind one key to several groups and switch with prefixes
- [Fast Mode](https://docs.tryflux.net/en/docs/flux/fast-mode.md) - force the high-priority tier at the key level
- [Team](https://docs.tryflux.net/en/docs/flux/team.md) - share the owner's balance while everyone keeps their own keys
- [Referral Rewards](https://docs.tryflux.net/en/docs/flux/referral.md) - earn rebate rewards by inviting friends

## Troubleshooting

- [Troubleshooting](https://docs.tryflux.net/en/docs/troubleshooting.md) - find the problem by symptom, with a report template
- [Error Codes](https://docs.tryflux.net/en/docs/errors.md) - the full error reference
- [FAQ](https://docs.tryflux.net/en/docs/faq.md) - model detection and other common questions
- [API Endpoints](https://docs.tryflux.net/en/docs/flux/endpoints.md) - choosing an endpoint and migrating from deprecated routes
- [Usage Policy](https://docs.tryflux.net/en/docs/tos/usage-policy.md) - what gets accounts banned