diff --git a/README.md b/README.md index f0b05a300ef5ce9685bd5086d14205d342df18d3..0b82aff4cc2e87ca181d8dfe1b11966cf658644b 100644 --- a/README.md +++ b/README.md @@ -408,6 +408,12 @@ Local models can also be configured via OpenAI-compatible API. Here are two comm Crush supports custom provider configurations for both OpenAI-compatible and Anthropic-compatible APIs. +> [!NOTE] +> Note that we support two "types" for OpenAI. Make sure to choose the right one +> to ensure the best experience! +> * `openai` should be used when proxying or routing requests through OpenAI. +> * `openai-compat` should be used when using non-OpenAI providers that have OpenAI-compatible APIs. + #### OpenAI-Compatible APIs Here’s an example configuration for Deepseek, which uses an OpenAI-compatible