Help and support
Accounts and API keys
How do I sign in and manage my account?
- Sign-in methods: Sign in with an email verification code (an account is created automatically if needed) or GitHub authorization. No password is required.
- Account information: Your username defaults to your email address; change your display name in Settings.
- Referral rewards: Every account has a unique referral code. Earn credit when new users sign up through your invitation. See Referrals in the User Center for details.
Why does it say my API key is invalid?
An Invalid API Key or Authentication failed error often indicates a mismatched Base URL rather than a problem with the key itself.
Common causes
- Missing or incorrect Base URL: Yomi keys must be used with the Yomi API address. For SDKs, enter
https://api.yomiapi.com/v1. - Client defaults: Many open-source tools, including LangChain and the OpenAI SDK, connect to official servers by default. Explicitly specify
base_url.
Specify it in code
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://api.yomiapi.com/v1", # Must be specified
)
Specify it with environment variables
If you cannot modify the code, set environment variables (supported by recent openai SDK versions):
export OPENAI_API_KEY="YOUR_API_KEY"
export OPENAI_BASE_URL="https://api.yomiapi.com/v1"
Quick verification
Test the key with curl:
curl https://api.yomiapi.com/v1/models \
-H "Authorization: Bearer YOUR_API_KEY"
A model list response confirms that the key is valid and the issue is in the client configuration.
How do I create a key?
Create keys in API Keys in the console. Use multiple keys to separate usage by application or environment.
- Sign in to the console and open "API Keys" in the top navigation.
- Click Create, enter a name such as Testing, Production or Cursor, and select a model group.
- After submitting, copy the generated key (starting with
sk-). The complete key is shown only once at creation; save it immediately. The list displays only a masked value.
Day-to-day management
- Edit: Change the key's name and group at any time.
- Delete: Deletion invalidates a key immediately. All requests using it are rejected, and it cannot be recovered.
Best practices
- One key per application: Create a separate key for each application or environment to track its consumption independently under Usage.
- Remove unused keys promptly: Immediately delete and replace keys that are no longer used or may have leaked.
How does a key determine which models I can call?
The model group selected when creating the key determines its available models; individual model configuration is unnecessary. Different groups may offer different models. Existing keys can immediately call newly added models in the same group. Change the group by editing the key; the console shows its actual available scope.
How do I view call records?
- Sign in to the console and open the User Center.
- Click Usage in the sidebar and filter by API key and date range.
The page summarizes token usage and spending. Detailed records include time, key name, model, input/output tokens, cache reads/writes and cost.
