Yomi APIYomi API帮助文档 返回控制台

English

Yomi API / 帮助文档 / 快速开始

入门指南

快速开始

欢迎使用 Yomi API!本指南将带您完成注册、充值、创建密钥,并在几分钟内发起第一次模型调用。

账户准备

注册与登录

Yomi API 采用免密登录,注册与登录一步完成:

  • 邮箱验证码:输入邮箱并填写收到的验证码即可登录,账号不存在时自动注册。
  • GitHub 授权:点击「使用 GitHub 登录」,授权后自动创建并登录账号。

注册后用户名默认取邮箱,昵称可随时在设置中修改。

账户充值

  1. 登录控制台,进入用户中心,点击侧栏「在线充值」。
  2. 选择充值金额。余额以美元(USD)计价,按人民币支付,汇率以充值页实时显示为准。
  3. 完成支付,余额即时到账。支持支付宝、微信等在线支付,以充值页实际显示为准。

充值设有赠送优惠,多充多送,具体档位以充值页展示为准。

创建 API 密钥

  1. 在顶部导航进入「秘钥管理」。
  2. 点击创建,填写名称并选择模型分组。不同分组支持的模型有差异,请按需选择。
  3. 复制生成的密钥(sk- 开头)并妥善保存。
完整密钥仅创建时显示一次,请立即妥善保存(列表仅显示掩码);请不要将密钥提交到公开代码仓库或暴露在前端页面中。

接入信息

  • API 地址:https://api.yomiapi.com,OpenAI 兼容路径前缀 /v1。
  • 认证方式:请求头 Authorization: Bearer YOUR_API_KEY。
  • 请求格式:兼容 OpenAI API,现有 OpenAI SDK 或工具只需替换地址与密钥。

发起第一次调用

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": "你好,请用一句话介绍你自己。"}]
  }'

Python 示例

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": "你好,请用一句话介绍你自己。"}],
)
print(response.choices[0].message.content)

下一步

  • 查看 API 参考:了解完整的接口说明与参数。
  • 浏览模型广场:顶部导航「模型服务」,查看全部模型、价格与线路信息。
  • 接入常用工具:「秘钥管理」页提供 Claude Code、Codex CLI 等工具的接入配置示例。
  • 监控用量:用户中心「用量统计」查看 Token 消耗与消费明细。