Glossary
Product and deployment
| Term | Description |
|---|---|
| XSI | A source-available, commercially licensed, high-performance AI API router; this project |
| Data plane / control plane | Model-calling endpoints / account, key, configuration, and pricing management endpoints; both share the same HTTP entry point |
| Configuration console (Admin) | Console for tenant owners: upstream keys, routing, pricing, and notifications |
| Account console (Manage) | Console for all accounts: usage, billing, sub-accounts, credit, and keys |
| Single-tenant / multi-tenant | SINGLE_TENANT decides whether self-registered accounts join the root tenant or each become an independent tenant |
| Single instance / multiple instances | SINGLE_MODE decides whether counters and notifications stay in process or are shared across instances through Redis |
Accounts
| Term | Description |
|---|---|
| XSI API key | An account's calling credential, starting with sk-Xvs, 51 characters in total |
| Public key | An account's public identifier starting with pk-Xvs, used for referral signups |
| root | Platform super administrator, with DNA . |
| Tenant owner | An account with ID == OID, which owns a dedicated key pool, configuration, and pricing |
| Manager | An account that meets the manager criteria and can manage its descendants |
| Sub-account / descendants | Direct children / accounts below at any depth |
| DNA | An account's path of ancestor IDs, such as .1.5., used to determine lineage and filter branches |
| Role | Billing tier: 0 and 1 skip quota and rate limit checks; 2 is strict; 3 is subscription |
| Gear | Routing mode: greater than 0 follows the tenant's Level mapping; 0 or less uses the account's own mapping and allows cross-group retries |
| Tier | Level computed from cumulative top-ups (0β10), used for filtering |
Billing
| Term | Description |
|---|---|
| Credit | Account balance in CNY, made up of multiple credits, each with its own expiry |
| Model Rates | Conversion and markup factor in the price table; defaults to 7 for models priced in USD |
| Account Rates | An account's price multiplier; a sub-account's is not lower than its parent's |
| Factor | Price coefficient set on an account by the tenant owner |
| XAPI_FEE | Fixed fee for non-model operations (default Β₯0.012), shown on the bill as model XAPI |
| Pay-as-you-go / subscription credit | The two fund types of credit; subscription credit is marked [SUB] |
| Suspended | Calls are paused once the balance falls below the threshold and resume automatically after a top-up |
Routing
| Term | Description |
|---|---|
| Provider key | An API key the tenant holds with an upstream provider, stored encrypted |
| Provider | The upstream base URL of a provider key, such as https://api.openai.com |
| Level | Key pool group number |
| Key pool | The set of keys for the same tenant and Level, used in round robin |
| Model mapping (MODEL_MAPPER) | Rewrites the requested model to an upstream model |
| Level mapping (LEVEL_MAPPER) | Routes an upstream model to a Level |
| Fuzzy matching | An unpriced model name is matched to the closest-version priced model in the same family |
| Sticky session | The same session always uses the same key, improving cache hit rates |
| Sleep | A key temporarily leaves rotation after a retryable error and returns automatically when the period expires |
| Group switchover (SWITCH_OVER) | When a model keeps failing, it is temporarily switched to a backup Level |
| Model failover (MODEL_FAILOVER) | When a model keeps failing, it is temporarily replaced with a backup model |
Access control
| Term | Description |
|---|---|
| AllowIPs | IP and CIDR allowlist |
| Resources | Endpoint path allowlist, matched by prefix |
| AllowModels | Model allowlist, supports wildcards |
| AllowLevels | Set of Levels allowed for cross-group retries |
| ModelLimits / MODEL_LIMITS | Account-level / tenant-level model rate limits |