Skip to content

Commit a001de8

Browse files
committed
update for best practices, add tokensecretname and capabilities
1 parent 220bfcc commit a001de8

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

docs/docs/waveai-modes.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,12 +199,12 @@ For newer models like GPT-4.1 or GPT-5, the API type is automatically determined
199199

200200
### OpenAI Compatible
201201

202-
To use an OpenAPI compatible API provider, you need to provide the ai:endpoint, ai:apitoken, ai:model parameters,
203-
and use "openai-chat" as the ai:mode.
202+
To use an OpenAPI compatible API provider, you need to provide the ai:endpoint, ai:apitokensecretname, ai:model parameters,
203+
and use "openai-chat" as the ai:apitype.
204204

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

209209
If you provide only the baseurl, you are likely to get a 404 message.
210210
:::
@@ -218,11 +218,14 @@ If you provide only the baseurl, you are likely to get a 404 message.
218218
"ai:apitype": "openai-chat",
219219
"ai:model": "x-ai/grok-4-fast",
220220
"ai:endpoint": "https://api.x.ai/v1/chat/completions",
221-
"ai:apitoken": "<your-api-key>"
221+
"ai:apitokensecretname": "XAI_KEY",
222+
"ai:capabilities": ["tools", "images", "pdfs"]
222223
}
223224
}
224225
```
225226

227+
The `ai:apitokensecretname` should be the name of an environment variable that contains your API key. Set this environment variable before running Wave Terminal.
228+
226229

227230
### OpenRouter
228231

0 commit comments

Comments
 (0)