MAX APIMAX API
User GuideInstallationAPI ReferenceAI ApplicationsHelp & SupportBusiness Cooperation
Admin Guide

Group Management

Groups isolate channel access permissions and billing multipliers for different users

Groups isolate channel access permissions and billing multipliers for different users. Users in different groups can only access channels assigned to their group. Log in with an admin account and find the "Groups" entry in System Settings or the admin panel.

The group list shows all configured real groups. Users, API Key routes, and channels reference these groups. Automatic routes combine several real groups into a reusable ordered chain.

How Groups Are Used

  • User group: Assign a group to a user when editing them in User Management
  • API Key route: Select an automatic route or configure up to 8 ordered manual groups when creating or editing an API Key
  • Channel group: Enter the allowed group name(s) in the "Group" field when adding a channel

Automatic Route Chains

Open System Settings -> Billing -> Group Pricing, or visit /system-settings/billing/group-pricing. Under Auto route chains, create named routes such as auto, auto:fast, or auto:cheap:

  1. The route key must use the automatic-route format, and the route may contain only real billing groups.
  2. Put groups in the order requests should try them. The API Key editor displays this chain.
  3. Enabled controls whether the route can be used at runtime. The default route must remain enabled.
  4. User selectable controls whether the route appears for new API Key selections. When disabled, API Keys that already saved the route can still display and preserve it, but users cannot select it again.
  5. Any enabled route can become the default. New API Keys use the default route with cross-group retry enabled.

The auto_routes field from GET /api/group contains only the routes currently selectable by that user and their group order. At runtime, automatic and manual routes become the same ordered group plan. Each API Key's Cross-group retry switch decides whether a failure advances to the next group.

Mark a route non-selectable when you need to stop new use while preserving existing API Keys. Disabling or deleting a route that is still in use can make requests fail. Review existing tokens and test model listing, affinity, and cross-group retry before making that change.

How is this guide?