π—π€πˆ π—π€ππˆ

Terminology

This page summarizes key terms used across the docs for consistent understanding.

Core Concepts

  • BYOK (Bring Your Own Key): A model where users manage their own upstream AI provider API Keys. The system acts only as a secure proxy and does not provide paid key pools.
  • Provider Key / Upstream Key (δΈŠζΈΈε―†ι’₯): The original API Key obtained by users from official platforms like OpenAI, Anthropic, DeepSeek, etc., which is added to the XAI system and stored encrypted.
  • XAI API Key / Virtual Key (θ™šζ‹Ÿε―†ι’₯): The exclusive key assigned by the XAI system to users (format: sk-Xvs...), used to call the XAI unified API endpoint.
  • Zero Markup Pricing: API call charges are deducted directly from the user's official account, with XAI charging no markup or service fees.
  • End-to-End Encryption: Provider Keys are encrypted using user-specific keys via the ChaCha20-Poly1305 algorithm, with no super-admin access in the system.

Account System

  • Owner (主账户): Top-level account that manages descendants and keys.
  • Descendants (εŽδ»£η”¨ζˆ·): Any users in the owner's subtree; see "User Hierarchy".
  • DNA: Lineage path (e.g., .1.42.) used to filter user groups.
  • Gear (摣位): User attribute that impacts routing/drift strategies.
  • Tier (层级): User attribute for pricing/permissions.

Routing & Key Management

  • Level (η­‰ηΊ§): Abstraction for key pools and model routing. Users can assign different Provider Keys to different Levels.
  • Key Pool (ε―†ι’₯ζ± ): A collection of multiple Provider Keys under the same Level, automatically rotated by the system to distribute request pressure.
  • Model Mapper (ζ¨‘εž‹ζ˜ ε°„): Aliasing models to targets (e.g., gpt-4=gpt-4-turbo), configurable at user-level or owner-level.
  • Level Mapper (Level ζ˜ ε°„): Map model patterns to a Level (e.g., claude*=2), routing to the corresponding key pool.
  • Sleep (δΌ‘ηœ ): After errors (e.g., 429, 5xx), the key is temporarily removed from rotation and rejoins after a waiting period.
  • Switch Over (ζ•…ιšœεˆ‡ζ’): Move from one Level to another when the current Level is unavailable.

Security & Permissions

  • Resources (衄源白名单): Allowed API paths (e.g., /v1/chat/completions).
  • AllowModels (ζ¨‘εž‹η™½εε•): List of models a sub-account is allowed to call.
  • AllowIPs (IP 白名单): IP addresses or CIDR ranges allowed to call the API.
  • Encryption Key (εŠ ε―†ε―†ι’₯): Each user's unique 32-character key used to encrypt that user's Provider Keys.

Billing & Rate Limiting

  • Factor (因子): Coefficient used in pricing.
  • Rates (θ΄ΉηŽ‡ε€ηŽ‡): Multiplier applied to model pricing.
  • Model Limits (ζ¨‘εž‹ι™ι€Ÿ): Per-model limits (RPM/RPH/RPD, TPM/TPH/TPD).
  • RPM/RPH/RPD: Requests per minute/hour/day.
  • TPM/TPH/TPD: Tokens per minute/hour/day.
  • Credit Balance (俑用钝度): User's prepaid card balance, used for internal billing statistics (independent of upstream official billing).

See also:

← Supported Providers
Proxy Interface β†’