consolex2api

ConsoleX2API is a Python gateway that wraps xAI's console.x.ai platform so it behaves like an OpenAI-compatible API. Many AI tools, scripts, and applications are built to talk to OpenAI's API format. This project lets those same tools connect to Grok models through the console.x.ai backend without changing the tool itself.

The gateway accepts standard API requests in the OpenAI format for chat completions, responses, and real-time voice, then translates and forwards them to console.x.ai upstream. It preserves parameters like tool use and reasoning effort that the upstream supports. Image inputs in the OpenAI format are automatically converted to the format the upstream expects. Real-time voice is supported through a WebSocket connection that passes audio data in both directions.

A key feature is the multi-account pool. console.x.ai uses SSO login sessions, and each account belongs to a team. This gateway stores multiple accounts in a local SQLite database, each with its own team ID, so traffic can be spread across them. You import accounts through a browser-based admin dashboard or a text file, one account per line with its SSO token and team ID. The dashboard also lets you enable or disable individual accounts, filter by account status, and configure settings like proxy address, model list, and default generation parameters.

Deployment options include running it directly with Python or using Docker Compose, which handles the SQLite database as a persistent volume. Configuration is done through an environment file where you set your gateway API key, admin key, and upstream proxy if needed.

The project is written in Chinese and the README is in Chinese, though an English README is also linked from the project. It does not support image or video generation endpoints, only the chat and voice interfaces.