Get API Key Get API
Docs

Using OpenVeer in Cherry Studio

Detailed guide on how to configure and use OpenVeer API service in Cherry Studio desktop client. This guide will help you configure OpenVeer 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

  2. OpenVeer API Key obtained\
    Log in to OpenVeer Console to get your API key (starts with sk-)

Note

If you don't have an OpenVeer account yet, please register at OpenVeer 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 + ,

Step 2: Add OpenVeer 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

2.2 Add OpenVeer Provider

  1. At the bottom of the model service page, click the "+ Add" button

  2. In the "Add Provider" dialog, fill in:
    * Provider Name: OpenVeer (customizable)
    * Provider Type: Select OpenAI

  3. Click the "Confirm" button

2.3 Configure OpenVeer API Information

After adding the provider, fill in the API information in the right configuration area:

Field Value
API Key Your OpenVeer API key (sk-xxxxxxxxxxxx)
API URL https://api.openveer.com
Note

Important:

  • API URL must be https://api.openveer.com (do not include /v1 or other paths)
  • API Key must be obtained from OpenVeer console and start with sk-
  • After filling in, you can click the "Test" button to test the connection

Step 3: Add and Manage Models

3.1 Open Model Management

After configuring the OpenVeer provider:

  1. Ensure the OpenVeer 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

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-4o / chatgpt-4o - OpenAI GPT-4o model
    * gpt-4o-mini - Faster and more economical version
    * claude-3 series - Claude 3 models (with multiple variants)
    * claude_code_sonnet-4 - Claude Code Sonnet 4
    * claude_code_haiku-4 - Claude Code Haiku 4
    * gemini-2.0-flash-exp - Google Gemini 2.0 Flash

  4. After adding all desired models, close the model selection window

Tip

Recommended Models:

  • 💰 Cost-effective: gpt-4o-mini, claude_code_haiku-4
  • 🚀 High-performance: gpt-4o / chatgpt-4o, claude_code_sonnet-4
  • 🎨 Multimodal: claude-3 series, gemini-2.0-flash-exp

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 OpenVeer provider
  4. Start chatting with AI!

FAQ

Q1: Cannot connect to OpenVeer service?

Solution:

  1. Check Base URL:
    * Ensure Base URL is https://api.openveer.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 OpenVeer Console

  3. Check Network Connection:
    * Ensure you can access https://api.openveer.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-4o)

  2. Check API Permissions:
    * Confirm your API Key has permission to access the model list
    * Contact OpenVeer 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 OpenVeer Console to view:

  • 📊 API call statistics
  • 💰 Cost details
  • 📈 Usage trend charts

Features

Using Cherry Studio + OpenVeer, 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:

Start Using OpenVeer

Register for OpenVeer now, get your API key, and start your AI journey!

This documentation is built and hosted on Mintlify, a developer documentation platform.