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

English

Yomi API / 帮助文档 / 账户与密钥

帮助支持

账户与密钥

如何登录与管理账户?

  • 登录方式:邮箱验证码一键登录(账号不存在时自动注册),或 GitHub 授权登录;无需设置密码。
  • 账户信息:用户名默认取邮箱,昵称可在设置中修改。
  • 邀请奖励:每个账户有唯一邀请码,新用户经您邀请注册后,您可获得额度奖励,详见用户中心「邀请收益」。

为什么提示 API Key 无效?

遇到 Invalid API Key 或 Authentication failed 错误时,通常不是密钥本身的问题,而是 Base URL 配置不匹配。

常见原因

  • Base URL 未配置或配置错误:Yomi 的密钥必须配合 Yomi 的接口地址使用,SDK 场景应填 https://api.yomiapi.com/v1。
  • 客户端默认设置:许多开源软件(如 LangChain、OpenAI SDK)默认连接官方服务器,需要显式指定 base_url。

在代码中指定

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.yomiapi.com/v1",  # 必须指定
)

通过环境变量指定

无法修改代码时,可设置环境变量(适用于新版 openai SDK):

export OPENAI_API_KEY="YOUR_API_KEY"
export OPENAI_BASE_URL="https://api.yomiapi.com/v1"

快速验证

用 curl 测试密钥是否有效:

curl https://api.yomiapi.com/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

若返回模型列表,说明密钥有效,问题出在客户端配置。

如何创建密钥?

密钥在控制台「秘钥管理」中创建,可创建多个密钥来区分不同应用或环境的用量。

  1. 登录控制台,顶部导航进入「秘钥管理」。
  2. 点击创建,填写名称(例如「测试用」「生产环境」「Cursor」),并选择模型分组。
  3. 提交后复制生成的密钥(sk- 开头)。完整密钥仅创建时显示一次,请立即妥善保存(列表仅显示掩码)。

日常管理

  • 编辑:可随时修改密钥的名称与分组。
  • 删除:删除后密钥立即失效,所有依赖它的请求都会被拒绝,且不可恢复。

最佳实践

  • 一应用一密钥:为每个应用或环境创建独立密钥,便于在「用量统计」中按 Key 单独统计用量。
  • 及时清理:不再使用或疑似泄露的密钥,应立即删除并更换。

密钥如何决定可调用的模型?

由创建密钥时选择的模型分组决定,无需按模型逐个配置。不同分组的可用模型可能不同;同分组内上线的新模型,已有密钥可直接调用。分组可在编辑密钥时调整,具体可用范围以控制台实际显示为准。

如何查看调用记录?

  1. 登录控制台,进入用户中心。
  2. 点击侧栏「用量统计」,可按 API Key 与日期范围筛选。

页面提供 Token 用量与消费统计汇总;详细记录包含时间、Key 名称、模型、输入/输出 Token、Cache 读写与花费。

隐私说明:调用日志默认不保存您的请求内容与模型返回内容,记录时间、模型、用量与费用等信息。