Skip to content

Commit 39740dc

Browse files
author
whrho
committed
docs: add supported providers section with usage examples for DeepSeek-like, Mistral, xAI, Xiaomi
1 parent 0750692 commit 39740dc

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,46 @@ So you can use local or multi-account CLI access with OpenAI(include Responses)/
4343
- OpenAI-compatible upstream providers via config (e.g., OpenRouter)
4444
- Reusable Go SDK for embedding the proxy (see `docs/sdk-usage.md`)
4545

46+
## Supported Providers
47+
48+
This fork includes provider-specific fixes and enhancements for the following backends.
49+
50+
### Standard `openai-compatibility` providers (DeepSeek-like, Mistral, Xiaomi)
51+
52+
The following providers are configured via the standard `openai-compatibility` section in `config.yaml`. No special configuration is needed beyond the standard API key and base URL setup:
53+
54+
- **DeepSeek-like** — Any provider with base URL `api.deepseek.com` / `nano-gpt.com`, or model name starting with `deepseek`. The proxy automatically strips unsupported fields (`interleaved`, `tools[].function.parameters.$schema`, etc.).
55+
- **Mistral** — Set `provider: mistral.ai` in your `openai-compatibility` entry. Empty assistant messages are filtered automatically to prevent 400 errors. `thinking` and `reasoning_effort` fields are stripped as Mistral does not support them.
56+
- **Xiaomi** — Set `provider: xiaomi` (or any name starting with `xiaomi`) in your `openai-compatibility` entry. Reasoning replay is backfilled automatically.
57+
58+
**Example config for DeepSeek:**
59+
60+
openai-compatibility:
61+
- name: deepseek
62+
api-url: https://api.deepseek.com/v1/chat/completions
63+
api-key: sk-xxxxx
64+
models:
65+
- name: deepseek-chat
66+
67+
### xAI (Grok)
68+
69+
xAI uses a **dedicated executor** (`XAIExecutor`), not the `openai-compatibility` path. Configure it via `xai-key` in `config.yaml` or use OAuth login (`xai-login` flag). Supports Grok Responses API, image generation, video creation, and automatic tool normalization (200-tool cap).
70+
71+
**Example config for xAI:**
72+
73+
xai-key:
74+
- api-key: xai-xxxxx
75+
models:
76+
- name: grok-3
77+
- name: grok-3-mini
78+
79+
### Generic usage flow
80+
81+
All providers expose the standard OpenAI-compatible `/v1/chat/completions`, `/v1/chat/completions` (streaming), and `/v1/images/generations` endpoints. Point your client to:
82+
83+
http://localhost:8317/v1/chat/completions
84+
Authorization: Bearer <your-api-key>
85+
4686
## Getting Started
4787

4888
CLIProxyAPI Guides: [https://help.router-for.me/](https://help.router-for.me/)

0 commit comments

Comments
 (0)