Documentation

TopxAI documentation: how to connect, what each route costs, how credit is added and what to do when a request fails.

Getting started

• What TopxAI is · One base URL, fourteen models on seven lines, prepaid USD credit, and nothing you send is stored.
• Create an API key and choose a route · The key drawer step by step, what each route means, and the three 403 refusals a key can hit.
• Connect your SDK · The base URL, every endpoint with its auth header, working examples for the OpenAI and Anthropic SDKs, and what each error status means.
• API reference: every endpoint, with an OpenAPI specification · Every endpoint TopxAI serves, what each accepts and returns, the two ways to send the key, and the OpenAPI 3.1 file at /openapi.json for API tools.

Integrations

• Claude Code with TopxAI: ANTHROPIC_BASE_URL and the key · Point Claude Code at https://ai.topxea.com with two environment variables and pick claude-sonnet-5-5, claude-opus-5-5 or claude-fable-5-1 as its model.
• Codex CLI custom model provider: model_providers in config.toml for TopxAI · Point Codex CLI at TopxAI with a [model_providers.topxai] table in ~/.codex/config.toml and run gpt-6.1-sol, gpt-6-astra or grok-4.7. An npm mirror is included.
• Cursor with TopxAI: override the OpenAI base URL · In Cursor, paste a TopxAI key as the OpenAI key, turn on the base URL override with https://ai.topxea.com/v1 and add the model ids you want to chat with.
• Cline and Roo Code with TopxAI: the OpenAI-compatible provider · Set the provider to OpenAI Compatible with base URL https://ai.topxea.com/v1, a TopxAI key and a model id; or the Anthropic provider with a custom base URL.
• Continue with TopxAI: models in config.yaml · Add TopxAI models to ~/.continue/config.yaml with provider openai or anthropic and apiBase, then use them for chat, edit and agent mode in VS Code or JetBrains.
• Zed with TopxAI: OpenAI- and Anthropic-compatible providers · Add TopxAI to Zed as an openai_compatible provider for GPT, Grok, Kimi and GLM, and as an anthropic_compatible provider for Claude, in settings.json.
• Aider with TopxAI: OPENAI_API_BASE and the model name · Run aider against TopxAI with OPENAI_API_BASE=https://ai.topxea.com/v1 and --model openai/claude-sonnet-5-5, or the Anthropic variables for the Claude line.
• opencode with TopxAI: a custom provider in opencode.json · Declare TopxAI in opencode.json with @ai-sdk/openai-compatible, the base URL and the model ids, then pick them with /models.
• Open WebUI with TopxAI: one OpenAI connection, every model · Add https://ai.topxea.com/v1 as an OpenAI API connection in Open WebUI; the model list fills from /v1/models and every text model is ready to chat.
• LobeChat with TopxAI: the OpenAI proxy address · Set OpenAI’s API proxy address to https://ai.topxea.com/v1 in LobeChat, or OPENAI_PROXY_URL for a deployment, and fetch the model list.
• Cherry Studio with TopxAI: first chat and endpoint setup · Connect a route-scoped TopxAI key to Cherry Studio, choose the right endpoint, and diagnose the first request without guessing URL suffixes.
• ChatBox with TopxAI: a custom provider · In ChatBox, add a custom provider in OpenAI API compatible mode with host https://ai.topxea.com and path /v1/chat/completions, then add the model ids.
• LangChain with TopxAI: ChatOpenAI and ChatAnthropic with a base URL · Use TopxAI from LangChain (Python and JavaScript) by passing base_url to ChatOpenAI for every text model, or to ChatAnthropic for Claude with prompt caching.
• Vercel AI SDK with TopxAI: createOpenAI, createAnthropic and openai-compatible · Create an AI SDK provider with baseURL https://ai.topxea.com/v1 and a TopxAI key, then use generateText or streamText with any catalogue model.
• LiteLLM with TopxAI: proxy config and the Python SDK · Route LiteLLM to TopxAI with model openai/<id> and api_base https://ai.topxea.com/v1, in the proxy’s model_list or a completion() call.
• Dify with TopxAI: the OpenAI-API-compatible provider · Add each TopxAI model to Dify through the OpenAI-API-compatible provider with endpoint https://ai.topxea.com/v1, your key and the model id.
• n8n with TopxAI: an OpenAI credential with a base URL · Create an OpenAI credential in n8n with base URL https://ai.topxea.com/v1 and a TopxAI key, then use any catalogue model in the Chat Model and AI Agent nodes.
• llm CLI with TopxAI: extra-openai-models.yaml · Register TopxAI models in llm’s extra-openai-models.yaml with api_base https://ai.topxea.com/v1, store the key with llm keys set, and prompt from the shell.

Routes and pricing

• Shared pool, official line and auto route · Same models, different routing and price: what each API-key route means and how Auto route picks one for you.
• How requests are billed · Billing units, long-context tiers, the up-front reservation and what happens to it when a request fails.
• Reading your usage log · What each row of the usage log shows, how to filter it, and what is never recorded.

Models

• Jev (TypeSafe System One) · What Jev returns, how to call POST /v1/systemone, the one-line setup under a TypeSafe official-line key, and what it costs.
• GLM-5.3-Abliterated · A fine-tuned GLM 5.3 on a private deployment: text only, 1M-token context, three reasoning modes, priced above list, and covered by a compliance notice.
• Image generation · gpt-image-2.5-sunburst and -flare: the two endpoints, the 1K and 2K per-image prices, how the size tier is chosen, and where the image link comes from.
• Video generation · grok-imagine-video-1.5: submit a job, poll it, per-second prices by resolution, refunds on failure, and how forgotten jobs are refunded after 24 hours.

Payments and credit

• Top up with a card · Add USD credit with a card, Apple Pay, Google Pay or a local e-wallet; the checkout runs on topxea.com through Waffo.
• Pay with crypto · Top up with USDT or USDC through a NOWPayments invoice: what to send, how long confirmation takes, and what happens if you send too little.
• Gift cards and credit codes · Buy a single-use credit code, redeem one on any account, and what the User Agreement says about refunds.

Troubleshooting

• Common error responses · What each HTTP status and error code from the gateway means, and what to change before you retry.
• The model works in curl but not in my tool · Seven places where a tool differs from the working curl: base URL, auth header, model id, key route and limits, IP whitelist, GLM and Jev endpoints, timeouts.
• Sign-in and account · How sign-in is shared with topxea.com, how sessions, devices and TopxAI Desktop sign-ins work, the regional service notice, and how to reach support.

Comparisons

• TopxAI vs OpenRouter: what is the same and what differs · Compare current model and route prices: TopxAI shared routes cost 37.5% to 50% less than OpenRouter standard routes, and Kimi hosts can cost less.
• TopxAI vs the providers' own APIs: price, retention and what stays direct · What changes when Claude, GPT, Grok or Kimi go through TopxAI: the price per token, one key and one balance, zero retention, and what stays with the provider.
• TopxAI vs Vercel AI Gateway: list price with no markup, or half of it · Vercel AI Gateway charges the provider list price with no markup; TopxAI shared routes charge 50% of it for Claude, GPT and Grok. What else differs.

Privacy and policies

• What TopxAI stores and what it never stores · Request and response content passes through memory only; here is what the usage log, account and payment records keep, and for how long.
• Acceptable use and abuse reports · The six prohibited content categories, how enforcement works, why GLM's private deployment is no exception, and how to report abuse.

TopxAI · Models & pricing · Blog

Other languages: 简体中文