Quick Start

From sign-up to your first API call in about 5 minutes.

1. Sign Up or Log In

1. Visit https://brivionix.com
2. Click Sign in / Sign up in the top right
3. Choose a login method:
   • Email + password (email verification required)
   • GitHub OAuth
   • Google OAuth
4. After login, you'll enter the Console

TIP

You must agree to the User Agreement and Privacy Policy before logging in.

2. Top Up Credits

Go to Wallet Management in the sidebar:

• Supports Stripe payments
• Minimum top-up: 10 Credits
• Volume discounts: 30 → 3% off, 50 → 5% off, 100 → 8% off, 200 → 12% off, 500 → 15% off

Official rate:

0.85 RMB = 1 API Credit

Stripe Payment Note

Stripe requires integer cents. 0.85 RMB ≈ $0.116 USD is rounded to $0.12 USD. For example, 10 Credits costs $1.20 USD (~8.70 RMB). This difference is due to Stripe's billing rules, not a platform markup.

3. Create an API Key

Go to Token Management in the sidebar, click Create token.

Configurable options: name, group, allowed models, IP restrictions, expiration, quota limit.

Security

Your full API Key can be viewed anytime from the Token Management list. Never put it in frontend code, public repos, or screenshots. If you suspect a leak, disable the token immediately and create a new one.

4. Fastest Path: Use a GUI Client

For the quickest setup without coding, use the built-in Deep Link buttons in Token Management:

Client	Type	Use Case
Cherry Studio	Desktop	General chat + multi-provider
OpenCat	Desktop / Mobile	macOS / iOS experience
AionUI	Desktop	Multi-modal conversations
CC Switch	Desktop	Quick provider switching
AI as Workspace	Web	Chat in browser

See Third-Party Clients for more details.

5. Make Your First API Call

curl:

curl https://brivionix.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-api-key" \
  -d '{
    "model": "gpt-5.4-mini",
    "messages": [
      {"role": "user", "content": "Hello! How does Brivionix work?"}
    ]
  }'

Python (OpenAI SDK):

from openai import OpenAI

client = OpenAI(
    api_key="sk-your-api-key",
    base_url="https://brivionix.com/v1",
)

response = client.chat.completions.create(
    model="gpt-5.4-mini",
    messages=[
        {"role": "user", "content": "Hello!"}
    ],
)

print(response.choices[0].message.content)

Node.js (OpenAI SDK):

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "sk-your-api-key",
  baseURL: "https://brivionix.com/v1",
});

const response = await client.chat.completions.create({
  model: "gpt-5.4-mini",
  messages: [{ role: "user", content: "Hello!" }],
});

console.log(response.choices[0].message.content);

6. Verify in Playground

The Console's Playground lets you test models interactively with temperature, top_p, max_tokens, streaming, image input, and more.

7. Check Logs

Go to Usage Logs to see every API call's details: time, tokens, model, latency, input/output, cost, and IP.