> ## Documentation Index
> Fetch the complete documentation index at: https://docs.elkapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Using ElkAPI in Cherry Studio
> Detailed guide on how to configure and use ElkAPI API service in Cherry Studio desktop client. This guide will help you configure ElkAPI API in Cherry Studio to access rich AI model resources.
## Prerequisites
Before you begin, please ensure:
1. **Cherry Studio is installed**\
Download and install the version suitable for your operating system from [Cherry Studio Official Website](https://cherry-ai.com/)
2. **ElkAPI API Key obtained**\
Log in to [ElkAPI Console](https://api.elkapi.com/keys) to get your API key (starts with `sk-`)
**Tip:** If you don't have an ElkAPI account yet, please register at [ElkAPI](https://api.elkapi.com) and obtain an API key first.
## Step 1: Open Cherry Studio Settings
After launching Cherry Studio, navigate to the settings page:
1. Click the **⚙️ Settings** icon (gear icon) in the top right corner
2. Or use keyboard shortcuts:
* Windows/Linux: `Ctrl + ,`
* macOS: `Cmd + ,`
*Cherry Studio main interface, click the gear icon in the top right to access settings*
## Step 2: Add ElkAPI Model Platform
### 2.1 Access Model Service Management
In the settings page:
1. Find the **Model Service** option in the left menu
2. Click to enter model service management page
*Find "Model Service" option in the left menu of settings page*
### 2.2 Add ElkAPI Provider
1. At the bottom of the model service page, click the **"+ Add"** button
*Click "+ Add" to open the add provider dialog*
2. In the **"Add Provider"** dialog, fill in:
* **Provider Name**: `ElkAPI` (customizable)
* **Provider Type**: Select `OpenAI`
3. Click the **"Confirm"** button
### 2.3 Configure ElkAPI API Information
After adding the provider, fill in the API information in the right configuration area:
| Field | Value |
| ----------- | --------------------------------------- |
| **API Key** | Your ElkAPI API key (`sk-xxxxxxxxxxxx`) |
| **API URL** | `https://api.elkapi.com` |
**Important:**
* API URL must be `https://api.elkapi.com` (do not include `/v1` or other paths)
* API Key must be obtained from ElkAPI console and start with `sk-`
* After filling in, you can click the **"Test"** button to test the connection
*Fill in API key and API URL, ensure ElkAPI provider status is ON (green switch)*
## Step 3: Add and Manage Models
### 3.1 Open Model Management
After configuring the ElkAPI provider:
1. Ensure the ElkAPI provider switch in the top right is **ON** (green)
2. In the right configuration area, find the **"Models"** section
3. Click the **"Manage"** button to open the model selection window
*Click "Manage" button to open ElkAPI model selection window*
### 3.2 Add Desired Models
In the model selection window:
1. Use the search box to find specific models
2. Use the category tabs at the top to filter: **All**, **Reasoning**, **Vision**, **Web**, **Free**, **Embedding**, **Rerank**, **Tool**
3. Find the models you want and click the **+** button on the right to add:
* `gpt-5.5` / `gpt-5.5-pro` - OpenAI GPT-5.5 model
* `gpt-5.4-mini` - Faster and more economical version
* `claude-sonnet-4-6` series - Claude Sonnet 4.6 models (with multiple variants)
* `claude-sonnet-4-6-thinking` - Claude Sonnet 4.6 Thinking
* `claude-sonnet-4-6` - Claude Sonnet 4.6
* `gemini-3.1-flash-lite-preview` - Google Gemini 3.1 Flash Lite
*Added models will appear on the right, can be expanded to view specific variants*
4. After adding all desired models, close the model selection window
**Recommended Models:**
* 💰 **Cost-effective:** `gpt-5.4-mini`, `claude-sonnet-4-6`
* 🚀 **High-performance:** `gpt-5.5` / `gpt-5.5-pro`, `claude-sonnet-4-6-thinking`
* 🎨 **Multimodal:** `claude-sonnet-4-6` series, `gemini-3.1-flash-lite-preview`
## Step 4: Start Chatting
After configuration, you can start using it:
1. Return to the main interface, click the **"+"** at the top or select an existing chat
2. At the top of the chat page, click the model selector
3. Select a model under the **ElkAPI** provider
4. Start chatting with AI!
*Create a new chat and select ElkAPI provider and model*
*Cherry Studio chat interface example*
## FAQ
### Q1: Cannot connect to ElkAPI service?
**Solution:**
1. **Check Base URL**:
* Ensure Base URL is `https://api.elkapi.com`
* Do not add `/v1` suffix
2. **Verify API Key**:
* Confirm API Key is correct and starts with `sk-`
* Check if the key is valid in [ElkAPI Console](https://api.elkapi.com/keys)
3. **Check Network Connection**:
* Ensure you can access `https://api.elkapi.com`
* You may need to configure a proxy if in China
### Q2: Model list is empty or cannot refresh?
**Solution:**
1. **Manually Add Models**:
* If auto-refresh fails, you can manually add common models
* In model management, manually enter model names (e.g., `gpt-5.5`)
2. **Check API Permissions**:
* Confirm your API Key has permission to access the model list
* Contact ElkAPI support to check account status
### Q3: Error messages during conversation?
**Common errors and solutions:**
| Error Message | Cause | Solution |
| --------------------------- | ---------------------------- | ------------------------------------------ |
| `401 Unauthorized` | Invalid or expired API Key | Re-obtain API Key and update configuration |
| `429 Too Many Requests` | Request rate limit exceeded | Wait a moment and retry |
| `500 Internal Server Error` | Temporary server issue | Wait a few minutes and retry |
| `insufficient_quota` | Insufficient account balance | Top up in the console |
### Q4: How to view API usage and costs?
Log in to [ElkAPI Console](https://api.elkapi.com) to view:
* 📊 API call statistics
* 💰 Cost details
* 📈 Usage trend charts
## Features
Using Cherry Studio + ElkAPI, you can:
* 💬 **Multi-model Conversations** - Use different AI models in the same interface
* 🖼️ **Image Understanding** - Multi-modal conversations with image input support
* 📝 **Context Management** - Intelligent management of conversation history and context
* 🎨 **Custom Prompts** - Create and manage prompt templates
* 📊 **Export Conversations** - Export conversation records to Markdown and other formats
* 🔄 **Model Comparison** - Use multiple models simultaneously and compare outputs
## Support & Help
If you encounter any issues:
* 📚 [ElkAPI Documentation](https://docs.elkapi.com)
* 📧 Technical Support: [support@elkapi.com](mailto:support@elkapi.com)
***
Register for ElkAPI now, get your API key, and start your AI journey!