Chat2API

中文文档

Multi-platform AI Service Unified Management Tool

Chat2API is a native desktop application that provides an OpenAI-compatible API for multiple AI service providers. It allows you to use any OpenAI-compatible client with DeepSeek, GLM, Kimi, MiniMax, Qwen, Z.ai and more across macOS, Windows, and Linux.

✨ Features

• OpenAI Compatible API: Provides standard OpenAI-compatible API endpoints for seamless integration
• 🔧 Function Calling Support: Full Function Calling capability via Prompt Engineering for all providers
• Multi-Provider Support: Connect DeepSeek, GLM, Kimi, MiniMax, Qwen, Z.ai and more
• Dashboard Monitoring: Real-time request traffic, token usage, and success rates
• API Key Management: Generate and manage keys for your local proxy
• Model Management: View and manage available models from all providers
• Request Logs: Detailed request logging for debugging and analysis
• Proxy Configuration: Flexible proxy settings and routing strategies
• System Tray Integration: Quick access to status from menu bar
• Multilingual: English and Simplified Chinese support
• Modern UI: Clean, responsive interface with dark/light theme support

🔧 Function Calling

Chat2API implements full Function Calling capability through Prompt Engineering and Stream Parsing, enabling tool use for all supported models without relying on native Function Calling APIs.

How It Works

1. Protocol Definition: Design a text protocol that models can easily understand and parse

   [function_calls]
   [call:tool_name]{"argument": "value"}[/call]
   [/function_calls]
   

2. Prompt Injection: Convert OpenAI-format tools definitions into System Prompt

3. Output Interception: Real-time interception of protocol text during streaming

4. Format Restoration: Extract protocol content and wrap as OpenAI-format tool_calls

Usage

from openai import OpenAI

client = OpenAI(
    api_key="your-api-key",
    base_url="http://localhost:8080/v1"
)

# Define tools
tools = [{
    "type": "function",
    "function": {
        "name": "get_weather",
        "description": "Get current weather",
        "parameters": {
            "type": "object",
            "properties": {
                "location": {"type": "string", "description": "City name"}
            },
            "required": ["location"]
        }
    }
}]

# Call model
response = client.chat.completions.create(
    model="deepseek-chat",
    messages=[{"role": "user", "content": "What's the weather in Beijing?"}],
    tools=tools
)

# Handle tool calls
if response.choices[0].message.tool_calls:
    for tool_call in response.choices[0].message.tool_calls:
        print(f"Tool: {tool_call.function.name}")
        print(f"Args: {tool_call.function.arguments}")

🤖 Supported Providers

Provider	Auth Type	OAuth	Models
DeepSeek	User Token	Yes	DeepSeek-V3.2
GLM	Refresh Token	Yes	GLM-5
Kimi	JWT Token	Yes	kimi-k2.5
MiniMax	JWT Token	Yes	MiniMax-M2.5
Qwen (CN)	SSO Ticket	Yes	Qwen3.5-Plus, Qwen3-Max, Qwen3-Flash, Qwen3-Coder, qwen-max-latest
Qwen AI (Global)	JWT Token	Yes	Qwen3.5-Plus, Qwen3-Max, Qwen3-VL-Plus, Qwen3-Coder-Plus, Qwen-Plus, Qwen-Turbo
Z.ai	JWT Token	Yes	GLM-5, GLM-4.7, GLM-4.6V, GLM-4.6

📥 Installation

Download

Download the latest release from GitHub Releases:

Platform	Download
macOS (Apple Silicon)	Chat2API-x.x.x-arm64.dmg
macOS (Intel)	Chat2API-x.x.x-x64.dmg
Windows	Chat2API-x.x.x-x64-setup.exe
Linux	Chat2API-x.x.x-x64.AppImage or .deb

Build from Source

Requirements:

• Node.js 18+
• npm
• Git

# Clone the repository
git clone https://github.com/xiaoY233/Chat2API.git
cd Chat2API

# Install dependencies
npm install

# Start development server
npx electron-vite dev 2>&1

Build for Production

npm run build              # Build the application
npm run build:mac          # Build for macOS (dmg, zip)
npm run build:win          # Build for Windows (nsis)
npm run build:linux        # Build for Linux (AppImage, deb)
npm run build:all          # Build for all platforms

📖 Usage

1. Start the Application

Launch Chat2API and configure your preferred settings.

2. Add Providers

Go to Providers tab → Add a provider → Enter API key or authenticate via OAuth.

3. Configure Proxy

Go to Proxy Settings tab → Configure port and routing strategy → Start the proxy server.

4. Manage API Keys

Go to API Keys tab → Generate keys for accessing your local proxy.

5. Monitor Usage

• Dashboard: Overall health and traffic statistics
• Models: View available models from all providers
• Logs: Request logs for debugging

📸 Screenshots

Dashboard	Providers

Proxy Settings	API Keys

Models	Logs

Settings	About

⚙️ Settings

• Port: Change the proxy listening port (default: 8080)
• Routing Strategy: Round Robin or Fill First
• Auto-start: Launch proxy automatically on app startup
• Theme: Light, Dark, or System preference
• Language: English or Simplified Chinese

🏗️ Architecture

Chat2API/
├── src/
│   ├── main/                    # Electron main process
│   │   ├── index.ts            # App entry point
│   │   ├── tray.ts             # System tray integration
│   │   ├── proxy/              # Proxy server management
│   │   ├── ipc/                # IPC handlers
│   │   └── utils/              # Utilities
│   ├── preload/                # Context bridge
│   └── renderer/               # React frontend
│       ├── components/         # UI components
│       ├── pages/              # Page components
│       ├── stores/             # Zustand state
│       └── hooks/              # Custom hooks
├── build/                      # Build resources
└── scripts/                    # Build scripts

🔧 Tech Stack

Component	Technology
Framework	Electron 33+
Frontend	React 18 + TypeScript
Styling	Tailwind CSS
State	Zustand
Build	Vite + electron-vite
Packaging	electron-builder
Server	Koa

📁 Data Storage

Application data is stored in ~/.chat2api/ directory:

• config.json - Application configuration
• providers.json - Provider settings
• accounts.json - Account credentials (encrypted)
• logs/ - Request logs

❓ FAQ

macOS: "App is damaged and can't be opened"

Due to macOS security mechanisms, apps downloaded outside the App Store may trigger this warning. Run the following command to fix it:

sudo xattr -rd com.apple.quarantine "/Applications/Chat2API.app"

How to update?

Check for updates in the About page, or download the latest version from GitHub Releases.

🤝 Contributing

1. Fork the project
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit changes (git commit -m 'Add amazing feature')
4. Push to branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

GNU General Public License v3.0. See LICENSE for details.

This means:

• ✅ Free to use, modify, and distribute
• ✅ Derivative works must be open-sourced under the same license
• ✅ Must preserve original copyright notices

🙏 Acknowledgments

• Electron - Cross-platform framework
• React - UI framework
• TypeScript - Type-safe JavaScript
• Tailwind CSS - CSS framework
• Zustand - State management
• Koa - HTTP server