Connect an agent
Cherry Studio
Cherry Studio is a cross-platform desktop AI client with custom model provider support. Add Yomi API as a provider to call models from different providers in the platform catalog through its local interface.
Prerequisites
- Download the installer for your operating system from the Cherry Studio website and install it.
- Create and save a key in the Yomi API console's API Keys page. It is visible only at creation.
Configure Yomi API
- Open Cherry Studio Settings and go to the model provider settings.
- Add a provider and select OpenAI as its type.
- API address: Enter
https://api.yomiapi.com. - API key: Enter
YOUR_API_KEY(replace with your key). - Add models under this provider by entering their IDs manually, such as
claude-sonnet-5,gpt-5.6-sol,kimi-k3. Add multiple models as needed. - Enable the provider and save the settings.
/v1 to the address automatically. If your version requires the full address, enter https://api.yomiapi.com/v1.Start and verify
Start a conversation, select a model under the Yomi API provider you added and send a test message. A normal response confirms successful setup. You can also verify the call record under Usage in the Yomi API console User Center.
Common questions
Connection check fails or returns 404
This is usually an address-joining issue. First try the default https://api.yomiapi.com. If that fails, use https://api.yomiapi.com/v1. These two forms account for how different versions process the address.
401 authentication failure
The API key is incorrect or has been deleted. Check and update it in API Keys.
The model I want is missing from the list
Cherry Studio requires you to add models manually under a provider. Enter the model ID from Models in the console or the /v1/models response, then save. It will be available in conversations.