Skip to content

Document OpenAI compatible API provider usage #2777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
giraypultar wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −0
Open

Document OpenAI compatible API provider usage #2777

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/docs/waveai-modes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,33 @@ For newer models like GPT-4.1 or GPT-5, the API type is automatically determined
}
```

### OpenAI Compatible

To use an OpenAPI compatible API provider, you need to provide the ai:endpoint, ai:apitoken, ai:model parameters,
and use "openai-chat" as the ai:mode.
Comment on lines +202 to +203
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Fix incorrect field name and provider terminology.

The config key should be ai:apitype, not ai:mode, and this section should say “OpenAI‑compatible,” not “OpenAPI compatible,” to match the rest of the doc and avoid broken configs.

✅ Proposed wording fix 
-To use an OpenAPI compatible API provider, you need to provide the ai:endpoint, ai:apitoken, ai:model parameters,
-and use "openai-chat"  as the ai:mode.
+To use an OpenAI-compatible API provider, you need to provide the ai:endpoint, ai:apitoken, ai:model parameters,
+and set "openai-chat" as the ai:apitype.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
To use an OpenAPI compatible API provider, you need to provide the ai:endpoint, ai:apitoken, ai:model parameters,
and use "openai-chat" as the ai:mode.
To use an OpenAI-compatible API provider, you need to provide the ai:endpoint, ai:apitoken, ai:model parameters,
and set "openai-chat" as the ai:apitype.
🧰 Tools
🪛 LanguageTool

[grammar] ~202-~202: Use a hyphen to join words.
Context: ...### OpenAI Compatible To use an OpenAPI compatible API provider, you need to pro...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
In `@docs/docs/waveai-modes.mdx` around lines 202 - 203, Update the documentation
line to use the correct provider wording and config key: change "OpenAPI
compatible API provider" to "OpenAI‑compatible API provider" and replace the
config key reference from "ai:mode" to "ai:apitype" (so the sentence reads that
you must provide ai:endpoint, ai:apitoken, ai:model and set ai:apitype to
"openai-chat"); adjust any nearby occurrences of "OpenAPI" and "ai:mode" to the
corrected terms to keep the doc consistent.


:::note
The ai:endpoint is *NOT* a baseurl. The endpoint should contain the full endpoint, not just the baseurl.
For example: https://api.x.ai/v1/chat/completions

If you provide only the baseurl, you are likely to get a 404 message.
Comment on lines +206 to +209
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Tighten wording: use “base URL.”

“baseurl” is a spelling/formatting issue in docs; use “base URL” for clarity and consistency.

✍️ Suggested edit 
-The ai:endpoint is *NOT* a baseurl. The endpoint should contain the full endpoint, not just the baseurl.
+The ai:endpoint is *NOT* a base URL. The endpoint should contain the full endpoint URL, not just the base URL.
🧰 Tools
🪛 LanguageTool

[grammar] ~206-~206: Ensure spelling is correct
Context: ...de. :::note The ai:endpoint is NOT a baseurl. The endpoint should contain the full e...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~209-~209: Ensure spelling is correct
Context: ...t/completions If you provide only the baseurl, you are likely to get a 404 message. :...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents 
In `@docs/docs/waveai-modes.mdx` around lines 206 - 209, Update the documentation
text to replace the incorrect/unclear token "baseurl" with the standardized
phrasing "base URL" wherever it appears in the paragraph referencing ai:endpoint
(e.g., the sentence "The ai:endpoint is *NOT* a baseurl." and the explanatory
line "If you provide only the baseurl..."); ensure the ai:endpoint example
(https://api.x.ai/v1/chat/completions) and surrounding sentences use "base URL"
for consistency and clarity.

:::

```json
{
"xai-grokfast": {
"display:name": "xAI Grok Fast",
"display:order": 2,
"display:icon": "server",
"ai:apitype": "openai-chat",
"ai:model": "x-ai/grok-4-fast",
"ai:endpoint": "https://api.x.ai/v1/chat/completions",
"ai:apitoken": "<your-api-key>"
}
}
```


### OpenRouter

[OpenRouter](https://openrouter.ai) provides access to multiple AI models. Using the `openrouter` provider simplifies configuration:
Expand Down