on main help sign in
docs(readme): add note section about `openai` vs. `openai-compat`
commit85c57a4148d441edb448efd34c0e194cd33c02fe authorAndrey Nering <andreynering@users.noreply.github.com> dateMon 27 Oct 2025, 11:40 (1 year ago) parent042725f
1 file changed+6
README.md+6
README.md+6
@@ -408,6 +408,12 @@ Local models can also be configured via OpenAI-compatible API. Here are two comm
408408Crush supports custom provider configurations for both OpenAI-compatible and
409409Anthropic-compatible APIs.
410410
411+> [!NOTE]
412+> Note that we support two "types" for OpenAI. Make sure to choose the right one
413+> to ensure the best experience!
414+> * `openai` should be used when proxying or routing requests through OpenAI.
415+> * `openai-compat` should be used when using non-OpenAI providers that have OpenAI-compatible APIs.
416+
411417#### OpenAI-Compatible APIs
412418
413419Here’s an example configuration for Deepseek, which uses an OpenAI-compatible