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

English

Yomi API / 帮助文档 / 其他工具通用接入

快速接入 Agent

其他工具通用接入

任何支持「OpenAI 兼容」或「自定义 API」的工具,只需 API 地址、API Key、模型 id 三项信息即可接入 Yomi API。

前置准备

  • API 密钥:在控制台「秘钥管理」创建并复制保存,密钥仅创建时可见。
  • 工具要求:设置中提供自定义接入选项,常见叫法为 OpenAI Compatible、自定义 API、Custom Provider 等。

配置 Yomi API

在工具的模型或 API 设置中填入以下三项:

配置项填写值说明
API 地址https://api.yomiapi.com 或 https://api.yomiapi.com/v1带不带 /v1 的判断见下文
API KeyYOUR_API_KEY「秘钥管理」中创建的密钥
模型 iddeepseek-v4-flash、claude-sonnet-5 等以模型广场或 /v1/models 为准

API 地址带不带 /v1

不同工具对地址的拼接约定不同,看其地址输入框的示例或占位符即可判断:

  • 示例形如 https://api.openai.com/v1(要求填完整接口前缀):填 https://api.yomiapi.com/v1。
  • 示例形如 https://api.openai.com(工具自行拼接 /v1/... 路径):填 https://api.yomiapi.com。

无论哪种,最终发出的完整请求地址都应形如 https://api.yomiapi.com/v1/chat/completions,其中 /v1 恰好出现一次。

确认可用的模型 id

模型参数填目录 id(如 deepseek-v4-flash),不要填显示名(如 GPT-5.6 mini)。完整列表见控制台「模型服务」(模型广场),也可直接调用接口获取:

curl https://api.yomiapi.com/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"
控制台「秘钥管理」页为常用工具提供了接入配置示例,可与本文的三项信息对照使用。

开始使用与验证

配置完成后,可先用最小请求自检密钥与地址是否正确:

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": "连通性测试,请回复 ok"}]
  }'

返回 JSON 中包含模型回复即链路正常。随后在工具里发起一次对话,控制台「用量统计」出现调用记录,说明工具已成功接入。

常见问题

返回 404 怎么办?

最终请求地址多了或少了 /v1。按上文「API 地址带不带 /v1」的判断方法调整后重试。

返回 401 怎么办?

密钥无效或未随请求发送:确认填写的是「秘钥管理」中创建的完整密钥,且工具以 Authorization: Bearer 请求头方式发送。

提示模型不存在怎么办?

模型名写错:使用目录 id 而不是显示名,以模型广场或 /v1/models 返回为准;同时确认密钥所属分组包含该模型。