Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ruapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

Cherry Studio is an open-source cross-platform desktop AI client. It can hold configs for several LLM providers at once, supports a local knowledge base and agents, and connects to RuAPI through the OpenAI-compatible protocol.

Prerequisites

1

RuAPI account + API key

Console → Tokens → create a sk-... key.

Install Cherry Studio

Download from cherry-ai.com or GitHub Releases:
Download Cherry-Studio-Setup-x.y.z.exe and run the installer.

Add RuAPI as a provider

1

Open Settings → Model Services

Once Cherry Studio is running, click the ⚙️ icon at the bottom-left → SettingsModel Services in the left panel.
2

Click 'Add'

Find the + Add button at the bottom of the provider list.
3

Basic info

FieldValue
Provider nameRuAPI
Provider typeOpenAI
Click OK.
4

API key and base URL

In the RuAPI provider detail panel:
FieldValue
API keysk-your-key
API hosthttps://www.ruapi.ai
Cherry Studio appends /v1/chat/completions automatically, so https://www.ruapi.ai is enough. https://www.ruapi.ai/v1 usually works too (Cherry Studio dedupes).
Toggle Enable on.
5

Add models

Below the same panel, click + Add Model and enter model IDs (not aliases):
  • gpt-5
  • gpt-5-mini
  • claude-sonnet-4-6
  • claude-opus-4-7
  • claude-haiku-4-5
  • deepseek-chat
  • gemini-2.5-pro
  • grok-3
Full list at the model gallery.
Click Fetch Model List and Cherry Studio will pull the full catalog via /v1/models and add them all.

First call

Back on the main screen, New chat in the top-left, click the model name in the top-right and pick RuAPI → gpt-5 (or any model you added). Send:
Introduce yourself in one English sentence.
A normal reply plus a matching RuAPI Console → Logs entry = success.

Default model choices

Settings → Default Models:
  • Default assistant model: everyday chat. Recommend gpt-5 or claude-sonnet-4-6.
  • Topic naming model: auto-titles conversations. Recommend a cheap small model like claude-haiku-4-5.
  • Translation model: gpt-5-mini or claude-haiku-4-5 work well.

Troubleshooting

  • The API key must be a RuAPI token (sk-...), not an OpenAI key.
  • Watch for trailing whitespace.
  • Check the key in RuAPI Console → Tokens.
  • Model ID typo. Hand-entered names must match RuAPI exactly — use Fetch Model List to autoload them.
  • Don’t append /chat/completions to the API host — https://www.ruapi.ai is enough.
Streaming (SSE) is enabled by default on both sides. If it stutters:
  • Check network stability.
  • Try disabling streaming in settings to compare.
Cherry Studio’s MCP relies on model-level function calling. gpt-5 and claude-sonnet-4-6 fully support it.
Make sure the selected model supports vision. On RuAPI, vision-capable models include gpt-5, claude-sonnet-4-6, claude-opus-4-7, gemini-2.5-pro. Check the capability badges in the model gallery.
Cherry Studio supports any number of providers. Add each one the same way. The model dropdown in the top-right of each chat switches between them.

Advanced

  • Local knowledge base: Cherry Studio’s built-in RAG works with any embedding model — use text-embedding-3-small or text-embedding-3-large from RuAPI.
  • Agents: Cherry Studio’s agent system runs client-side and calls your configured provider. claude-sonnet-4-6 or gpt-5 are solid agent backbones.
  • Multiple keys: if one key isn’t enough, create several with separate limits in the RuAPI Console and bind them to different Cherry Studio profiles.