Yixia API 使用指南

官方网站： https://api.yixia.ai

• 1、创建账户
• 2、创建令牌
• 3、使用令牌
  • 3.1 使用Chery Studio
  • 3.2 使用chatbox
  • 3.3 使用curl
  • 3.4 使用python
  • 3.5 使用JavaScript/TypeScript
• 4、额度充值
• 5、使用案例
• 6、常见问题

1、创建账户

1. 访问官方网站
2. 点击右上角"注册"按钮创建新账户
3. 填写必要的注册信息，完成注册

2、创建令牌

1. 登录成功后，点击左侧菜单栏的"令牌管理"，进入令牌管理页面
2. 点击“添加令牌”按钮
3. 输入令牌名称，选择默认分组，勾选无限额度，点击“提交”按钮
4. 生成并复制您的API密钥

此时，你会有如下令牌以及地址：

API Key: sk-xxxxxx
Base URL: https://api.yixia.ai

3、使用令牌

3.1 使用Chery Studio

• 使用Chery Studio：

官网： https://www.cherry-ai.com/
Github： https://github.com/CherryHQ/cherry-studio
Gitee: https://gitcode.com/CherryHQ/cherry-studio
Docs: https://docs.cherry-ai.com/

Cherry Studio 是一款集多模型对话、知识库管理、AI 绘画、翻译等功能于一体的全能 AI 助手平台。 Cherry Studio 高度自定义的设计、强大的扩展能力和友好的用户体验，使其成为专业用户和 AI 爱好者的理想选择。无论是零基础用户还是开发者，都能在 Cherry Studio 中找到适合自己的 AI 功能，提升工作效率和创造力。

1. 下载地址，下载对应系统的安装包，一路下一步，完成安装。
2. 使用方法：在 chery studio 中，点击左下角的“⚙️”按钮，点击“模型服务”选项卡，选择“OpenAI”服务商，粘贴 API密钥，填入API地址，点击“检测”按钮，在最下放点击"管理"按钮，在框中勾选需要的模型即可。

3.2 使用chatbox

官网： https://chatboxai.app/zh
Github： https://github.com/chatboxai/chatbox
Docs: https://docs.chatboxai.app/

Chatbox AI 是一款 AI 客户端应用和智能助手，支持众多先进的 AI 模型和 API，可在 Windows、MacOS、Android、iOS、Linux 和网页版上使用。

1. 下载地址，下载对应系统的安装包，一路下一步，完成安装。
2. 使用方法：在 chatbox 中，点击左下角的“设置”按钮，点击“模型提供方”选项卡，点击“OpenAI”按钮，粘贴 API 密钥，填入API主机，点击“获取”按钮，勾选需要的模型即可。
3. 使用示例：
4. 详细使用方法，请参考 Chatbox AI 使用指南

3.3 使用curl

将sk-xxxxxxxxxxxxxxxxxxxxxxx 替换为实际的API密钥。

curl https://api.yixia.ai/v1/chat/completions \
-H "Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
    "model": "gpt-5-mini",
    "messages": [
        {
            "role": "system",
            "content": "You are a helpful assistant."
        },
        {
            "role": "user",
            "content": "你是谁？"
        }
    ],
    "stream": false
}'

3.4 使用python

1. 安装Python【略】

2. 安装 openai sdk：

pip install openai

3. 编写Python代码：main.py

from openai import OpenAI

client = OpenAI(
    # 从环境变量获取
    # api_key=os.environ.get("OPENAI_API_KEY"),
    # base_url=os.environ.get("OPENAI_BASE_URL"), # 官方默认：https://api.openai.com/v1"

    # 直接填写, 将sk-xxxxxxxxxxxxxxxxxxxxxxx 替换为实际的API密钥。
    api_key="sk-xxxxxxxxxxxxxxxxxxxxxxxxxx",
    base_url="https://api.yixia.ai/v1",
    timeout=60,
    max_retries=3,
)

message = [
        {
            "role": "user",
            "content": "你好"
        },
    ]

completion = client.chat.completions.create(
    model="gpt-5-mini",
    messages=message,
)

print(completion)

print('-'.center(50, '-'))

print(completion.choices[0].message.content)

4. 运行Python代码：

python main.py

3.5 使用JavaScript/TypeScript

1. 安装Node.js【略】

2. 安装 openai sdk：

npm install openai

3. 创建一个名为main.js的文件，并添加以下代码：

import OpenAI from "openai";

const client = new OpenAI({
    baseURL: "https://api.yixia.ai/v1",
    apiKey: "sk-xxxxxxxxxxxxxxxxxxxxxxxxxx",
    timeout: 60000,
    maxRetries: 3
})

const resp = await client.responses.create({
    model: "gpt-5-mini",
    input: '你好'
})

console.log(resp)

4. 运行JavaScript代码：

node main.js

4、额度充值

当额度不足时，则无法使用API，此时就需要充值

1. 点击左侧菜单栏的"钱包"，进入钱包页面。
2. 选择充值额度，然后点击微信，进行充值。
3. 在弹出的确认页面，点击确认，跳转到充值页面。
4. 使用微信扫一扫，完成充值。
5. 充值成功后，返回钱包页面，可以看到已充值额度。

5、使用案例

• Claude Code 集成 Yixia API 免魔法国内使用 详见

6、常见问题

• 6.1 如何在我的额度不足时通知我?

  登录账号，依次点击个人设置，其他设置，通知设置，邮件通知，输入额度预警阀值，并保存，如下图：

  

• 6.2 分组 default 下模型 XXX 无可用渠道?

  模型名称填写错误，请查看系统可用模型： https://api.yixia.ai/pricing 然后修改为正确的模型名称。