瑶瑶 API 开发者文档
瑶瑶 API 是 OpenAI 兼容的大模型接口网关。你可以用一个 API Key 接入 GPT、Claude、Gemini、DeepSeek、Qwen 等主流模型,适合开发者、自动化工作流、AI 客户端和企业内部工具快速接入。
1. 快速开始
进入控制台,注册账号并领取新用户测试额度。若余额不足,可前往充值中心购买额度。
打开 控制台 → 令牌管理,创建新的令牌,复制生成的 sk-... 密钥。
把你原本 OpenAI SDK 的 Base URL 改成 https://api.yaoyao.chat/v1。
在 model 字段填写平台模型名,例如 gpt-5.5,具体以模型与价格页显示为准。
如果你已经会用 OpenAI API,通常只需要替换 base_url 和 api_key 即可开始调用。
2. 创建 API Key / 令牌
- 打开 API 控制台。
- 进入
令牌管理页面。 - 点击
创建新的令牌。 - 选择可用分组,例如
gptpro、claude等,具体以后台显示为准。 - 提交后复制
sk-...格式的密钥。
API Key 相当于你的账户密码,请不要发给陌生人,也不要直接写在前端网页、App 或公开仓库里。
3. 接口地址
| 用途 | 地址 |
|---|---|
| OpenAI 兼容 Base URL | https://api.yaoyao.chat/v1 |
| Chat Completions | https://api.yaoyao.chat/v1/chat/completions |
| Responses | https://api.yaoyao.chat/v1/responses |
| Embeddings | https://api.yaoyao.chat/v1/embeddings |
4. 模型与价格
可用模型、上下文长度、分组、价格和状态会随供应商变化,请以 模型与价格页 为准。
常见填写方式:
{
"model": "gpt-5.5",
"messages": [
{"role": "user", "content": "你好"}
]
}
如果调用返回“模型不存在”或“无权限”,请检查:模型名是否拼写正确、令牌分组是否支持该模型、账户余额是否充足。
5. curl 调用示例
curl https://api.yaoyao.chat/v1/chat/completions \
-H "Authorization: Bearer sk-你的令牌" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-5.5",
"messages": [
{"role": "user", "content": "你好,请简单介绍一下你自己"}
]
}'
返回示例
{
"id": "chatcmpl-xxx",
"object": "chat.completion",
"created": 1710000000,
"model": "gpt-5.5",
"choices": [
{
"index": 0,
"message": {"role": "assistant", "content": "你好,我是一个 AI 助手。"},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 18,
"completion_tokens": 12,
"total_tokens": 30
}
}
6. Python OpenAI SDK 示例
from openai import OpenAI
client = OpenAI(
api_key="sk-你的令牌",
base_url="https://api.yaoyao.chat/v1"
)
response = client.chat.completions.create(
model="gpt-5.5",
messages=[
{"role": "user", "content": "你好,请用一句话介绍瑶瑶 API"}
]
)
print(response.choices[0].message.content)
7. Node.js OpenAI SDK 示例
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "sk-你的令牌",
baseURL: "https://api.yaoyao.chat/v1",
});
const response = await client.chat.completions.create({
model: "gpt-5.5",
messages: [
{ role: "user", content: "你好,请用一句话介绍瑶瑶 API" },
],
});
console.log(response.choices[0].message.content);
8. 流式输出 stream 示例
聊天产品通常需要边生成边显示,可以设置 stream: true。
Python 流式输出
from openai import OpenAI
client = OpenAI(
api_key="sk-你的令牌",
base_url="https://api.yaoyao.chat/v1"
)
stream = client.chat.completions.create(
model="gpt-5.5",
messages=[{"role": "user", "content": "写一段简短欢迎语"}],
stream=True
)
for chunk in stream:
delta = chunk.choices[0].delta.content
if delta:
print(delta, end="")
9. 常见错误码与排查
| 状态码 | 常见原因 | 处理方式 |
|---|---|---|
| 401 | API Key 错误、未携带 Authorization | 检查请求头是否为 Authorization: Bearer sk-... |
| 402 / 403 | 余额不足、分组无权限、令牌被禁用 | 检查余额、令牌状态和分组权限 |
| 404 | 模型名不存在或接口路径错误 | 确认模型名和 Base URL 是否正确 |
| 429 | 请求过快或并发过高 | 降低并发、增加重试间隔,必要时联系客服 |
| 500 / 502 / 503 | 上游服务异常或网络波动 | 稍后重试,或切换其他模型 |
10. 常用客户端配置教程
进入 设置 → 模型服务 → OpenAI Compatible,Base URL 填 https://api.yaoyao.chat/v1,API Key 填你的 sk-...,模型名按模型与价格页填写。
选择 OpenAI 或自定义 OpenAI 服务商,接口地址填 https://api.yaoyao.chat/v1,密钥填 API Key,保存后新建对话测试。
进入 设置 → 模型供应商 → OpenAI API Compatible,填写 Base URL、API Key 和模型名称。建议先用简单问答测试连通性。
在管理后台配置 OpenAI API 连接,API Base URL 填 https://api.yaoyao.chat/v1,API Key 填令牌。
如果工具支持 OpenAI Compatible 或自定义 Base URL,就填 https://api.yaoyao.chat/v1 和你的 API Key。
若工具支持 OpenAI 兼容接口,可通过环境变量设置:OPENAI_API_KEY 与 OPENAI_BASE_URL。
环境变量示例
export OPENAI_API_KEY="sk-你的令牌"
export OPENAI_BASE_URL="https://api.yaoyao.chat/v1"
11. API Key 安全建议
- 不要把 API Key 写进前端代码、公开仓库、截图或聊天记录。
- 生产环境建议由服务端代理请求,不要让浏览器直接调用。
- 如果怀疑密钥泄露,请立即在控制台删除旧令牌并创建新令牌。
- 建议为不同项目创建不同令牌,方便统计用量和排查问题。
- 注意查看调用日志和余额消耗,避免异常调用。