Getting started

Quick start

Welcome to Yomi API! This guide walks you through signing up, adding credit, creating a key and making your first model call in minutes.

Prepare your account

Sign up and sign in

Yomi API uses passwordless sign-in, combining registration and login in one step:

Email verification code: Enter your email and the code you receive to sign in. An account is created automatically if one does not exist.
GitHub authorization: Click "Sign in with GitHub". After authorization, your account is created and signed in automatically.

Your username defaults to your email address after registration. You can change your display name in Settings at any time.

Add account credit

Sign in to the console, open the User Center and click "Add Credit" in the sidebar.
Select an amount. Your balance is denominated in US dollars (USD) and paid in Chinese yuan; the exchange rate shown on the payment page applies.
Complete payment and the balance is credited immediately. Alipay, WeChat Pay and other online methods are supported according to the options shown on the payment page.

Credit purchases include bonus offers, with larger bonuses for larger purchases. See the payment page for the current tiers.

Create an API key

Open "API Keys" in the top navigation.
Click Create, enter a name and choose a model group. Available models differ by group, so select one that meets your needs.
Copy the generated key (starting with sk-) and store it safely.

The complete key is shown only once at creation. Save it immediately; the list displays only a masked value. Never commit it to a public repository or expose it in frontend pages.

Connection details

API address: https://api.yomiapi.com, with the OpenAI-compatible path prefix /v1.
Authentication: Request header Authorization: Bearer YOUR_API_KEY.
Request format: Compatible with the OpenAI API. In an existing OpenAI SDK or tool, replace only the address and key.

Make your first call

Test with cURL

curl https://api.yomiapi.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "deepseek-v4-flash",
    "messages": [{"role": "user", "content": "Hello, please introduce yourself in one sentence."}]
  }'

Python example

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.yomiapi.com/v1",
)

response = client.chat.completions.create(
    model="deepseek-v4-flash",
    messages=[{"role": "user", "content": "Hello, please introduce yourself in one sentence."}],
)
print(response.choices[0].message.content)

Next steps

Read the API reference: Explore the full endpoint descriptions and parameters.
Browse the Model Catalog: Open "Models" in the top navigation for all models, prices and route information.
Connect your tools: The API Keys page includes configuration examples for Claude Code, Codex CLI and other tools.
Monitor usage: Open "Usage" in the User Center to review token consumption and spending details.