Skip to main content
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out www.waveterm.dev. To find documentation for our new version, check out docs.waveterm.dev.
By default, Wave AI proxies your requests through our cloud servers to OpenAI using the gpt-3.5-turbo model. However, users can use their own API key and model for additional flexibility, privacy, and to bypass our current rate limit of 200 requests per day to OpenAI, which was implemented to prevent abuse.
To see a full list of supported LLM providers, please visit the Third-Party LLM Support section in the Wave AI features page.

​
Configuration

To use your own API token and preferred model in OpenAI, simply set the aiapitoken and aimodel parameters.

​
Parameters

  • AI Token: Set this parameter to your OpenAI API key.
  • AI Model: Specify the model name that you want to use. See supported models.
These parameters can be set either through the UI or from the command line, but please note that the parameter names are slightly different depending on the method you choose.

​
Configuring via the UI

To configure custom OpenAI settings from the Wave AI user interface, navigate to the “Settings” menu and set the AI Token, and AI Model parameters as described in the previous section.

​
Configuring via the CLI

To configure custom OpenAI settings using the command line, set the aiapitoken and aimodel parameters using the /client:set command, as shown in the example below. 
/client:set aiapitoken=<your-token>
/client:set aimodel=<your-model-name>

​
Usage

Once you have configured your custom OpenAI settings, you can start using it in Wave. There are two primary ways to interact with Wave AI: Interactive Mode and by using the /chat command.
  • Interactive Mode: To enter Interactive Mode, click the “Wave AI” button in the command box or use the ctrl + space shortcut. This will open an interactive chat session where you can have a continuous conversation with the AI assistant.
  • /chat: Alternatively, you can use the /chat command followed by your question to get a quick answer from the AI assistant directly in the terminal.

​
Troubleshooting

If you encounter issues while using your custom OpenAI configuration, consider the following troubleshooting steps:
  • Authentication errors: Ensure that the aiapitoken parameter is set to use the correct API token for the configured service.
  • Incorrect model selection: Make sure to set the aimodel parameter to one of the supported OpenAI models listed here.
  • Unexpected behavior or inconsistent results: If you encounter unexpected behavior or inconsistent results when using your custom OpenAI settings with Wave AI, try resetting the aibaseurl, aimodel, and aiapitoken parameters to their default values and reconfiguring from scratch.
If you continue to face issues after trying these troubleshooting steps, feel free to reach out to us on Discord.

​
Reset Wave AI

At any time if you find that you wish to return to the default Wave AI experience, you can reset the aibaseurl, aimodel, and aiapitoken parameters to their default state by using the following commands. 
/client:set aibaseurl=
/client:set aimodel=
/client:set aiapitoken=
Note: This can also be done in the UI just as described in previous steps.