Clients/Cherry Studio

Use the Wokey API with Cherry Studio

Get a Wokey API key, point Cherry Studio at the Wokey base URL, then confirm the connection with one curl request.

Updated

On this pageexpand_more

Get an API key and the base URLlink

Every client uses the same Wokey API key and the same base URL.

Create an API key

Sign in and create a platform key on the API page. Keys in one account share its balance.

Create an API keykey

Use the Wokey base URL

Set the client base URL to the gateway domain; the configuration below shows whether to append /v1.

Configure the clientlink

Cherry Studio adds custom providers under Model Provider. The OpenAI endpoint is enough to call every Wokey model through Chat Completions, and the same provider can also take an Anthropic endpoint.

  1. 1

    Add the provider

    Open Settings → Model Provider, click + Add Provider at the bottom of the list, and set Provider Name to Wokey. Older versions also ask for a provider type; choose OpenAI.

  2. 2

    Enter the address and key

    Under the endpoint settings, set OpenAI to https://api.wokey.ai with no /v1, paste your Wokey API key, and click Add. A preview of the final request path appears under the field.

  3. 3

    Add models

    Click Sync models to fetch the model list, or the + next to it to enter a model ID by hand, for example claude-opus-5-5.

  4. 4

    Check and use

    Click Model Check to the right of the API key and make sure the enable switch at the top right of the provider page is on. Then pick a model under Wokey at the top of the chat window.

Cherry Studio
Provider name: Wokey
OpenAI endpoint: https://api.wokey.ai
API key: YOUR_API_KEY
Model ID: claude-opus-5-5

API formats and base URLslink

When one client switches API format, whether the base URL ends in /v1 can change.

FormatBase URLUse it for
OpenAI Chat Completionshttps://api.wokey.aiDeepSeek, GLM, Kimi, and other models
Anthropic Messageshttps://api.wokey.aiClaude models

Where it is configured: Settings → Model Provider → Add Provider

Verify with curllink

If the client reports an error, rule out the key and base URL with curl first.

Cherry Studio uses the OpenAI Chat Completions format by default. A 200 from this request means the key and base URL are right. Replace YOUR_API_KEY with your key before sending it.

cURL
curl https://api.wokey.ai/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-opus-5-5",
    "messages": [
      { "role": "user", "content": "Hello" }
    ]
  }'

Errors & Troubleshootinglink

Separate auth, balance, rate limit, model availability, and upstream timeout cases first.

401

invalid api key

The key is missing, mistyped, deleted, or Authorization / x-api-key headers conflict.

402

insufficient balance

The account balance is too low. Top up before sending more requests.

403

model_denylisted / account_restricted

Calls to the model, or to every model on the account, are paused after repeated violations. See Violation Handling Fees & Restrictions.

403

request_blocked

This request was blocked before reaching the upstream and is not charged, for example an unchanged resend of a request the model just refused, or a paused end user (X-End-User-Id). The error message says what is blocked; change the request as it says or retry later. Other requests are not affected.

429

rate limited

Traffic is too frequent. Retry later or reduce concurrency. If only one model, or one end user (X-End-User-Id), keeps returning 429, it may be a temporary limit after violations.

499

client disconnected

The client closed the connection before the response finished (code downstream_aborted). This is free by default. Once an account has at least 50 client disconnects in the past 24 hours and they make up 10% or more of its requests, later disconnected requests are billed for the usage the upstream reported: the processed input, including cache reads and writes, and output only when the upstream counted it. A disconnect before the upstream reported any usage stays free. The account is notified when billing starts, and billing stops automatically within an hour once the disconnect rate is back to normal. The usual cause is a client or proxy timeout that is too short, or a program that cancels requests before they finish.

502

upstream unavailable

The upstream model service is temporarily unavailable. Switch models or retry later.

504

upstream timeout

The upstream response timed out. Shorten context, reduce max_tokens, or retry.

529

upstream overloaded

The upstream model is temporarily overloaded and Wokey already retried on other routes (code upstream_overloaded). It is unrelated to your balance. Retry shortly or switch models.

Frequently asked questionslink

Should the Cherry Studio API address end in /v1?
No. Use https://api.wokey.ai. Cherry Studio appends /v1/chat/completions itself and shows a preview of the final request path under the field, so you can check it before saving.
Which endpoint should I fill in, OpenAI or Anthropic?
The OpenAI endpoint is enough to call models through Chat Completions. To send Claude models in the native Anthropic Messages format, also set the Anthropic endpoint of the same provider to https://api.wokey.ai. Older versions have a provider type instead of endpoint settings; choose OpenAI.
Why is the model list empty?
A new provider starts with no models. Click Sync models to fetch the list from Wokey, or the + next to it to enter a model ID by hand, for example claude-opus-5-5.
What if Model Check returns 401?
Paste only the key into the API key field, with no Bearer prefix, spaces, or line breaks. Then confirm the key has not been deleted or paused and the account has balance.